Scenario Train Series Cancellations
Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers
Trains may be prevented from appearing during a specific time. To do this, use the CancelTrain tag inside the Consists tag.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_DUISBURG-WEDAU_0" /> </Consists>
Note: this feature is similar to Series Exclusions. Unlike Exclusions, Cancellations remove the item from the schedule completely. With Exclusions, trains will appear in the Train Overview but will not spawn. With Cancellations, trains will not appear in the Train Overview at all.
The attributes for each cancellation are as follows:
- EntryPoint
- (optional)
- the spawn track from which trains spawn, eg., SPAWN_NEIGHBOUR_0.
- when omitted, any train matches.
- ExitPoint
- (optional)
- the End_NX value in the timetable where the train is destined.
- when omitted, any train matches.
- Series
- (optional)
- the pattern that defines the train or train series.
- use 'X's to define train series (example: "7XXX" matches 7123, 7001, 7892, and so on. "8XX" matches 800, 899, and so on.)
- use the exact train ID to exclude only that train (example: "7123" matches only train 7123.)
- when omitted, any train matches.
- startTime
- (optional)
- time (HH:mm:ss)
- when omitted, there is no lower bound (that is, cancellations can occur as soon as simulation starts)
- endTime
- (optional)
- time (HH:mm:ss)
- when omitted, there is no upper bound (that is, cancellations can occur right to the end of the simulation, however long that may be)
Examples
In the example below, all trains spawning from SPAWN_NEIGHBOUR_0 and destined for XYZ will be cancelled.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_NEIGHBOUR_0" ExitPoint="XYZ" /> </Consists>
In the example below, only the 82000 series trains spawning from SPAWN_NEIGHBOUR_0 and destined for XYZ will be cancelled.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_NEIGHBOUR_0" ExitPoint="XYZ" Series="82XXX"/> </Consists>
In the example below, only the 82000 series trains spawning from SPAWN_NEIGHBOUR_0 and destined for XYZ appearing after 11:45 will be cancelled.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_NEIGHBOUR_0" Series="82XXX" startTime="11:45:00"/> </Consists>
In the example below, only the 82000 series trains spawning from SPAWN_NEIGHBOUR_0 and destined for XYZ appearing between 11:45 and 15:15 will be cancelled.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_NEIGHBOUR_0" ExitPoint="XYZ" Series="82XXX" startTime="11:45:00" endTime="15:15:00" /> </Consists>
In the example below, all trains spawning from SPAWN_NEIGHBOUR_0 appearing between 11:45 and 15:15 will be cancelled.
<Consists loadFromTimetable="true"> <CancelTrain EntryPoint="SPAWN_NEIGHBOUR_0" ExitPoint="XYZ" Series="82XXX" startTime="11:45:00" endTime="15:15:00" /> </Consists>
Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers