Struct LuaTrainStopControlBehavior 

pub struct LuaTrainStopControlBehavior;

Control behavior for train stops.

Implementations

impl LuaTrainStopControlBehavior

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

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

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

The concrete type of this control behavior.

pub fn circuit_condition(&self) -> CircuitConditionDefinition

The circuit condition. Writing nil clears the circuit condition.

pub fn set_circuit_condition(&self, value: CircuitConditionDefinition)

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

The circuit condition. Writing nil clears the circuit condition.

pub fn circuit_enable_disable(&self) -> bool

true if this entity enable/disable state is controlled by circuit condition

pub fn set_circuit_enable_disable(&self, value: bool)

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

true if this entity enable/disable state is controlled by circuit condition

pub fn connect_to_logistic_network(&self) -> bool

true if this should connect to the logistic network.

pub fn set_connect_to_logistic_network(&self, value: bool)

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

true if this should connect to the logistic network.

pub fn disabled(&self) -> bool

If the entity is currently disabled because of the control behavior.

pub fn logistic_condition(&self) -> CircuitConditionDefinition

The logistic condition. Writing nil clears the logistic condition.

pub fn set_logistic_condition(&self, value: CircuitConditionDefinition)

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

The logistic condition. Writing nil clears the logistic condition.

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

The signal to be used by set-priority change priority of the train stop

pub fn set_priority_signal(&self, value: SignalID)

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

The signal to be used by set-priority change priority of the train stop

pub fn read_from_train(&self) -> bool

true if the train stop should send the train contents to the circuit network.

pub fn set_read_from_train(&self, value: bool)

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

true if the train stop should send the train contents to the circuit network.

pub fn read_stopped_train(&self) -> bool

true if the train stop should send the stopped train id to the circuit network.

pub fn set_read_stopped_train(&self, value: bool)

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

true if the train stop should send the stopped train id to the circuit network.

pub fn read_trains_count(&self) -> bool

true if the train stop should send amount of incoming trains to the circuit network.

pub fn set_read_trains_count(&self, value: bool)

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

true if the train stop should send amount of incoming trains to the circuit network.

pub fn send_to_train(&self) -> bool

true if the train stop should send the circuit network contents to the train to use.

pub fn set_send_to_train(&self, value: bool)

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

true if the train stop should send the circuit network contents to the train to use.

pub fn set_priority(&self) -> bool

true if the priority_signal is used to set a priority of the train stop.

pub fn set_set_priority(&self, value: bool)

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

true if the priority_signal is used to set a priority of the train stop.

pub fn set_trains_limit(&self) -> bool

true if the trains_limit_signal is used to set a limit of trains incoming for train stop.

pub fn set_set_trains_limit(&self, value: bool)

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

true if the trains_limit_signal is used to set a limit of trains incoming for train stop.

pub fn stopped_train_signal(&self) -> SignalID

The signal that will be sent when using the send-train-id option.

pub fn set_stopped_train_signal(&self, value: SignalID)

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

The signal that will be sent when using the send-train-id option.

pub fn trains_count_signal(&self) -> SignalID

The signal that will be sent when using the read-trains-count option.

pub fn set_trains_count_signal(&self, value: SignalID)

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

The signal that will be sent when using the read-trains-count option.

pub fn trains_limit_signal(&self) -> SignalID

The signal to be used by set-trains-limit to limit amount of incoming trains

pub fn set_trains_limit_signal(&self, value: SignalID)

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

The signal to be used by set-trains-limit to limit amount of incoming trains

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: &'static str, ) -> Option<LuaCircuitNetwork>

Trait Implementations

impl Clone for LuaTrainStopControlBehavior

fn clone(&self) -> LuaTrainStopControlBehavior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaTrainStopControlBehavior

impl Debug for LuaTrainStopControlBehavior

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

Formats the value using the given formatter.

impl Default for LuaTrainStopControlBehavior

fn default() -> LuaTrainStopControlBehavior

Returns the “default value” for a type.

impl Eq for LuaTrainStopControlBehavior

impl From<LuaTrainStopControlBehavior> for LuaAny

fn from(_: LuaTrainStopControlBehavior) -> Self

Converts to this type from the input type.

impl LuaObject for LuaTrainStopControlBehavior

impl PartialEq for LuaTrainStopControlBehavior

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaTrainStopControlBehavior