LuaLogisticPoint

Logistic point of a particular LuaEntity. A "Logistic point" is the name given for settings and properties used by requester, provider, and storage points in a given logistic network. These "points" don't have to be a logistic container but often are. One other entity that can own several points is the "character" character type entity.

Attributes

owner

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

The LuaEntity owner of this LuaLogisticPoint.

logistic_network

• Read: LuaLogisticNetwork
• Write: unknown
• Optional: false

logistic_member_index

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

The Logistic member index of this logistic point.

filters

• Read: Array<CompiledLogisticFilter>
• Write: unknown
• Optional: true

The logistic filters for this logistic point, if this uses any.

The returned array will always have an entry for each filter and will be indexed in sequence when not nil.

mode

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

The logistic mode.

force

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

The force of this logistic point.

This will always be the same as the LuaLogisticPoint::owner force.

targeted_items_pickup

• Read: ItemWithQualityCounts
• Write: unknown
• Optional: false

Items targeted to be picked up from this logistic point by robots.

targeted_items_deliver

• Read: ItemWithQualityCounts
• Write: unknown
• Optional: false

Items targeted to be dropped off into this logistic point by robots.

exact

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

If this logistic point is using the exact mode. In exact mode robots never over-deliver requests.

trash_not_requested

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

Whether this logistic point is set to trash unrequested items.

enabled

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

Whether this logistic point is active, related to disabling logistics on player/spidertron.

When the logistic point is disabled it won't request and auto trash will do nothing.

sections

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

All logistic sections of this logistic point.

sections_count

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

Amount of logistic sections this logistic point 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

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

Call As

logisticPoint.add_section()

Call Convention

• takes_table: false
• table_optional: false

Adds a new logistic section to this logistic point if possible.

Parameters

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

Returns

• LuaLogisticSection? — The added logistic section.

remove_section

LuaLogisticPoint.remove_section(section_index: uint32) -> boolean

Call As

logisticPoint.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

LuaLogisticPoint.get_section(section_index: uint32) -> LuaLogisticSection

Call As

logisticPoint.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