Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaLogisticPoint - Runtime Docs

## 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

add_section(group?) | → LuaLogisticSection? | Adds a new logistic section to this logistic point if possible.
Adds a new logistic section to this logistic point if possible.
remove_section(section_index) | → boolean | Removes the given logistic section if possible. [...]
Removes the given logistic section if possible. [...]
get_section(section_index) | → LuaLogisticSection | Gets section on the selected index, if it exists
Gets section on the selected index, if it exists
owner | :: R LuaEntity | The LuaEntity owner of this LuaLogisticPoint.
The LuaEntity owner of this LuaLogisticPoint.
logistic_network | :: R LuaLogisticNetwork |
logistic_member_index | :: R defines.logistic_member_index | The Logistic member index of this logistic point.
The Logistic member index of this logistic point.
filters | :: R array[CompiledLogisticFilter]? | 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 array[ItemWithQualityCount] | 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 array[ItemWithQualityCount] | Items targeted to be dropped off into this logistic point by robots or cargo pods.
Items targeted to be dropped off into this logistic point by robots or cargo pods.
exact | :: R boolean | If this logistic point is using the exact mode. [...]
If this logistic point is using the exact mode. [...]
trash_not_requested | :: RW boolean | Whether this logistic point is set to trash unrequested items.
Whether this logistic point is set to trash unrequested items.
enabled | :: RW boolean | Whether this logistic point is active, related to disabling logistics on player/spidertron. [...]
Whether this logistic point is active, related to disabling logistics on player/spidertron. [...]
sections | :: R array[LuaLogisticSection] | All logistic sections of this logistic point.
All logistic sections of this logistic point.
sections_count | :: R uint32 | Amount of logistic sections this logistic point has.
Amount of logistic sections this logistic point has.
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

### add_section(group?) → LuaLogisticSection?

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

#### Parameters

group | :: string? | The group to assign this section to.
The group to assign this section to.

#### Return values

→ LuaLogisticSection? | The added logistic section.

### remove_section(section_index) → boolean

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
Index of the section

#### Return values

→ boolean | Whether section was removed.

### get_section(section_index) → LuaLogisticSection

Gets section on the selected index, if it exists

#### Parameters

section_index | :: uint32 | Index of the section
Index of the section

## Attributes

### owner :: Read LuaEntity

The LuaEntity owner of this LuaLogisticPoint.

### logistic_network :: Read LuaLogisticNetwork

### logistic_member_index :: Read defines.logistic_member_index

The Logistic member index of this logistic point.

### filters :: Read array[CompiledLogisticFilter]?

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

The logistic mode.

### force :: Read LuaForce

The force of this logistic point.

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

### targeted_items_pickup :: Read array[ItemWithQualityCount]

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

### targeted_items_deliver :: Read array[ItemWithQualityCount]

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

### exact :: Read boolean

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

### trash_not_requested :: Read|Write boolean

Whether this logistic point is set to trash unrequested items.

### enabled :: Read|Write boolean

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]

All logistic sections of this logistic point.

### sections_count :: Read uint32

Amount of logistic sections this logistic point has.

### valid :: Read boolean

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

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.

Class used in

- LuaControl::get_requester_point()
- LuaEntity::get_logistic_point()
- LuaLogisticNetwork::select_pickup_point()
- LuaLogisticNetwork::select_drop_point()
- LuaLogisticNetwork::provider_points
- LuaLogisticNetwork::passive_provider_points
- LuaLogisticNetwork::active_provider_points
- LuaLogisticNetwork::empty_provider_points
- LuaLogisticNetwork::requester_points
- LuaLogisticNetwork::storage_points
- LogisticsNetworkSupplyPoints