LuaRailPath - Runtime Docs

Version 1.1.76 / Runtime Docs / Classes / LuaRailPath <>

Class LuaRailPath

A rail path.

Members

help()	→ string	All methods and properties that this object supports.
All methods and properties that this object supports.
size [R]	:: uint	The total number of rails in this path.
The total number of rails in this path.
current [R]	:: uint	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 travelled.
The total distance travelled.
rails [R]	:: LuaCustomTable[uint → 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.

Methods

help() → string

All methods and properties that this object supports.

Attributes

size :: uint Read

The total number of rails in this path.

current :: uint Read

The current rail index.

total_distance :: double Read

The total path distance.

travelled_distance :: double Read

The total distance travelled.

rails :: LuaCustomTable[uint → LuaEntity] Read

Array of the rails that this path travels over.

is_front :: boolean Read

If the path goes from the front of the train

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