Struct LuaSurfacePropertyPrototype 

pub struct LuaSurfacePropertyPrototype;

Prototype of a surface property.

Implementations

impl LuaSurfacePropertyPrototype

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 default_value(&self) -> f64

pub fn is_time(&self) -> bool

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

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 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 LuaSurfacePropertyPrototype

fn clone(&self) -> LuaSurfacePropertyPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaSurfacePropertyPrototype

impl Debug for LuaSurfacePropertyPrototype

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

Formats the value using the given formatter.

impl Default for LuaSurfacePropertyPrototype

fn default() -> LuaSurfacePropertyPrototype

Returns the “default value” for a type.

impl Eq for LuaSurfacePropertyPrototype

impl From<LuaSurfacePropertyPrototype> for LuaAny

fn from(_: LuaSurfacePropertyPrototype) -> Self

Converts to this type from the input type.

impl From<LuaSurfacePropertyPrototype> for SurfacePropertyID

fn from(value: LuaSurfacePropertyPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaSurfacePropertyPrototype

impl PartialEq for LuaSurfacePropertyPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaSurfacePropertyPrototype