LuaGroup - Runtime Docs

ClassLuaGroup

Item group or subgroup.

Members

name	:: R string
localised_name	:: R LocalisedString	Localised name of the group.
Localised name of the group.
type	:: R string
group	:: R LuaGroup	The parent group.
The parent group.
subgroups	:: R array[LuaGroup]	Subgroups of this group.
Subgroups of this group.
order_in_recipe	:: R string	The additional order value used in recipe ordering.
The additional order value used in recipe ordering.
order	:: R string	The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
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. [...]

Attributes

name :: Read string

localised_name :: Read LocalisedString

Localised name of the group.

type :: Read string

group :: Read LuaGroup

The parent group.

Can only be used if this is ItemSubGroup

subgroups :: Read array[LuaGroup]

Subgroups of this group.

Can only be used if this is ItemGroup

order_in_recipe :: Read string

The additional order value used in recipe ordering.

Can only be used if this is ItemGroup

order :: Read string

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

valid :: Read boolean

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

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 - Concepts - Events - Defines

Factorio Runtime DocsVersion 2.0.14