Train Platform

Parent

Factory

The base class for all train station parts.

Properties

isReversed : Bool

True if the orientation of the platform is reversed relative to the track/station.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Reversed

status : Int

The current docking status of the platform.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Status

Functions

getConnectedPlatform (platformConnection : Object<TrainPlatformConnection>) → oppositeConnection : Trace<TrainPlatformConnection>

Returns the connected platform in the given direction.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Connected Platform
Parameters
Name Type Description

Platform Connection platformConnection

Object<TrainPlatformConnection>

The platform connection of which you want to find the opposite connection of.
Return Values
Name Type Description

Opposite Connection oppositeConnection

Trace<TrainPlatformConnection>

The platform connection at the opposite side.

getDockedLocomotive () → locomotive : Trace<RailroadVehicle>

Returns the currently docked locomotive at the train station.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Docked Locomotive
Return Values
Name Type Description

Locomotive locomotive

Trace<RailroadVehicle>

The currently docked locomotive at the train station.

getDockedVehicle () → vehicle : Trace<Vehicle>

Returns the currently docked vehicle.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Docked Vehicle
Return Values
Name Type Description

Vehicle vehicle

Trace<Vehicle>

The currently docked vehicle

getMaster () → master : Trace<RailroadVehicle>

Returns the master platform of this train station.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Master
Return Values
Name Type Description

Master master

Trace<RailroadVehicle>

The master platform of this train station.

getTrackGraph () → graph : Struct<TrackGraph>

Returns the track graph of which this platform is part of.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Track Graph
Return Values
Name Type Description

Graph graph

Struct<TrackGraph>

The track graph of which this platform is part of.

getTrackPos () → (track : Trace<RailroadTrack>, offset : Float, forward : Float)

Returns the track pos at which this train platform is placed.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Track Pos
Return Values
Name Type Description

Track track

Trace<RailroadTrack>

The track the track pos points to.

Offset offset

Float

The offset of the track pos.

Forward forward

Float

The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction

getAllConnectedPlatforms () → platforms : Array<Trace<TrainPlatformConnection>>

Returns a list of all connected platforms in order.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get all connected Platforms
Return Values
Name Type Description

Platforms platforms

Array<Trace<TrainPlatformConnection>>

The list of connected platforms