Railroad Signal

Parent

A train signal to control trains on a track.

Properties

aspect : Int

The aspect of the signal. The aspect shows if a train is allowed to pass (clear) or not and if it should dock. 0 = Unknown 1 = The track is clear and the train is allowed to pass. 2 = The next track is Occupied and the train should stop 3 = The train should dock.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Aspect

blockValidation : Int

Any error states of the block. 0 = Unknown 1 = No Error 2 = No Exit Signal 3 = Contains Loop 4 = Contains Mixed Entry Signals

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Block Validation

hasObservedBlock : Bool

True if this signal is currently observing at least one block.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Has Observed Block

isBiDirectional : Bool

True if this signal is bi-directional. (trains can pass into both directions)

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Bi-Directional

isPathSignal : Bool

True if this signal is a path-signal.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Path Signal

Functions

getGuardedConnnections () → guardedConnections : Array<Trace<RailroadTrackConnection>>

Returns a list of the guarded connections. (incoming connections)

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Guarded Connections

Return Values
Name Type Description

GuardedConnections guardedConnections

Array<Trace<RailroadTrackConnection>>

The guarded connections.

getObservedBlock () → block : Struct<RailroadSignalBlock>

Returns the track block this signals observes.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Observed Block

Return Values
Name Type Description

Block block

Struct<RailroadSignalBlock>

The railroad signal block this signal is observing.

getObservedConnections () → observedConnections : Array<Trace<RailroadTrackConnection>>

Returns a list of the observed connections. (outgoing connections)

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Observed Connections

Return Values
Name Type Description

ObservedConnections observedConnections

Array<Trace<RailroadTrackConnection>>

The observed connections.

Signals

AspectChanged (Int Aspect aspect)

Triggers when the aspect of this signal changes.

Details
Parameters
Name Type Description

Aspect aspect

Int

The new aspect of the signal (see 'Get Aspect' for more information)

ValidationChanged (Int Validation validation)

Triggers when the validation of this signal changes.

Details
Parameters
Name Type Description

Validation validation

Int

The new validation of the signal (see 'Block Validation' for more information)