Factorio Runtime Docs

Class LuaGroup

Item group or subgroup.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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, if any.

The parent group, if any.

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.

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.


subgroups :: array[LuaGroup]? Read

Subgroups of this group. Can only be used on groups, not on subgroups.


order_in_recipe :: string? Read

The additional order value used in recipe ordering. Can only be used on groups, not on subgroups.


order :: string Read

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


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

>|