HealthComponentData

Inherits from ComponentData

Summary

Constructors

HealthComponentData()
HealthComponentData(guid: Guid)
HealthComponentData(other: ComponentData)
HealthComponentData(other: GameObjectData)
HealthComponentData(other: GameDataContainer)
HealthComponentData(other: DataContainer)

Properties

Name Type
health float
materialPair MaterialContainerPair | nil

Static members

Name Type
HealthComponentData.typeInfo TypeInformation

Constructors

HealthComponentData

HealthComponentData()

Creates a new HealthComponentData frostbite instance.

HealthComponentData

HealthComponentData(guid: Guid)

Creates a new HealthComponentData frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

HealthComponentData

HealthComponentData(other: ComponentData)

Casts an instance of type ComponentData to HealthComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other ComponentData The instance to cast to HealthComponentData.

HealthComponentData

HealthComponentData(other: GameObjectData)

Casts an instance of type GameObjectData to HealthComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other GameObjectData The instance to cast to HealthComponentData.

HealthComponentData

HealthComponentData(other: GameDataContainer)

Casts an instance of type GameDataContainer to HealthComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other GameDataContainer The instance to cast to HealthComponentData.

HealthComponentData

HealthComponentData(other: DataContainer)

Casts an instance of type DataContainer to HealthComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to HealthComponentData.

Properties

health

float

materialPair

MaterialContainerPair | nil

Static members

typeInfo

TypeInformation

The type information for the HealthComponentData type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)