Struct LuaFluidPrototype 

pub struct LuaFluidPrototype;

Prototype of a fluid.

Implementations

impl LuaFluidPrototype

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

Extra description items in the tooltip and Factoriopedia.

pub fn factoriopedia_description(&self) -> &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) -> &str

pub fn localised_name(&self) -> &str

pub fn name(&self) -> &str

Name of this prototype.

pub fn order(&self) -> &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) -> &str

Type of this prototype.

pub fn base_color(&self) -> Color

pub fn default_temperature(&self) -> f64

Default temperature of this fluid.

pub fn emissions_multiplier(&self) -> f64

A multiplier on the amount of emissions produced when this fluid is burnt in a generator. A value above 1.0 increases emissions and vice versa. The multiplier can’t be negative.

pub fn factoriopedia_alternative(&self) -> LuaFluidPrototype

An alternative prototype that will be used to display info about this prototype in Factoriopedia.

pub fn flow_color(&self) -> Color

pub fn fuel_value(&self) -> f64

The amount of energy in Joules one unit of this fluid will produce when burnt in a generator. A value of 0 means this fluid can’t be used for energy generation. The value can’t be negative.

pub fn gas_temperature(&self) -> f64

The temperature above which this fluid will be shown as gaseous inside tanks and pipes.

pub fn heat_capacity(&self) -> f64

The amount of energy in Joules required to heat one unit of this fluid by 1°C.

pub fn max_temperature(&self) -> f64

Maximum temperature this fluid can reach.

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 spent_fluid(&self) -> SpentFluidSpecification

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 visualization_color(&self) -> Color

Trait Implementations

impl Clone for LuaFluidPrototype

fn clone(&self) -> LuaFluidPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaFluidPrototype

impl Debug for LuaFluidPrototype

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

Formats the value using the given formatter.

impl Default for LuaFluidPrototype

fn default() -> LuaFluidPrototype

Returns the “default value” for a type.

impl Eq for LuaFluidPrototype

impl From<LuaFluidPrototype> for LuaAny

fn from(_: LuaFluidPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaFluidPrototype

impl PartialEq for LuaFluidPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaFluidPrototype