Struct LuaEquipmentPrototype 

pub struct LuaEquipmentPrototype;

Prototype of a modular equipment.

Implementations

impl LuaEquipmentPrototype

pub fn custom_tooltip_fields(&self) -> Vec<CustomTooltipField>

Extra description items in the tooltip and Factoriopedia.

pub fn factoriopedia_description(&self) -> &'static str

Provides additional description used in factoriopedia.

pub fn group(&self) -> LuaGroup

Group of this prototype.

pub fn hidden(&self) -> bool

pub fn hidden_in_factoriopedia(&self) -> bool

pub fn localised_description(&self) -> &'static str

pub fn localised_name(&self) -> &'static str

pub fn name(&self) -> &'static str

Name of this prototype.

pub fn order(&self) -> &'static str

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.

pub fn parameter(&self) -> bool

pub fn subgroup(&self) -> LuaGroup

Subgroup of this prototype.

pub fn type(&self) -> &'static str

Type of this prototype.

pub fn attack_parameters(&self) -> AttackParameters

The equipment attack parameters.

pub fn automatic(&self) -> bool

Whether this active defense equipment is automatic. Returns false if not active defense equipment.

pub fn background_color(&self) -> Color

The background color of this equipment prototype.

pub fn burner_prototype(&self) -> LuaBurnerPrototype

The burner energy source prototype this equipment uses, if any.

pub fn darkness_to_turn_on(&self) -> f32

pub fn electric_energy_source_prototype( &self, ) -> LuaElectricEnergySourcePrototype

The electric energy source prototype this equipment uses, if any.

pub fn energy_per_shield(&self) -> f64

The energy per shield point restored. 0 for non-shield equipment.

pub fn energy_production(&self) -> f64

The max power generated by this equipment.

pub fn energy_source(&self) -> LuaElectricEnergySourcePrototype

The energy source prototype for the equipment.

pub fn equipment_categories(&self) -> Vec<&'static str>

Category names for this equipment. These categories will be used to determine whether this equipment is allowed in a particular equipment grid.

pub fn gui_mode(&self) -> LuaEntityPrototypeGuiMode

pub fn logistic_parameters(&self) -> LuaEquipmentPrototypeLogisticParameters

The logistic parameters for this roboport equipment.

pub fn object_name(&self) -> &'static 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 shape(&self) -> LuaEquipmentPrototypeShape

Shape of this equipment prototype.

pub fn solar_panel_performance_at_day(&self) -> f64

pub fn solar_panel_performance_at_night(&self) -> f64

pub fn solar_panel_solar_coefficient_property( &self, ) -> LuaSurfacePropertyPrototype

pub fn take_result(&self) -> LuaItemPrototype

The result item when taking this equipment out of an equipment grid, if any.

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 get_energy_consumption(&self, quality: Option<QualityID>) -> f64

pub fn get_inventory_bonus(&self, quality: Option<QualityID>) -> Option<u32>

pub fn get_movement_bonus(&self, quality: Option<QualityID>) -> Option<f32>

pub fn get_shield(&self, quality: Option<QualityID>) -> f32

The shield value of this equipment. 0 for non-shield equipment.

Trait Implementations

impl Clone for LuaEquipmentPrototype

fn clone(&self) -> LuaEquipmentPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaEquipmentPrototype

impl Debug for LuaEquipmentPrototype

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

Formats the value using the given formatter.

impl Default for LuaEquipmentPrototype

fn default() -> LuaEquipmentPrototype

Returns the “default value” for a type.

impl Eq for LuaEquipmentPrototype

impl From<LuaEquipmentPrototype> for LuaAny

fn from(_: LuaEquipmentPrototype) -> Self

Converts to this type from the input type.

impl From<LuaEquipmentPrototype> for EquipmentID

fn from(value: LuaEquipmentPrototype) -> Self

Converts to this type from the input type.

impl From<LuaEquipmentPrototype> for EquipmentWithQualityID

fn from(value: LuaEquipmentPrototype) -> Self

Converts to this type from the input type.

impl From<LuaEquipmentPrototype> for PipetteID

fn from(value: LuaEquipmentPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaEquipmentPrototype

impl PartialEq for LuaEquipmentPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaEquipmentPrototype