class.Setting.md

Latite Scripting Documentation (Exports)

---

Exports > feature/setting > Setting

Setting

Class

Source: feature/setting.d.ts:1

Constructors

constructor()

new Setting(): Setting

DO NOT USE - not implemented

Source: feature/setting.d.ts:5

Returns

Setting

Properties

description

readonly description: string

Source: feature/setting.d.ts:12

displayName

readonly displayName: string

Source: feature/setting.d.ts:11

name

readonly name: string

The name of the setting

Source: feature/setting.d.ts:10

Methods

getValue()

getValue(): any

Gets the value of the setting. Could be null.

Source: feature/setting.d.ts:19

Returns

any

setCondition()

setCondition(settingName: string, value?: boolean): void

Set that this setting will only show when another setting is on or off.

Source: feature/setting.d.ts:32

Parameters

Parameter	Type	Description
settingName	string	The setting that this setting will depend on (internal name).
value?	boolean	The value the other setting needs to be for this setting to show

Returns

void

setValue()

setValue(value: any): void

Sets the setting value.

Source: feature/setting.d.ts:25

Parameters

Parameter	Type	Description
value	any	The value to set. Must be of type corresponding to the type of the setting.

Returns

void

toString()

toString(): string

Source: feature/setting.d.ts:14

Returns

string