Factorio Runtime DocsVersion 2.0.72

If this commandable is UnitGroup.

If this commandable is Entity.

Surface this commandable is on.

Current position of this commandable.

If commandable is a UnitGroup, this can have different meanings depending on the group state. When the group is gathering, the position is the place of gathering. When the group is moving, the position is the expected position of its members along the path. When the group is attacking, it is the average position of its members.

The force of this commandable.

Unique identifier of this commandable.

If this commandable has a command assigned.

The command of this commandable, if any.

The distraction command of this commandable, if any.

The unit group this commandable is a member of, if any.

The spawner associated with this commandable, if any.

Current moving state of the commandable's behavior

Whether this group is gathering, moving or attacking.

All entity members of this unit group, recursive (if unit group is member of this unit group, its members will be returned here).

Non recursively returns all members of this unit group.

Whether this unit group is controlled by a script or by the game engine. This can be changed using LuaCommandable::set_autonomous. Units created by LuaSurface::create_unit_group are considered script-driven.

Returns entity object for this commandable.

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.

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.