Struct LuaEquipment 

pub struct LuaEquipment;

An item in a LuaEquipmentGrid, for example a fusion reactor placed in one’s power armor.

An equipment reference becomes invalid once the equipment is removed or the equipment grid it resides in is destroyed.

Implementations

impl LuaEquipment

pub fn burner(&self) -> LuaBurner

The burner energy source for this equipment, if any.

pub fn electric_buffer_size(&self) -> f64

The power buffer size of this ElectricEnergyInterfaceEquipment.

pub fn energy(&self) -> f64

Current available energy.

pub fn generator_power(&self) -> f64

Energy generated per tick.

pub fn ghost_name(&self) -> &str

Name of the equipment contained in this ghost

pub fn ghost_prototype(&self) -> LuaEquipmentPrototype

The prototype of the equipment contained in this ghost.

pub fn ghost_type(&self) -> &str

Type of the equipment contained in this ghost.

pub fn inventory_bonus(&self) -> u32

Inventory size bonus.

pub fn max_energy(&self) -> f64

Maximum amount of energy that can be stored in this equipment.

pub fn max_shield(&self) -> f64

Maximum shield value. 0 if this equipment doesn’t have a shield.

pub fn max_solar_power(&self) -> f64

Maximum energy per tick crated by this equipment on the current surface. Actual generated energy varies depending on the daylight levels.

pub fn movement_bonus(&self) -> f64

Movement speed bonus.

pub fn name(&self) -> &str

Name of this equipment.

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 position(&self) -> EquipmentPosition

Position of this equipment in the equipment grid.

pub fn power_production(&self) -> f64

The power production specific to the ElectricEnergyInterfaceEquipment type.

pub fn power_usage(&self) -> f64

The power usage specific to the ElectricEnergyInterfaceEquipment type.

pub fn prototype(&self) -> LuaEquipmentPrototype

pub fn quality(&self) -> LuaQualityPrototype

Quality of this equipment.

pub fn shape(&self) -> LuaEquipmentShape

Shape of this equipment.

pub fn shield(&self) -> f64

Current shield value of the equipment. Can’t be set higher than LuaEquipment::max_shield.

Trying to write this value on non-shield equipment will throw an error.

pub fn to_be_removed(&self) -> bool

If this equipment is marked to be removed.

pub fn type(&self) -> &str

Type of this equipment.

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.

Trait Implementations

impl Clone for LuaEquipment

fn clone(&self) -> LuaEquipment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaEquipment

impl Debug for LuaEquipment

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

Formats the value using the given formatter.

impl Default for LuaEquipment

fn default() -> LuaEquipment

Returns the “default value” for a type.

impl Eq for LuaEquipment

impl From<LuaEquipment> for LuaAny

fn from(_: LuaEquipment) -> Self

Converts to this type from the input type.

impl LuaObject for LuaEquipment

impl PartialEq for LuaEquipment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaEquipment