LuaTrainStopControlBehavior - Runtime Docs

Version 1.1.75 / Runtime Docs / Classes / LuaTrainStopControlBehavior <>

Class LuaTrainStopControlBehavior extends LuaGenericOnOffControlBehavior

Control behavior for train stops.

Members

help()	→ string	All methods and properties that this object supports.
All methods and properties that this object supports.
send_to_train [RW]	:: boolean	`true` if the train stop should send the circuit network contents to the train to use.
`true` if the train stop should send the circuit network contents to the train to use.
read_from_train [RW]	:: boolean	`true` if the train stop should send the train contents to the circuit network.
`true` if the train stop should send the train contents to the circuit network.
read_stopped_train [RW]	:: boolean	`true` if the train stop should send the stopped train id to the circuit network.
`true` if the train stop should send the stopped train id to the circuit network.
set_trains_limit [RW]	:: boolean	`true` if the trains_limit_signal is used to set a limit of trains incoming for train stop.
`true` if the trains_limit_signal is used to set a limit of trains incoming for train stop.
read_trains_count [RW]	:: boolean	`true` if the train stop should send amount of incoming trains to the circuit network.
`true` if the train stop should send amount of incoming trains to the circuit network.
enable_disable [RW]	:: boolean	`true` if the train stop is enabled/disabled through the circuit network.
`true` if the train stop is enabled/disabled through the circuit network.
stopped_train_signal [RW]	:: SignalID	The signal that will be sent when using the send-train-id option.
The signal that will be sent when using the send-train-id option.
trains_count_signal [RW]	:: SignalID	The signal that will be sent when using the read-trains-count option.
The signal that will be sent when using the read-trains-count option.
trains_limit_signal [RW]	:: SignalID	The signal to be used by set-trains-limit to limit amount of incoming trains
The signal to be used by set-trains-limit to limit amount of incoming trains
valid [R]	:: boolean	Is this object valid?
Is this object valid?
object_name [R]	:: string	The class name of this object.
The class name of this object.

Inherited from LuaGenericOnOffControlBehavior: disabled, circuit_condition, logistic_condition, connect_to_logistic_network, valid, object_name, help
Inherited from LuaControlBehavior: type, entity, get_circuit_network

Methods

help() → string

All methods and properties that this object supports.

Attributes

send_to_train :: boolean Read/Write

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

read_from_train :: boolean Read/Write

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

read_stopped_train :: boolean Read/Write

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

set_trains_limit :: boolean Read/Write

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

read_trains_count :: boolean Read/Write

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

enable_disable :: boolean Read/Write

true if the train stop is enabled/disabled through the circuit network.

stopped_train_signal :: SignalID Read/Write

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

trains_count_signal :: SignalID Read/Write

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

trains_limit_signal :: SignalID Read/Write

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

valid :: boolean Read

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.

object_name :: string Read

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.

Factorio Runtime Docs