Skip to main content

LuaBurnerPrototype

Struct LuaBurnerPrototype 

Source
pub struct LuaBurnerPrototype;
Expand description

Prototype of a burner energy source.

Implementations§

Source§

impl LuaBurnerPrototype

Source

pub fn auto_refuel(&self) -> bool

Source

pub fn burnt_inventory_size(&self) -> u32

Source

pub fn effectivity(&self) -> f64

Source

pub fn emissions_per_joule(&self) -> HashMap<String, f64>

The table of emissions of this energy source in pollution/Joule, indexed by pollutant type. Multiplying it by energy consumption in Watt gives pollution/second.

Source

pub fn fuel_categories(&self) -> HashMap<String, bool>

The value in the dictionary is meaningless and exists just to allow for easy lookup.

Source

pub fn fuel_inventory_size(&self) -> u32

Source

pub fn initial_fuel(&self) -> LuaItemPrototype

Source

pub fn initial_fuel_percent(&self) -> f64

Source

pub fn light_flicker(&self) -> LuaBurnerPrototypeLightFlicker

The light flicker definition for this burner prototype.

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 render_no_network_icon(&self) -> bool

Source

pub fn render_no_power_icon(&self) -> bool

Source

pub fn smoke(&self) -> Vec<SmokeSource>

The smoke sources for this burner prototype.

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.

Trait Implementations§

Source§

impl Clone for LuaBurnerPrototype

Source§

fn clone(&self) -> LuaBurnerPrototype

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 LuaBurnerPrototype

Source§

impl Debug for LuaBurnerPrototype

Source§

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

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

impl Default for LuaBurnerPrototype

Source§

fn default() -> LuaBurnerPrototype

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

impl Eq for LuaBurnerPrototype

Source§

impl From<LuaBurnerPrototype> for LuaAny

Source§

fn from(_: LuaBurnerPrototype) -> Self

Converts to this type from the input type.
Source§

impl LuaObject for LuaBurnerPrototype

Source§

impl PartialEq for LuaBurnerPrototype

Source§

fn eq(&self, other: &LuaBurnerPrototype) -> 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 LuaBurnerPrototype

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.