Factorio Runtime DocsVersion 1.1.100

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

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

owner [R] :: LuaEntity

The LuaEntity owner of this LuaLogisticPoint.

The LuaEntity owner of this LuaLogisticPoint.

logistic_network [R] :: LuaLogisticNetwork
logistic_member_index [R] :: uint

The Logistic member index of this logistic point.

The Logistic member index of this logistic point.

filters [R] :: array[LogisticFilter]?

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

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

mode [R] :: defines.logistic_mode

The logistic mode.

The logistic mode.

force [R] :: LuaForce

The force of this logistic point.

The force of this logistic point.

targeted_items_pickup [R] :: dictionary[string → uint]

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

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

targeted_items_deliver [R] :: dictionary[string → uint]

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

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

exact [R] :: boolean

If this logistic point is using the exact mode.

If this logistic point is using the exact mode.

valid [R] :: boolean

Is this object valid?

Is this object valid?

object_name [R] :: string

The class name of this object.

The class name of this object.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

owner :: LuaEntityRead

The LuaEntity owner of this LuaLogisticPoint.


logistic_network :: LuaLogisticNetworkRead


logistic_member_index :: uintRead

The Logistic member index of this logistic point.


filters :: array[LogisticFilter]?Read

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

Note

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


mode :: defines.logistic_modeRead

The logistic mode.


force :: LuaForceRead

The force of this logistic point.

Note

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


targeted_items_pickup :: dictionary[string → uint] Read

Items targeted to be picked up from this logistic point by robots. The attribute is a dictionary mapping the item prototype names to their item counts.


targeted_items_deliver :: dictionary[string → uint] Read

Items targeted to be dropped off into this logistic point by robots. The attribute is a dictionary mapping the item prototype names to their item counts.


exact :: booleanRead

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


valid :: booleanRead

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 :: stringRead

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.

Classes

Events

Concepts

Defines

Builtin types