LuaCommandable

AI object which can be ordered commands. This can represent a UnitGroup (a set of multiple commandables) or can be a single Unit or SpiderUnit.

Attributes

is_unit_group

• Read: boolean
• Write: unknown
• Optional: false

If this commandable is UnitGroup.

is_entity

• Read: boolean
• Write: unknown
• Optional: false

If this commandable is Entity.

surface

• Read: LuaSurface
• Write: unknown
• Optional: false

Surface this commandable is on.

position

• Read: MapPosition
• Write: unknown
• Optional: false

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.

force

• Read: LuaForce
• Write: unknown
• Optional: false

The force of this commandable.

unique_id

• Read: uint32
• Write: unknown
• Optional: false

Unique identifier of this commandable.

has_command

• Read: boolean
• Write: unknown
• Optional: false

If this commandable has a command assigned.

command

• Read: Command
• Write: unknown
• Optional: true

The command of this commandable, if any.

distraction_command

• Read: Command
• Write: unknown
• Optional: true

The distraction command of this commandable, if any.

parent_group

• Read: LuaCommandable
• Write: unknown
• Optional: true

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

spawner

• Read: LuaEntity
• Write: unknown
• Optional: true

The spawner associated with this commandable, if any.

moving_state

• Read: defines.moving_state
• Write: unknown
• Optional: false

Current moving state of the commandable's behavior

state

• Read: defines.group_state
• Write: unknown
• Optional: false

Whether this group is gathering, moving or attacking.

members

• Read: Array<LuaEntity>
• Write: unknown
• Optional: false

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

commandable_members

• Read: Array<LuaCommandable>
• Write: unknown
• Optional: false

Non recursively returns all members of this unit group.

is_script_driven

• Read: boolean
• Write: unknown
• Optional: false

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.

entity

• Read: LuaEntity
• Write: unknown
• Optional: false

Returns entity object for this commandable.

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.

Methods

destroy

LuaCommandable.destroy()

Call As

commandable.destroy()

Call Convention

• takes_table: false
• table_optional: false

Destroys this commandable. If it is a unit group, members will not be destroyed, they will be merely unlinked from the group.

set_command

LuaCommandable.set_command(command: Command)

Call As

commandable.set_command(command)

Call Convention

• takes_table: false
• table_optional: false

Give this commandable a command.

Parameters

• command: Command

set_distraction_command

LuaCommandable.set_distraction_command(command: Command)

Call As

commandable.set_distraction_command(command)

Call Convention

• takes_table: false
• table_optional: false

Give this commandable a distraction command.

Parameters

• command: Command

release_from_spawner

LuaCommandable.release_from_spawner()

Call As

commandable.release_from_spawner()

Call Convention

• takes_table: false
• table_optional: false

Release the commandable from the spawner. This allows the spawner to continue spawning additional units.

add_member

LuaCommandable.add_member(member: LuaCommandable | LuaEntity)

Call As

commandable.add_member(member)

Call Convention

• takes_table: false
• table_optional: false

Adds a member to this UnitGroup. Has the same effect as setting defines.command.group command on the member to join the group.

The member must have the same force be on the same surface as the group.

Parameters

• member: LuaCommandable | LuaEntity

set_autonomous

LuaCommandable.set_autonomous()

Call As

commandable.set_autonomous()

Call Convention

• takes_table: false
• table_optional: false

Make this group autonomous. Autonomous groups will automatically attack polluted areas. Autonomous groups aren't considered to be script-driven.

start_moving

LuaCommandable.start_moving()

Call As

commandable.start_moving()

Call Convention

• takes_table: false
• table_optional: false

Make the group start moving even if some of its members haven't yet arrived.