UILevelDescriptionComponent

Inherits from LevelDescriptionComponent

Summary

Constructors

UILevelDescriptionComponent()
UILevelDescriptionComponent(guid: Guid)
UILevelDescriptionComponent(other: LevelDescriptionComponent)
UILevelDescriptionComponent(other: DataContainer)

Properties

Name Type
mpLoadingAssetPath string
loadingMusic SoundAsset | nil
loadingMusicPath string
levelImagePath string
loadingImagePath string
spLoadingAssetPath string
gpsPosition UIGPSPosition
hintAsset GameTipAsset | nil
creditsAssets UICreditsAsset[]
minimapData UIMinimapData
levelCompledStatData UILevelStatData
levelScoreStatData UILevelStatData
sortIndex int
isMenuLevel bool

Static members

Name Type
UILevelDescriptionComponent.typeInfo TypeInformation

Constructors

UILevelDescriptionComponent

UILevelDescriptionComponent()

Creates a new UILevelDescriptionComponent frostbite instance.

UILevelDescriptionComponent

UILevelDescriptionComponent(guid: Guid)

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

Parameters

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

UILevelDescriptionComponent

UILevelDescriptionComponent(other: LevelDescriptionComponent)

Casts an instance of type LevelDescriptionComponent to UILevelDescriptionComponent. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other LevelDescriptionComponent The instance to cast to UILevelDescriptionComponent.

UILevelDescriptionComponent

UILevelDescriptionComponent(other: DataContainer)

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

Parameters

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

Properties

mpLoadingAssetPath

string

loadingMusic

SoundAsset | nil

loadingMusicPath

string

levelImagePath

string

loadingImagePath

string

spLoadingAssetPath

string

gpsPosition

UIGPSPosition

hintAsset

GameTipAsset | nil

creditsAssets

UICreditsAsset[]

minimapData

UIMinimapData

levelCompledStatData

UILevelStatData

levelScoreStatData

UILevelStatData

sortIndex

int

isMenuLevel

bool

Static members

typeInfo

TypeInformation

The type information for the UILevelDescriptionComponent type.

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