LuaModSettingPrototype

Prototype of a mod setting.

Parent

• LuaPrototypeBase

Attributes

mod

• Read: string
• Write: unknown
• Optional: false

The mod that owns this setting.

setting_type

• Read: "startup" | "runtime-global" | "runtime-per-user"
• Write: unknown
• Optional: false

default_value

• Read: boolean | double | int32 | string | Color
• Write: unknown
• Optional: false

The default value of this setting.

minimum_value

• Read: double | int32
• Write: unknown
• Optional: true

The minimum value for this setting. nil if this setting type doesn't support a minimum.

maximum_value

• Read: double | int32
• Write: unknown
• Optional: true

The maximum value for this setting. nil if this setting type doesn't support a maximum.

allowed_values

• Read: Array<string> | Array<int32> | Array<double>
• Write: unknown
• Optional: true

The allowed values for this setting. nil if this setting doesn't use the a fixed set of values.

allow_blank

• Read: boolean
• Write: unknown
• Optional: true

Whether this string setting allows blank values. nil if not a string setting.

auto_trim

• Read: boolean
• Write: unknown
• Optional: true

Whether this string setting auto-trims values. nil if not a string setting

valid

• Read: boolean
• Write: unknown
• Optional: false

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.