Struct LuaLogisticSection 

pub struct LuaLogisticSection;

Logistic section of a particular LuaLogisticPoint or LuaConstantCombinatorControlBehavior.

Implementations

impl LuaLogisticSection

pub fn active(&self) -> bool

Whether this section is active. This can only be written to when the section is manual.

pub fn filters(&self) -> Vec<LogisticFilter>

The logistic filters for this section.

This can only be written to when the section is manual.

pub fn filters_count(&self) -> u32

Amount of filters this section has

pub fn group(&self) -> &str

The group this section belongs to.

An empty string when in no group.

This can only be written to when the section is manual.

pub fn index(&self) -> u32

The section index of this section.

pub fn is_manual(&self) -> bool

Shortcut to check whether LuaLogisticSection::type is equal to manual.

pub fn multiplier(&self) -> f32

Multiplier applied to all filters before they are used by game. This can only be written to when the section is manual.

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.

pub fn owner(&self) -> LuaEntity

The LuaEntity owner of this LuaLogisticSection.

pub fn type(&self) -> &str

The type of this logistic section. Sections that are not manual are controlled by game itself and may not be allowed to be changed by script.

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.

pub fn clear_slot(&self, slot_index: LuaAny)

Clears the logistic request and auto-trash from the given slot.

This can only be called when the section is manual.

pub fn get_slot(&self, slot_index: LuaAny) -> LogisticFilter

Gets current settings of logistic request and auto-trash from the given slot.

pub fn set_slot( &self, filter: LogisticFilter, slot_index: LuaAny, ) -> Option<LuaAny>

Sets logistic request and auto-trash slot to the given value.

This will silently fail if personal logistics are not researched yet.

This can only be called when the section is manual.

Trait Implementations

impl Clone for LuaLogisticSection

fn clone(&self) -> LuaLogisticSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaLogisticSection

impl Debug for LuaLogisticSection

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

Formats the value using the given formatter.

impl Default for LuaLogisticSection

fn default() -> LuaLogisticSection

Returns the “default value” for a type.

impl Eq for LuaLogisticSection

impl From<LuaLogisticSection> for LuaAny

fn from(_: LuaLogisticSection) -> Self

Converts to this type from the input type.

impl LuaObject for LuaLogisticSection

impl PartialEq for LuaLogisticSection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaLogisticSection