Skip to main content

LuaLogisticCell

Struct LuaLogisticCell 

Source
pub struct LuaLogisticCell;
Expand description

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

Implementations§

Source§

impl LuaLogisticCell

Source

pub fn charge_approach_distance(&self) -> f32

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

Source

pub fn charging_robot_count(&self) -> u32

Number of robots currently charging.

Source

pub fn charging_robots(&self) -> Vec<LuaEntity>

Robots currently being charged.

Source

pub fn construction_radius(&self) -> f32

Construction radius of this cell.

Source

pub fn logistic_network(&self) -> LuaLogisticNetwork

The network that owns this cell, if any.

Source

pub fn logistic_radius(&self) -> f32

Logistic radius of this cell.

Source

pub fn logistics_connection_distance(&self) -> f32

Logistic connection distance of this cell.

Source

pub fn mobile(&self) -> bool

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

Source

pub fn neighbours(&self) -> Vec<LuaLogisticCell>

Neighbouring cells.

Source

pub fn object_name(&self) -> &str

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.

Source

pub fn owner(&self) -> LuaEntity

This cell’s owner.

Source

pub fn stationed_construction_robot_count(&self) -> u32

Number of stationed construction robots in this cell.

Source

pub fn stationed_logistic_robot_count(&self) -> u32

Number of stationed logistic robots in this cell.

Source

pub fn to_charge_robot_count(&self) -> u32

Number of robots waiting to charge.

Source

pub fn to_charge_robots(&self) -> Vec<LuaEntity>

Robots waiting to charge.

Source

pub fn transmitting(&self) -> bool

true if this cell is active.

Source

pub fn valid(&self) -> bool

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.

Source

pub fn is_in_construction_range(&self, position: MapPosition) -> bool

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

Source

pub fn is_in_logistic_range(&self, position: MapPosition) -> bool

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

Source

pub fn is_neighbour_with(&self, other: LuaLogisticCell) -> bool

Are two cells neighbours?

Trait Implementations§

Source§

impl Clone for LuaLogisticCell

Source§

fn clone(&self) -> LuaLogisticCell

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for LuaLogisticCell

Source§

impl Debug for LuaLogisticCell

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for LuaLogisticCell

Source§

fn default() -> LuaLogisticCell

Returns the “default value” for a type. Read more
Source§

impl Eq for LuaLogisticCell

Source§

impl From<LuaLogisticCell> for LuaAny

Source§

fn from(_: LuaLogisticCell) -> Self

Converts to this type from the input type.
Source§

impl LuaObject for LuaLogisticCell

Source§

impl PartialEq for LuaLogisticCell

Source§

fn eq(&self, other: &LuaLogisticCell) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LuaLogisticCell

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.