Struct LuaRailSignalBaseControlBehavior

Source

pub struct LuaRailSignalBaseControlBehavior;

Expand description

Control behavior for rail signals and rail chain signals.

Implementations§

Source §

impl LuaRailSignalBaseControlBehavior

Source

pub fn entity(&self) -> LuaEntity

The entity this control behavior belongs to.

Source

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.

Source

pub fn set_input_networks(&self, value: CircuitNetworkSelection)

Set the input_networks attribute (Lua: self.input_networks = value).

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.

Source

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.

Source

pub fn set_output_networks(&self, value: CircuitNetworkSelection)

Set the output_networks attribute (Lua: self.output_networks = value).

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.

Source

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

The concrete type of this control behavior.

Source

pub fn blue_signal(&self) -> SignalID

Source

pub fn set_blue_signal(&self, value: SignalID)

Set the blue_signal attribute (Lua: self.blue_signal = value).

Source

pub fn circuit_condition(&self) -> CircuitConditionDefinition

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

Source

pub fn set_circuit_condition(&self, value: CircuitConditionDefinition)

Set the circuit_condition attribute (Lua: self.circuit_condition = value).

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

Source

pub fn close_signal(&self) -> bool

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

Source

pub fn set_close_signal(&self, value: bool)

Set the close_signal attribute (Lua: self.close_signal = value).

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

Source

pub fn green_signal(&self) -> SignalID

Source

pub fn set_green_signal(&self, value: SignalID)

Set the green_signal attribute (Lua: self.green_signal = value).

Source

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.

Source

pub fn orange_signal(&self) -> SignalID

Source

pub fn set_orange_signal(&self, value: SignalID)

Set the orange_signal attribute (Lua: self.orange_signal = value).

Source

pub fn read_signal(&self) -> bool

If this will read the rail signal state.

Source

pub fn set_read_signal(&self, value: bool)

Set the read_signal attribute (Lua: self.read_signal = value).

If this will read the rail signal state.

Source

pub fn red_signal(&self) -> SignalID

Source

pub fn set_red_signal(&self, value: SignalID)

Set the red_signal attribute (Lua: self.red_signal = value).

Source

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.

Source