Factorio Runtime Docs

Class LuaEquipmentGridPrototype

Prototype of an equipment grid.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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

Equipment category names for the categories that may be inserted into this equipment grid.

Equipment category names for the categories that may be inserted into this equipment grid.

width [R] :: uint
height [R] :: uint
locked [R] :: boolean

If the player can move equipment into or out of this grid.

If the player can move equipment into or out of this grid.

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

name :: string Read

Name of this prototype.


order :: string Read

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


localised_name :: LocalisedString Read


localised_description :: LocalisedString Read


equipment_categories :: array[string] Read

Equipment category names for the categories that may be inserted into this equipment grid. The grid will accept any equipment that has at least one category in this list.


width :: uint Read


height :: uint Read


locked :: boolean Read

If the player can move equipment into or out of this grid.


valid :: boolean Read

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 :: string Read

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

>|