UIListItem

Summary

Constructors

UIListItem()
UIListItem(guid: Guid)

Properties

Name Type
label string
isEnabled UIDataSourceInfo
isVisible UIDataSourceInfo
toggleItems UIDataSourceInfo
dataUpdate UIDataSourceInfo
defaultIsVisible bool
defaultIsEnabled bool

Methods

Method Returns
Clone() UIListItem

Static members

Name Type
UIListItem.typeInfo TypeInformation

Constructors

UIListItem

UIListItem()

Creates a new UIListItem frostbite instance.

UIListItem

UIListItem(guid: Guid)

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

Parameters

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

Properties

label

string

isEnabled

UIDataSourceInfo

isVisible

UIDataSourceInfo

toggleItems

UIDataSourceInfo

dataUpdate

UIDataSourceInfo

defaultIsVisible

bool

defaultIsEnabled

bool

Methods

Clone

Clone(): UIListItem

Creates a shallow-copy clone of this structure, which is essentially the equivalent of creating a new structure of the same type and assigning the values of this structure to all of its properties. Any properties that contain structure types (eg. Vec3) will be cloned when assigning, while properties that contain instance types (eg. DataContainer) will be referencing the same instance.

Returns

Type Description
UIListItem The newly created structure.

Static members

typeInfo

TypeInformation

The type information for the UIListItem type.

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