Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaTrainStopControlBehavior - Runtime Docs

## Class LuaTrainStopControlBehavior extends LuaGenericOnOffControlBehavior

Control behavior for train stops.

Inherits from LuaGenericOnOffControlBehavior « LuaControlBehavior

## Members

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.
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
set_priority | :: RW boolean | `true` if the priority_signal is used to set a priority of the train stop.
`true` if the priority_signal is used to set a priority of the train stop.
priority_signal | :: RW SignalID? | The signal to be used by set-priority change priority of the train stop
The signal to be used by set-priority change priority of the train stop
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 | :: R boolean | If the entity is currently disabled because of the control behavior.
If the entity is currently disabled because of the control behavior.
circuit_enable_disable | :: RW boolean | `true` if this entity enable/disable state is controlled by circuit condition
`true` if this entity enable/disable state is controlled by circuit condition
circuit_condition | :: RW CircuitConditionDefinition? | The circuit condition. [...]
The circuit condition. [...]
connect_to_logistic_network | :: RW boolean | `true` if this should connect to the logistic network.
`true` if this should connect to the logistic network.
logistic_condition | :: RW CircuitConditionDefinition? | The logistic condition. [...]
The logistic condition. [...]

Inherited from LuaControlBehavior

get_circuit_network(wire_connector_id) | → LuaCircuitNetwork? |
type | :: R defines.control_behavior.type | The concrete type of this control behavior.
The concrete type of this control behavior.
entity | :: R LuaEntity | The entity this control behavior belongs to.
The entity this control behavior belongs to.

## Attributes

### send_to_train :: Read|Write boolean

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

### read_from_train :: Read|Write boolean

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

### read_stopped_train :: Read|Write boolean

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

### set_trains_limit :: Read|Write boolean

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

### read_trains_count :: Read|Write boolean

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

### stopped_train_signal :: Read|Write SignalID?

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

### trains_count_signal :: Read|Write SignalID?

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

### trains_limit_signal :: Read|Write SignalID?

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

### set_priority :: Read|Write boolean

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

### priority_signal :: Read|Write SignalID?

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

### valid :: Read boolean

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 :: Read string

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.