Prototype of a mod setting.
mod | :: R string | The mod that owns this setting. |
The mod that owns this setting. | ||
setting_type | :: R "startup" or "runtime-global" or "runtime-per-user" | |
default_value | :: R boolean or double or int or string or Color | The default value of this setting. |
The default value of this setting. | ||
minimum_value | :: R double or int? | The minimum value for this setting. [...] |
The minimum value for this setting. [...] | ||
maximum_value | :: R double or int? | The maximum value for this setting. [...] |
The maximum value for this setting. [...] | ||
allowed_values | :: R array[string] or array[int] or array[double] ? | The allowed values for this setting. [...] |
The allowed values for this setting. [...] | ||
allow_blank | :: R boolean? | Whether this string setting allows blank values. [...] |
Whether this string setting allows blank values. [...] | ||
auto_trim | :: R boolean? | Whether this string setting auto-trims values. [...] |
Whether this string setting auto-trims values. [...] | ||
valid | :: R boolean | Is this object valid? [...] |
Is this object valid? [...] | ||
object_name | :: R string | The class name of this object. [...] |
The class name of this object. [...] |
type | :: R string | Type of this prototype. |
Type of this prototype. | ||
name | :: R string | Name of this prototype. |
Name of this prototype. | ||
order | :: R string | The string used to alphabetically sort these prototypes. [...] |
The string used to alphabetically sort these prototypes. [...] | ||
localised_name | :: R LocalisedString | |
localised_description | :: R LocalisedString | |
group | :: R LuaGroup | Group of this prototype. |
Group of this prototype. | ||
subgroup | :: R LuaGroup | Subgroup of this prototype. |
Subgroup of this prototype. | ||
hidden | :: R boolean | |
hidden_in_factoriopedia | :: R boolean | |
parameter | :: R boolean |
The mod that owns this setting.
The default value of this setting.
The minimum value for this setting. nil
if this setting type doesn't support a minimum.
The maximum value for this setting. nil
if this setting type doesn't support a maximum.
The allowed values for this setting. nil
if this setting doesn't use the a fixed set of values.
Whether this string setting allows blank values. nil
if not a string setting.
Whether this string setting auto-trims values. nil
if not a string setting
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.
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.