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

# Factorio Runtime Docs Version 2.0.77

# LuaRailPath - Runtime Docs

## Class LuaRailPath

A rail path.

## Members

size | :: R uint32 | The total number of rails in this path.
The total number of rails in this path.
current | :: R uint32 | The current rail index.
The current rail index.
total_distance | :: R double | The total path distance.
The total path distance.
travelled_distance | :: R double | The total distance traveled.
The total distance traveled.
rails | :: R LuaCustomTable[uint32 → LuaEntity] | Array of the rails that this path travels over.
Array of the rails that this path travels over.
is_front | :: R boolean | If the path goes from the front of the train
If the path goes from the front of the train
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. [...]

## Attributes

### size :: Read uint32

The total number of rails in this path.

### current :: Read uint32

The current rail index.

### total_distance :: Read double

The total path distance.

### travelled_distance :: Read double

The total distance traveled.

### rails :: Read LuaCustomTable[uint32 → LuaEntity]

Array of the rails that this path travels over.

### is_front :: Read boolean

If the path goes from the front of the train

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

Class used in

- LuaTrain::path
- RegistrationTarget