Factorio Runtime DocsVersion 2.0.28

When true, the train is explicitly controlled by the player or script. When false, the train moves autonomously according to its schedule.

Current speed.

Changing the speed of the train is potentially an unsafe operation because train uses the speed for its internal calculations of break distances, etc.

Current max speed when moving forward, depends on locomotive prototype and fuel.

Current max speed when moving backwards, depends on locomotive prototype and fuel.

The weight of this train.

The rolling stocks this train is composed of, with the numbering starting at the front of the train.

Locomotives of the train.

The cargo carriages the train contains.

The fluid carriages the train contains.

This train's current schedule, if any. Set to nil to clear.

The schedule can't be changed by modifying the returned table. Instead, changes must be made by assigning a new table to this attribute.

This train's current state.

The front stock of this train, if any. The front of the train is in the direction that a majority of locomotives are pointing in. If it's a tie, the North and West directions take precedence.

The back stock of this train, if any. The back of the train is at the opposite end of the front.

The train stop this train is stopped at, if any.

If this train has a path.

The destination rail this train is currently pathing to, if any.

The destination train stop this train is currently pathing to, if any.

The unique train ID.

The player passengers on the train

This does not index using player index. See LuaPlayer::index on each player instance for the player index.

The riding state of this train.

The players killed by this train.

The keys are the player indices, the values are how often this train killed that player.

The total number of kills by this train.

The path this train is using, if any.

The signal this train is arriving or waiting at, if any.

The group this train belongs to.

Setting the group will apply the schedule of the group to this train.

Front end of the train: Rail and direction on that rail where the train will go when moving forward

Back end of the train: Rail and direction on that rail where the train will go when moving backward

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.

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.