tes3gameSetting⚓︎
A GMST game object.
This type inherits the following: tes3baseObject
Properties⚓︎
blocked⚓︎
The blocked state of the object.
Returns:
result(boolean)
defaultValue⚓︎
Read-only. The default value of the GMST, if no master defines the value.
Returns:
result(number, string)
deleted⚓︎
Read-only. The deleted state of the object.
Returns:
result(boolean)
disabled⚓︎
Read-only. The disabled state of the object.
Returns:
result(boolean)
id⚓︎
Read-only. The unique identifier for the object.
Returns:
result(string)
index⚓︎
Read-only. The array index for the GMST.
Returns:
result(number)
modified⚓︎
The modification state of the object since the last save.
Returns:
result(boolean)
objectFlags⚓︎
Read-only. The raw flags of the object.
Returns:
result(number)
objectType⚓︎
Read-only. The type of object. Maps to values in tes3.objectType.
Returns:
result(tes3.objectType)
persistent⚓︎
The persistent flag of the object.
Returns:
result(boolean)
rawValue⚓︎
The base value of the game setting, as stored in memory. Prefer to use .value unless you know what you're doing.
Returns:
result(number)
sourceless⚓︎
The soruceless flag of the object.
Returns:
result(boolean)
sourceMod⚓︎
Read-only. The filename (including the extension) of the mod that owns this object. It has nil value if the object was anything other than loaded from an ESP or ESM file.
Returns:
result(string)
supportsLuaData⚓︎
If true, references of this object can store temporary or persistent lua data.
Returns:
result(boolean)
type⚓︎
Read-only. The type of the variable, either i, f, or s.
Returns:
result(string)
value⚓︎
The value of the GMST.
Returns:
result(number, string)
Methods⚓︎
__tojson⚓︎
Serializes the object to json.
local string = myObject:__tojson()
Returns:
string(string)