LuaLogisticSections

Logistic sections of an entity.

Attributes

sections

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

All logistic sections of this entity.

sections_count

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

Amount of logistic sections this entity has.

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

add_section

LuaLogisticSections.add_section(group?: string) -> LuaLogisticSection?

Call As

logisticSections.add_section()

Call Convention

• takes_table: false
• table_optional: false

Adds a new logistic section if possible.

Parameters

• group?: string — The group to assign this section to.

Returns

• LuaLogisticSection? — Logistic section if added.

remove_section

LuaLogisticSections.remove_section(section_index: uint32) -> boolean

Call As

logisticSections.remove_section(section_index)

Call Convention

• takes_table: false
• table_optional: false

Removes the given logistic section if possible. Removal may fail if the section index is out of range or the section is not manual.

Parameters

• section_index: uint32 — Index of the section.

Returns

• boolean — Whether section was removed.

get_section

LuaLogisticSections.get_section(section_index: uint32) -> LuaLogisticSection?

Call As

logisticSections.get_section(section_index)

Call Convention

• takes_table: false
• table_optional: false

Gets section on the selected index, if it exists.

Parameters

• section_index: uint32 — Index of the section.

Returns

• LuaLogisticSection?