Railroad Signal Block

A track section that combines the area between multiple signals.

Properties

blockValidation : Int

Returns the blocks validation status.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Block Validation

isBlockOccupied : Bool

True if the block this signal is observing is currently occupied by a vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Block Occupied

isPathBlock : Bool

True if the block this signal is observing is a path-block.

Details
Flags RuntimeSync RuntimeParallel

Display Name

Is Path Block

isValid : Bool

Is true if this signal block reference is valid.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Valid

Functions

getApprovedReservations () → reservations : Array<Trace<Train>>

Returns a list of trains that are approved by this block.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Approved Reservations
Return Values
Name Type Description

Reservations reservations

Array<Trace<Train>>

A list of trains that are approved by this block.

getOccupation () → occupation : Array<Trace<Train>>

Returns a list of trains that currently occupate the block.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Occupation
Return Values
Name Type Description

Occupation occupation

Array<Trace<Train>>

A list of trains occupying the block.

getQueuedReservations () → reservations : Array<Trace<Train>>

Returns a list of trains that try to reserve this block and wait for approval.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Queued Reservations
Return Values
Name Type Description

Reservations reservations

Array<Trace<Train>>

A list of trains that try to reserve this block and wait for approval.

isOccupiedBy (train : Object<Train>) → isOccupied : Bool

Allows you to check if this block is occupied by a given train.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Is Occupied By
Parameters
Name Type Description

Train train

Object<Train>

The train you want to check if it occupies this block
Return Values
Name Type Description

Is Occupied isOccupied

Bool

True if the given train occupies this block.