Struct LuaRailSignalBaseControlBehavior 

pub struct LuaRailSignalBaseControlBehavior;

Control behavior for rail signals and rail chain signals.

Implementations

impl LuaRailSignalBaseControlBehavior

pub fn entity(&self) -> LuaEntity

The entity this control behavior belongs to.

pub fn input_networks(&self) -> CircuitNetworkSelection

Which circuit networks (red/green) to read signals from. Defaults to both wire colors.

nil if this control behavior does not allow selecting the input networks.

pub fn output_networks(&self) -> CircuitNetworkSelection

Which circuit networks (red/green) to send signals to. Defaults to both wire colors.

nil if this control behavior does not allow selecting the output networks.

pub fn type(&self) -> &str

The concrete type of this control behavior.

pub fn blue_signal(&self) -> SignalID

pub fn circuit_condition(&self) -> CircuitConditionDefinition

The circuit condition when controlling the signal through the circuit network.

pub fn close_signal(&self) -> bool

If this will close the rail signal based off the circuit condition.

pub fn green_signal(&self) -> SignalID

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 orange_signal(&self) -> SignalID

pub fn read_signal(&self) -> bool

If this will read the rail signal state.

pub fn red_signal(&self) -> SignalID

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 get_circuit_network( &self, wire_connector_id: &str, ) -> Option<LuaCircuitNetwork>

Trait Implementations

impl Clone for LuaRailSignalBaseControlBehavior

fn clone(&self) -> LuaRailSignalBaseControlBehavior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaRailSignalBaseControlBehavior

impl Debug for LuaRailSignalBaseControlBehavior

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

Formats the value using the given formatter.

impl Default for LuaRailSignalBaseControlBehavior

fn default() -> LuaRailSignalBaseControlBehavior

Returns the “default value” for a type.

impl Eq for LuaRailSignalBaseControlBehavior

impl From<LuaRailSignalBaseControlBehavior> for LuaAny

fn from(_: LuaRailSignalBaseControlBehavior) -> Self

Converts to this type from the input type.

impl LuaObject for LuaRailSignalBaseControlBehavior

impl PartialEq for LuaRailSignalBaseControlBehavior

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaRailSignalBaseControlBehavior