AreaTriggerEntityData

Inherits from TriggerEntityData

Summary

Constructors

AreaTriggerEntityData()
AreaTriggerEntityData(guid: Guid)
AreaTriggerEntityData(other: TriggerEntityData)
AreaTriggerEntityData(other: GameEntityData)
AreaTriggerEntityData(other: SpatialEntityData)
AreaTriggerEntityData(other: EntityData)
AreaTriggerEntityData(other: GameObjectData)
AreaTriggerEntityData(other: GameDataContainer)
AreaTriggerEntityData(other: DataContainer)

Properties

Name Type
geometryTransform LinearTransform
include AreaTriggerInclude
insideAreaEventRepeatTime float
radius float
useCharacterEntity bool
oneInsideAreaEventPerSoldier bool
triggerOnlyOnLeave bool
resetOnEnable bool
triggerOnLeaveOnDeath bool
triggerOnLeaveOnDisable bool

Static members

Name Type
AreaTriggerEntityData.typeInfo TypeInformation

Constructors

AreaTriggerEntityData

AreaTriggerEntityData()

Creates a new AreaTriggerEntityData frostbite instance.

AreaTriggerEntityData

AreaTriggerEntityData(guid: Guid)

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

Parameters

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

AreaTriggerEntityData

AreaTriggerEntityData(other: TriggerEntityData)

Casts an instance of type TriggerEntityData to AreaTriggerEntityData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other TriggerEntityData The instance to cast to AreaTriggerEntityData.

AreaTriggerEntityData

AreaTriggerEntityData(other: GameEntityData)

Casts an instance of type GameEntityData to AreaTriggerEntityData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other GameEntityData The instance to cast to AreaTriggerEntityData.

AreaTriggerEntityData

AreaTriggerEntityData(other: SpatialEntityData)

Casts an instance of type SpatialEntityData to AreaTriggerEntityData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other SpatialEntityData The instance to cast to AreaTriggerEntityData.

AreaTriggerEntityData

AreaTriggerEntityData(other: EntityData)

Casts an instance of type EntityData to AreaTriggerEntityData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other EntityData The instance to cast to AreaTriggerEntityData.

AreaTriggerEntityData

AreaTriggerEntityData(other: GameObjectData)

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

Parameters

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

AreaTriggerEntityData

AreaTriggerEntityData(other: GameDataContainer)

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

Parameters

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

AreaTriggerEntityData

AreaTriggerEntityData(other: DataContainer)

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

Parameters

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

Properties

geometryTransform

LinearTransform

include

AreaTriggerInclude

insideAreaEventRepeatTime

float

radius

float

useCharacterEntity

bool

oneInsideAreaEventPerSoldier

bool

triggerOnlyOnLeave

bool

resetOnEnable

bool

triggerOnLeaveOnDeath

bool

triggerOnLeaveOnDisable

bool

Static members

typeInfo

TypeInformation

The type information for the AreaTriggerEntityData type.

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