Factorio API Docs

1.1.49 <>
|<

Classes

Events

Concepts

Defines

Builtin types

>|

Class LuaGroup

Item group or subgroup.

help()
string

All methods and properties that this object supports.


:: string
[R]

[R]

Localised name of the group.


:: string
[R]

[R]

The parent group if any; nil if none.


:: array[LuaGroup]
[R]

Subgroups of this group.


:: string
[R]

The additional order value used in recipe ordering.


:: string
[R]

:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

help() → string

All methods and properties that this object supports.

Attributes

name :: string [Read]


localised_name :: LocalisedString [Read]

Localised name of the group.


type :: string [Read]


group :: LuaGroup [Read]

The parent group if any; nil if none.


subgroups :: array[LuaGroup] [Read]

Subgroups of this group.

Note

Can only be used on groups, not on subgroups.


order_in_recipe :: string [Read]

The additional order value used in recipe ordering.

Note

Can only be used on groups, not on subgroups.


order :: string [Read]


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.