LuaModSettingPrototype

Prototype of a mod setting.

class LuaModSettingPrototype - sort
name :: string [R] Name of this prototype.
order :: string [R] Order string of this prototype.
localised_name :: LocalisedString [R]
localised_description :: LocalisedString [R]
mod :: string [R] The mod that owns this setting.
setting_type :: string [R]
default_value :: boolean or double or int or string [R] The default value of this setting.
minimum_value :: double or int [R] The minimum value for this setting or nil if this setting type doesn't support a minimum.
maximum_value :: double or int [R] The maximum value for this setting or nil if this setting type doesn't support a maximum.
allowed_values :: array[string] or array[int] or array[double] [R] The allowed values for this setting or nil if this setting doesn't use the a fixed set of values.
allow_blank :: boolean [R] If this string setting allows blank values or nil if not a string setting.
auto_trim :: boolean [R] If this string setting auto-trims values or nil if not a string setting.
hidden :: boolean [R] If this setting is hidden from the GUI.
valid :: boolean [R] Is this object valid?
object_name :: string [R] The class name of this object.
help() → string All methods and properties that this object supports.
name :: string [Read-only]

Name of this prototype.

order :: string [Read-only]

Order string of this prototype.

localised_name :: LocalisedString [Read-only]

localised_description :: LocalisedString [Read-only]

mod :: string [Read-only]

The mod that owns this setting.

setting_type :: string [Read-only]

default_value :: boolean or double or int or string [Read-only]

The default value of this setting.

minimum_value :: double or int [Read-only]

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

maximum_value :: double or int [Read-only]

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

allowed_values :: array[string] or array[int] or array[double] [Read-only]

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

allow_blank :: boolean [Read-only]

If this string setting allows blank values or nil if not a string setting.

auto_trim :: boolean [Read-only]

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

hidden :: boolean [Read-only]

If this setting is hidden from the GUI.