Kryzeth Standard Library

StdLib.Data.Setting

Wrapper for startup setting values and mod-setting prototypes.

Methods4 

function Setting.is_valid(type: nil | string) -> valid boolean

Returns whether this wrapper contains a valid setting.

Parameters
typenil | string

Setting type to require

Returns
validboolean
function Setting.force_hidden(value: table | boolean | string | number) -> self

Force a setting value and hide it from the settings UI. Only works during settings phase, when _raw is a setting prototype.

Parameters
valuetable | boolean | string | number

Setting value

Returns
self
function Setting.get(name: string) -> setting StdLib.Data.Setting

Looks up and wraps a startup setting value or mod-setting prototype.

Parameters
namestring

Setting name

Returns
settingStdLib.Data.Setting
function Setting.__call(name: string) -> setting StdLib.Data.Setting
Parameters
namestring

Setting name

Returns
settingStdLib.Data.Setting

Fields6

Setting.name : string

Setting name

Setting.valid : string | false

Setting type, "startup", or false when invalid

Setting._raw : nil | table

Wrapped setting value or prototype

Setting.value : nil | table | boolean | string | number

Resolved setting value

Setting.__class: string = "Setting"
 
Setting._object_mt: table