LuaTrain

A train. Trains are a sequence of connected rolling stocks -- locomotives and wagons.

Attributes

manual_mode

• Read: boolean
• Write: boolean
• Optional: false

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

speed

• Read: double
• Write: double
• Optional: false

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.

max_forward_speed

• Read: double
• Write: unknown
• Optional: false

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

max_backward_speed

• Read: double
• Write: unknown
• Optional: false

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

weight

• Read: double
• Write: unknown
• Optional: false

The weight of this train.

carriages

• Read: Array<LuaEntity>
• Write: unknown
• Optional: false

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

locomotives

• Read: { back_movers: Array<LuaEntity>, front_movers: Array<LuaEntity> }
• Write: unknown
• Optional: false

Locomotives of the train.

cargo_wagons

• Read: Array<LuaEntity>
• Write: unknown
• Optional: false

The cargo carriages the train contains.

fluid_wagons

• Read: Array<LuaEntity>
• Write: unknown
• Optional: false

The fluid carriages the train contains.

schedule

• Read: TrainSchedule
• Write: TrainSchedule
• Optional: true

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.

state

• Read: defines.train_state
• Write: unknown
• Optional: false

This train's current state.

front_stock

• Read: LuaEntity
• Write: unknown
• Optional: true

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.

back_stock

• Read: LuaEntity
• Write: unknown
• Optional: true

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

station

• Read: LuaEntity
• Write: unknown
• Optional: true

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

has_path

• Read: boolean
• Write: unknown
• Optional: false

If this train has a path.

path_end_rail

• Read: LuaEntity
• Write: unknown
• Optional: true

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

path_end_stop

• Read: LuaEntity
• Write: unknown
• Optional: true

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

id

• Read: uint32
• Write: unknown
• Optional: false

The unique train ID.

passengers

• Read: Array<LuaPlayer>
• Write: unknown
• Optional: false

The player passengers on the train

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

riding_state

• Read: RidingState
• Write: unknown
• Optional: false

The riding state of this train.

killed_players

• Read: Dict<uint32, uint32>
• Write: unknown
• Optional: false

The players killed by this train.

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

kill_count

• Read: uint32
• Write: unknown
• Optional: false

The total number of kills by this train.

path

• Read: LuaRailPath
• Write: unknown
• Optional: true

The path this train is using, if any.

signal

• Read: LuaEntity
• Write: unknown
• Optional: true

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

group

• Read: string
• Write: string
• Optional: false

The group this train belongs to.

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

front_end

• Read: LuaRailEnd
• Write: unknown
• Optional: false

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

back_end

• Read: LuaRailEnd
• Write: unknown
• Optional: false

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

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.

Methods

get_item_count

LuaTrain.get_item_count(item?: ItemFilter) -> uint32

Call As

train.get_item_count()

Call Convention

• takes_table: false
• table_optional: false

Get the amount of a particular item stored in the train.

Parameters

• item?: ItemFilter — If not given, counts all items.

Returns

• uint32

get_contents

LuaTrain.get_contents() -> ItemWithQualityCounts

Call As

train.get_contents()

Call Convention

• takes_table: false
• table_optional: false

Get a mapping of the train's inventory.

Returns

• ItemWithQualityCounts — List of all items in the train.

remove_item

LuaTrain.remove_item(stack: ItemStackIdentification) -> uint32

Call As

train.remove_item(stack)

Call Convention

• takes_table: false
• table_optional: false

Remove some items from the train.

Parameters

• stack: ItemStackIdentification — The amount and type of items to remove

Returns

• uint32 — Number of items actually removed.

insert

LuaTrain.insert(stack: ItemStackIdentification)

Call As

train.insert(stack)

Call Convention

• takes_table: false
• table_optional: false

Insert a stack into the train.

Parameters

• stack: ItemStackIdentification

clear_items_inside

LuaTrain.clear_items_inside()

Call As

train.clear_items_inside()

Call Convention

• takes_table: false
• table_optional: false

Clear all items in this train.

recalculate_path

LuaTrain.recalculate_path(force?: boolean) -> boolean

Call As

train.recalculate_path()

Call Convention

• takes_table: false
• table_optional: false

Checks if the path is invalid and tries to re-path if it isn't.

Parameters

• force?: boolean — Forces the train to re-path regardless of the current path being valid or not.

Returns

• boolean — If the train has a path after the repath attempt.

get_fluid_count

LuaTrain.get_fluid_count(fluid?: string) -> double

Call As

train.get_fluid_count()

Call Convention

• takes_table: false
• table_optional: false

Get the amount of a particular fluid stored in the train.

Parameters

• fluid?: string — Fluid name to count. If not given, counts all fluids.

Returns

• double

get_fluid_contents

LuaTrain.get_fluid_contents() -> Dict<string, FluidAmount>

Call As

train.get_fluid_contents()

Call Convention

• takes_table: false
• table_optional: false

Gets a mapping of the train's fluid inventory.

Returns

• Dict<string, FluidAmount> — The counts, indexed by fluid names.

remove_fluid

LuaTrain.remove_fluid(fluid: Fluid) -> double

Call As

train.remove_fluid(fluid)

Call Convention

• takes_table: false
• table_optional: false

Remove some fluid from the train.

Parameters

• fluid: Fluid

Returns

• double — The amount of fluid actually removed.

insert_fluid

LuaTrain.insert_fluid(fluid: Fluid) -> double

Call As

train.insert_fluid(fluid)

Call Convention

• takes_table: false
• table_optional: false

Inserts the given fluid into the first available location in this train.

Parameters

• fluid: Fluid

Returns

• double — The amount inserted.

clear_fluids_inside

LuaTrain.clear_fluids_inside()

Call As

train.clear_fluids_inside()

Call Convention

• takes_table: false
• table_optional: false

Clears all fluids in this train.

go_to_station

LuaTrain.go_to_station(index: uint32)

Call As

train.go_to_station(index)

Call Convention

• takes_table: false
• table_optional: false

Go to the station specified by the index in the train's schedule.

Parameters

• index: uint32

get_rails

LuaTrain.get_rails() -> Array<LuaEntity>

Call As

train.get_rails()

Call Convention

• takes_table: false
• table_optional: false

Gets all rails under the train.

Returns

• Array<LuaEntity>

get_rail_end

LuaTrain.get_rail_end(direction: defines.rail_direction) -> LuaRailEnd

Call As

train.get_rail_end(direction)

Call Convention

• takes_table: false
• table_optional: false

Gets a LuaRailEnd object pointing away from the train at specified end of the train

Parameters

• direction: defines.rail_direction

Returns

• LuaRailEnd

get_schedule

LuaTrain.get_schedule() -> LuaSchedule

Call As

train.get_schedule()

Call Convention

• takes_table: false
• table_optional: false

Returns

• LuaSchedule