SettingConfig

Summary

Constructors

SettingConfig()
SettingConfig(guid: Guid)

Properties

Name Type
key string
nameSid string
descSid string
max int
default int
min int
ranked bool

Methods

Method Returns
Clone() SettingConfig

Static members

Name Type
SettingConfig.typeInfo TypeInformation

Constructors

SettingConfig

SettingConfig()

Creates a new SettingConfig frostbite instance.

SettingConfig

SettingConfig(guid: Guid)

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

Parameters

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

Properties

key

string

nameSid

string

descSid

string

max

int

default

int

min

int

ranked

bool

Methods

Clone

Clone(): SettingConfig

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

Static members

typeInfo

TypeInformation

The type information for the SettingConfig type.

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