LuaLogisticNetwork

A single logistic network of a given force on a given surface.

Attributes

network_id

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

The unique logistic network ID.

custom_name

• Read: string
• Write: string
• Optional: true

The custom logistic network name set by the player or by script, if any.

force

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

The force this logistic network belongs to.

available_logistic_robots

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

Number of logistic robots available for a job.

all_logistic_robots

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

The total number of logistic robots in the network (idle and active + in roboports).

available_construction_robots

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

Number of construction robots available for a job.

all_construction_robots

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

The total number of construction robots in the network (idle and active + in roboports).

robot_limit

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

Maximum number of robots the network can work with. Currently only used for the personal roboport.

cells

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

All cells in this network.

providers

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

All entities that have logistic provider points in this network.

empty_providers

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

All entities that have empty logistic provider points in this network.

requesters

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

All entities that have logistic requester points in this network.

storages

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

All entities that have logistic storage points in this network.

logistic_members

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

All other entities that have logistic points in this network (inserters mostly).

provider_points

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

All things that have provider points in this network.

passive_provider_points

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

All passive provider points in this network.

active_provider_points

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

All active provider points in this network.

empty_provider_points

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

All things that have empty provider points in this network.

requester_points

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

All things that have requester points in this network.

storage_points

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

All things that have storage points in this network.

robots

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

All robots in this logistic network.

construction_robots

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

All construction robots in this logistic network.

logistic_robots

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

All logistic robots in this logistic network.

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

get_item_count

LuaLogisticNetwork.get_item_count(item?: ItemWithQualityID, member?: "storage" | "providers") -> int32

Call As

logisticNetwork.get_item_count()

Call Convention

• takes_table: false
• table_optional: false

Count given or all items in the network or given members.

Parameters

• item?: ItemWithQualityID — Item name to count. If not given, gives counts of all items in the network.
• member?: "storage" | "providers" — Logistic members to check. If not given, gives count in the entire network.

Returns

• int32

get_contents

LuaLogisticNetwork.get_contents(member?: "storage" | "providers") -> ItemWithQualityCounts

Call As

logisticNetwork.get_contents()

Call Convention

• takes_table: false
• table_optional: false

Get item counts for the entire network, similar to how LuaInventory::get_contents does.

Parameters

• member?: "storage" | "providers" — Logistic members to check. If not given, gives item counts for the entire network.

Returns

• ItemWithQualityCounts — List of all items in the network.

remove_item

LuaLogisticNetwork.remove_item(item: ItemStackIdentification, members?: "active-provider" | "passive-provider" | "buffer" | "storage") -> uint32

Call As

logisticNetwork.remove_item(item, members)

Call Convention

• takes_table: false
• table_optional: false

Remove items from the logistic network. This will actually remove the items from some logistic chests.

Parameters

• item: ItemStackIdentification — What to remove.
• members?: "active-provider" | "passive-provider" | "buffer" | "storage" — Which logistic members to remove from. If not specified, removes from the network in the usual order.

Returns

• uint32 — Number of items removed.

insert

LuaLogisticNetwork.insert(item: ItemStackIdentification, members?: "storage" | "storage-empty" | "storage-empty-slot" | "requester") -> uint32

Call As

logisticNetwork.insert(item, members)

Call Convention

• takes_table: false
• table_optional: false

Insert items into the logistic network. This will actually insert the items into some logistic chests.

Parameters

• item: ItemStackIdentification — What to insert.
• members?: "storage" | "storage-empty" | "storage-empty-slot" | "requester" — Which logistic members to insert the items to. "storage-empty" inserts into storage chests that are completely empty, "storage-empty-slot" inserts into storage chests that have an empty slot. If not specified, inserts items into the logistic network in the usual order.

Returns

• uint32 — Number of items actually inserted.

find_cell_closest_to

LuaLogisticNetwork.find_cell_closest_to(position: MapPosition) -> LuaLogisticCell?

Call As

logisticNetwork.find_cell_closest_to(position)

Call Convention

• takes_table: false
• table_optional: false

Find logistic cell closest to a given position.

Parameters

• position: MapPosition

Returns

• LuaLogisticCell? — nil if no cell was found.

select_pickup_point

LuaLogisticNetwork.select_pickup_point{ name: ItemWithQualityID, position?: MapPosition, include_buffers?: boolean, members?: "active-provider" | "passive-provider" | "buffer" | "storage" } -> LuaLogisticPoint?

Call As

logisticNetwork.select_pickup_point{ name="name" }

Call Convention

• takes_table: true
• table_optional: false

Find the 'best' logistic point with this item ID and from the given position or from given chest type.

Parameters

• name: ItemWithQualityID — Name of the item to pick up.
• position?: MapPosition — When given, it will find the storage 'best' storage point from this position.
• include_buffers?: boolean — Whether to consider buffer chests or not. Defaults to false. Only considered if selecting with position.
• members?: "active-provider" | "passive-provider" | "buffer" | "storage" — When given, it will find from only the specific type of member. If not specified, selects with normal priorities. Not considered if position is specified.

Returns

• LuaLogisticPoint? — nil if no point was found.

select_drop_point

LuaLogisticNetwork.select_drop_point{ stack: ItemStackIdentification, members?: "storage" | "storage-empty" | "storage-empty-slot" | "requester" } -> LuaLogisticPoint?

Call As

logisticNetwork.select_drop_point{ stack=stack }

Call Convention

• takes_table: true
• table_optional: false

Find a logistic point to drop the specific item stack.

Parameters

• stack: ItemStackIdentification — Name of the item to drop off.
• members?: "storage" | "storage-empty" | "storage-empty-slot" | "requester" — When given, it will find from only the specific type of member. If not specified, selects with normal priorities.

Returns

• LuaLogisticPoint? — nil if no point was found.

can_satisfy_request

LuaLogisticNetwork.can_satisfy_request(item: ItemWithQualityID, count?: uint32, include_buffers?: boolean) -> boolean

Call As

logisticNetwork.can_satisfy_request(item, count)

Call Convention

• takes_table: false
• table_optional: false

Can the network satisfy a request for a given item and count.

Parameters

• item: ItemWithQualityID — Item name to check.
• count?: uint32 — Count to check. Defaults to 1.
• include_buffers?: boolean — Should buffers be considered? Defaults to false.

Returns

• boolean — Whether the network can satisfy the request.

get_supply_counts

LuaLogisticNetwork.get_supply_counts(item: ItemWithQualityID) -> LogisticsNetworkSupplyCounts

Call As

logisticNetwork.get_supply_counts(item)

Call Convention

• takes_table: false
• table_optional: false

Get the amount of items of the given type indexed by the storage member.

Parameters

• item: ItemWithQualityID — Item name to check.

Returns

• LogisticsNetworkSupplyCounts

get_supply_points

LuaLogisticNetwork.get_supply_points(item: ItemWithQualityID) -> LogisticsNetworkSupplyPoints

Call As

logisticNetwork.get_supply_points(item)

Call Convention

• takes_table: false
• table_optional: false

Gets the logistic points with of the given type indexed by the storage member.

Parameters

• item: ItemWithQualityID — Item name to check.

Returns

• LogisticsNetworkSupplyPoints