MessageEntityData

Inherits from EntityData

Summary

Constructors

MessageEntityData()
MessageEntityData(guid: Guid)
MessageEntityData(other: EntityData)
MessageEntityData(other: GameObjectData)
MessageEntityData(other: GameDataContainer)
MessageEntityData(other: DataContainer)

Properties

Name Type
messageSid string
additionalMessages MessageLineData[]
messageType UIMessageEntityType
displayTime float
entryInputAction EntryInputActionEnum
enabled bool

Static members

Name Type
MessageEntityData.typeInfo TypeInformation

Constructors

MessageEntityData

MessageEntityData()

Creates a new MessageEntityData frostbite instance.

MessageEntityData

MessageEntityData(guid: Guid)

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

Parameters

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

MessageEntityData

MessageEntityData(other: EntityData)

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

Parameters

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

MessageEntityData

MessageEntityData(other: GameObjectData)

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

Parameters

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

MessageEntityData

MessageEntityData(other: GameDataContainer)

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

Parameters

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

MessageEntityData

MessageEntityData(other: DataContainer)

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

Parameters

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

Properties

messageSid

string

additionalMessages

MessageLineData[]

messageType

UIMessageEntityType

displayTime

float

entryInputAction

EntryInputActionEnum

enabled

bool

Static members

typeInfo

TypeInformation

The type information for the MessageEntityData type.

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