UIDataSourceInfo

Summary

Constructors

UIDataSourceInfo()
UIDataSourceInfo(guid: Guid)

Properties

Name Type
dataName string
dataCategory UIComponentData | nil
dataKey int
useDirectAccess bool
updateOnInitialize bool

Methods

Method Returns
Clone() UIDataSourceInfo

Static members

Name Type
UIDataSourceInfo.typeInfo TypeInformation

Constructors

UIDataSourceInfo

UIDataSourceInfo()

Creates a new UIDataSourceInfo frostbite instance.

UIDataSourceInfo

UIDataSourceInfo(guid: Guid)

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

Parameters

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

Properties

dataName

string

dataCategory

UIComponentData | nil

dataKey

int

useDirectAccess

bool

updateOnInitialize

bool

Methods

Clone

Clone(): UIDataSourceInfo

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
UIDataSourceInfo The newly created structure.

Static members

typeInfo

TypeInformation

The type information for the UIDataSourceInfo type.

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