Struct LuaVirtualSignalPrototype 

pub struct LuaVirtualSignalPrototype;

Prototype of a virtual signal.

Implementations

impl LuaVirtualSignalPrototype

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 factoriopedia_alternative(&self) -> LuaVirtualSignalPrototype

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

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

Whether this is a special signal. The everything, anything, each, and unknown signals are considered special.

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 LuaVirtualSignalPrototype

fn clone(&self) -> LuaVirtualSignalPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaVirtualSignalPrototype

impl Debug for LuaVirtualSignalPrototype

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

Formats the value using the given formatter.

impl Default for LuaVirtualSignalPrototype

fn default() -> LuaVirtualSignalPrototype

Returns the “default value” for a type.

impl Eq for LuaVirtualSignalPrototype

impl From<LuaVirtualSignalPrototype> for LuaAny

fn from(_: LuaVirtualSignalPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaVirtualSignalPrototype

impl PartialEq for LuaVirtualSignalPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaVirtualSignalPrototype