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

# Factorio Runtime Docs Version 2.0.77

# LuaLogisticCell - Runtime Docs

## Class LuaLogisticCell

Logistic cell of a particular LuaEntity. A "Logistic Cell" is the given name for settings and properties used by what would normally be seen as a "Roboport". A logistic cell however doesn't have to be attached to the roboport entity (the character has one for the personal roboport).

## Members

is_in_logistic_range(position) | → boolean | Is a given position within the logistic range of this cell?
Is a given position within the logistic range of this cell?
is_in_construction_range(position) | → boolean | Is a given position within the construction range of this cell?
Is a given position within the construction range of this cell?
is_neighbour_with(other) | → boolean | Are two cells neighbours?
Are two cells neighbours?
logistic_radius | :: R float | Logistic radius of this cell.
Logistic radius of this cell.
logistics_connection_distance | :: R float | Logistic connection distance of this cell.
Logistic connection distance of this cell.
construction_radius | :: R float | Construction radius of this cell.
Construction radius of this cell.
stationed_logistic_robot_count | :: R uint32 | Number of stationed logistic robots in this cell.
Number of stationed logistic robots in this cell.
stationed_construction_robot_count | :: R uint32 | Number of stationed construction robots in this cell.
Number of stationed construction robots in this cell.
mobile | :: R boolean | `true` if this is a mobile cell. [...]
`true` if this is a mobile cell. [...]
transmitting | :: R boolean | `true` if this cell is active.
`true` if this cell is active.
charge_approach_distance | :: R float | Radius at which the robots hover when waiting to be charged.
Radius at which the robots hover when waiting to be charged.
charging_robot_count | :: R uint32 | Number of robots currently charging.
Number of robots currently charging.
to_charge_robot_count | :: R uint32 | Number of robots waiting to charge.
Number of robots waiting to charge.
owner | :: R LuaEntity | This cell's owner.
This cell's owner.
logistic_network | :: R LuaLogisticNetwork? | The network that owns this cell, if any.
The network that owns this cell, if any.
neighbours | :: R array[LuaLogisticCell] | Neighbouring cells.
Neighbouring cells.
charging_robots | :: R array[LuaEntity] | Robots currently being charged.
Robots currently being charged.
to_charge_robots | :: R array[LuaEntity] | Robots waiting to charge.
Robots waiting to charge.
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

### is_in_logistic_range(position) → boolean

Is a given position within the logistic range of this cell?

#### Parameters

position | :: MapPosition |

### is_in_construction_range(position) → boolean

Is a given position within the construction range of this cell?

#### Parameters

position | :: MapPosition |

### is_neighbour_with(other) → boolean

Are two cells neighbours?

#### Parameters

other | :: LuaLogisticCell |

## Attributes

### logistic_radius :: Read float

Logistic radius of this cell.

### logistics_connection_distance :: Read float

Logistic connection distance of this cell.

### construction_radius :: Read float

Construction radius of this cell.

### stationed_logistic_robot_count :: Read uint32

Number of stationed logistic robots in this cell.

### stationed_construction_robot_count :: Read uint32

Number of stationed construction robots in this cell.

### mobile :: Read boolean

`true` if this is a mobile cell. The logistic cell created by roboport equipment considered is mobile.

### transmitting :: Read boolean

`true` if this cell is active.

### charge_approach_distance :: Read float

Radius at which the robots hover when waiting to be charged.

### charging_robot_count :: Read uint32

Number of robots currently charging.

### to_charge_robot_count :: Read uint32

Number of robots waiting to charge.

### owner :: Read LuaEntity

This cell's owner.

### logistic_network :: Read LuaLogisticNetwork?

The network that owns this cell, if any.

### neighbours :: Read array[LuaLogisticCell]

Neighbouring cells.

### charging_robots :: Read array[LuaEntity]

Robots currently being charged.

### to_charge_robots :: Read array[LuaEntity]

Robots waiting to charge.

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

- LuaEntity::logistic_cell
- LuaLogisticCell::is_neighbour_with()
- LuaLogisticCell::neighbours
- LuaLogisticNetwork::find_cell_closest_to()
- LuaLogisticNetwork::cells
- RegistrationTarget