Factorio Runtime DocsVersion 1.1.100

Class LuaModSettingPrototype

Prototype of a mod setting.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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
mod [R] :: string

The mod that owns this setting.

The mod that owns this setting.

setting_type [R] :: string
default_value [R] :: boolean or double or int or string

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.

hidden [R] :: boolean

Whether this setting is hidden from the GUI.

Whether this setting is hidden from the GUI.

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.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

type :: stringRead

Type of this prototype.


name :: stringRead

Name of this prototype.


order :: stringRead

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.


localised_name :: LocalisedStringRead


localised_description :: LocalisedStringRead


mod :: stringRead

The mod that owns this setting.


setting_type :: stringRead


default_value :: boolean or double or int or stringRead

The default value of this setting.


minimum_value :: double or int?Read

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


maximum_value :: double or int?Read

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


allowed_values :: array[string] or array[int] or array[double]?Read

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


allow_blank :: boolean?Read

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


auto_trim :: boolean?Read

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


hidden :: booleanRead

Whether this setting is hidden from the GUI.


valid :: booleanRead

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 :: stringRead

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.

Classes

Events

Concepts

Defines

Builtin types