Struct LuaActiveTriggerPrototype 

pub struct LuaActiveTriggerPrototype;

Prototype of an Active Trigger.

Implementations

impl LuaActiveTriggerPrototype

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

The chance that a new fork will spawn after each jump [0,1]. default = 0.

pub fn jump_delay_ticks(&self) -> u32

The tick delay between each jump. 0 = all jumps instantaneous. default = 0.

pub fn max_forks(&self) -> u32

maximum number of forks allowed to spawn for the entire chain. default = infinity.

pub fn max_forks_per_jump(&self) -> u32

The maximum number of forks that can spawn from a single jump. default = 1.

pub fn max_jumps(&self) -> u32

The max number of jumps per trigger. default = 5.

pub fn max_range(&self) -> f64

The max distance jumps are allowed to travel away from the original target. default = infinity.

pub fn max_range_per_jump(&self) -> f64

The max length of jumps. default = 5.

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

fn clone(&self) -> LuaActiveTriggerPrototype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaActiveTriggerPrototype

impl Debug for LuaActiveTriggerPrototype

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

Formats the value using the given formatter.

impl Default for LuaActiveTriggerPrototype

fn default() -> LuaActiveTriggerPrototype

Returns the “default value” for a type.

impl Eq for LuaActiveTriggerPrototype

impl From<LuaActiveTriggerPrototype> for LuaAny

fn from(_: LuaActiveTriggerPrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaActiveTriggerPrototype

impl PartialEq for LuaActiveTriggerPrototype

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaActiveTriggerPrototype