Driver Commands List

From TrainzOnline
Revision as of 07:47, 21 July 2019 by Pware (talk | contribs)
Jump to navigationJump to search

Train Railroad Simulator 2019 (TRS19) and TRAINZ A New Era (TANE) SP3. List of Trainz Driver Commands. All commands are the Copyright of N3V Games

This page is always under construction. As new driver commands appear and are tested they will be added to this list. Current Command Count: 56

Only driver commands supplied with TRS19/TANE or on the DLS are covered in this document.

The driver commands listed in this page are all found in Trainz Surveyor from the Edit Session option in the Main Menu and are accessed by the  Driver Command Rule and the  Driver Setup Rule.

See the Trainz Wiki Page  How to Use the Driver Setup Rule for more information on both rules.

Those commands that are identified as a DLS Command must be downloaded and installed from the Trainz DLS first.

Description Key:

  • <kuid number> is for the command version at the time of writing. This number will change if the command is updated.
  • DLS Command must be downloaded and installed from the DLS.
  • Base Command and Built-in Command are installed with TRS19/TANE.
  • Obsolete Command is no longer required (explanation given).
  • Legacy Command has been replaced by another command (new command will be identified).
  • SP2 and later means TANE SP2 and later versions including TRS19.

Interlocking Tower and Mission Code Commands


AddMissionCode (SP2 and Later)

Adds a mission code (a sequence of IT or EIT paths) to any mission codes already loaded for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later)

Command Properties:

  • <kuid2:61392:8203:56> AddMissionCode (SP2 and later)
  • DLS Command by pguy

Command Settings: 

  <mission codes> - select a mission code from the Session list

Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

Related Commands:

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


IT CancelEnhancedPath
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Cancels an active Enhanced Interlocking Tower (EIT) path for the train that had been set by the IT SetPath Command

Command Properties:

  • <kuid2:61392:8114:54> IT CancelEnhancedPath
  • DLS Command by pguy

Command Settings: 

  <Select EIT> - select from list of session EITs
     <Select Path> - select the active path from that EIT

Notes:

  1. The active path must be created using Enhanced Interlocking Towers
  2. Cancelling a path makes it available for other consists and allows conflicting paths to be made active
  3. An active path is automatically cancelled after it has been completed by a train

Related Commands:


IT SetPath
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs). If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Command Properties:

  • <kuid2:61392:8111:54> IT SetPath
  • DLS Command by pguy

Command Settings: 

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

Related Commands:


IT SetPathAndWaitActive
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the path becomes active. If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Command Properties:

  • <kuid2:61392:8113:54> IT SetPathAndWaitActive
  • DLS Command by pguy

Command Settings: 

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

Related Commands:


IT SetPathAndWaitNotRed
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the next signal is not showing red. If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Command Properties:

  • <kuid2:61392:8112:54> IT SetPathAndWaitNotRed
  • DLS Command by pguy

Command Settings: 

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

Related Commands:


RemoveMissionCode (SP2 and Later)

Removes a mission code (a sequence of IT or EIT paths) from any mission codes already loaded for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later) and given to the driver by the SetMissionCode (SP2 and later) or AddMissionCode (SP2 and Later) driver commands or by the Mission Code Manager Rule (SP2 and Later) itself

Command Properties:

  • <kuid2:61392:8204:56> RemoveMissionCode (SP2 and later)
  • DLS Command by pguy

Command Settings: 

  <mission codes> - select a mission code from the Session list

Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

Related Commands:

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


SetMissionCode (SP2 and Later)

Sets a mission code (a sequence of IT or EIT paths) for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later). Mission codes can also be given to trains in Surveyor or Driver mode through the Mission Code Manager Rule (SP2 and Later)

Command Properties:

  • <kuid2:61392:8201:56> SetMissionCode (SP2 and later)
  • DLS Command by pguy

Command Settings: 

  <*Reset mission code> - resets the currently loaded mission code, or
  <mission codes> - select a mission code from the Session list

Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

Related Commands:

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Back to Top

Junction and Signal Commands


ControlJunction
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Sets the direction for a single specified junction switch.

Command Properties:

  • <kuid:131986:1011> ControlJunction
  • DLS Command by atilabarut

Command Settings: 

  Select switch direction, one of <LEFT/RIGHT/FORWARD>
     Select <switch name> from the session list

Related Commands:

  • SetOneJunction - sets the direction for a single specified junction switch


SetOneJunction
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Sets the direction for a single specified junction switch.

Command Properties:

  • <kuid:121843:100445> SetOneJunction
  • DLS Command by pitkin

Command Settings: 

  Select <switch name> from the session list
     Select switch direction, one of <LEFT/RIGHT/FORWARD/BACKWARD>

Related Commands:

  • ControlJunction - sets the direction for a single specified junction switch


Set Signal Ahead
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Sets the state of the next signal ahead.

Command Properties:

  • <kuid2:368725:60003:6> Set Signal Ahead
  • DLS Command by elstoko

Command Settings: 

  <Set next signal to> - select one from
     <Stop>
     <Caution Straight>
     <Caution Left>
     <Caution Right>
     <Proceed Straight>
     <Proceed Left>
     <Proceed Right>
     <Advance Caution>
     <Call on 1 (State 9)>
     <Call on 2 (State 10)>
     <Automatic>

Notes:

  1. This command only works on signals that will respond to the function "SetSignalStateEx", not all signals will respond
  2. The signal must support the selected state otherwise there will be no change
  3. The signal will be reset after the train has cleared the signal


Back to Top

Load and Unload Commands


Instant Load
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instantly loads all rolling stock (except locos and tenders) in the train with the item(s) in their commodity queues.

Command Properties:

  • <kuid2:45324:555017:7> Instant Load Command
  • DLS Command by norfolksouthern37

Command Settings: 

None


InstantLoadLocos
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instantly loads all locos and tenders in the train with the item(s) in their commodity queues (coal, water, diesel fuel).

Command Properties:

  • <kuid2:117290:1022:1> InstantLoadLocos
  • Built-in Command by nzhorse

Command Settings: 

None


InstantUnLoad
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instantly unloads the commodities in all rolling stock (except locos and tenders) in the train.

Command Properties:

  • <kuid2:67585:1021:2> InstantUnload
  • DLS Command by robin_hoods

Command Settings: 

None


Load
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to load the commodity or commodities waiting at an industry enabled asset into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Load command is also used for loading (and unloading) passengers at passenger enabled stations.

Command Properties:

  • <kuid:-3:10076> Load
  • Base Command

Command Settings: 

None

Notes:

  1. If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
  2. With passenger enabled stations the Load command will first execute an Unload command to unload some of the passengers.


Load At
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Combines the Drive To and Load commands. Instructs the AI driver to drive to an industry (or passenger enabled station) and load the commodity or commodities waiting there into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Load At command is also used for loading (and unloading) passengers at passenger enabled stations. All signals and speed signs are obeyed during the "Drive To" operation.

Command Properties:

  • <kuid2:75377:84:1> Load At
  • DLS Command by stagecoach

Command Settings: 

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes:

  1. The AI driver will select the shortest available path to the destination.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  3. If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
  4. With passenger enabled stations the Load command will first execute an Unload command to unload some of the passengers.

Related Commands:

  • Drive To - drives to an industry but does not seek alternative paths if blocked
  • Load - loads commodities at an industry (including a station)


Terminate Passenger Train
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 An Unload command for passenger trains arriving at a terminal station. The train will be emptied of passengers.

Command Properties:

  • <kuid2:116387:16:2> Terminate Passenger Train
  • Built-in Command by maggs

Command Settings: 

None

Notes:

  1. Issue a Drive To command (or similar) to the station before using this command. The station must be industry active.


Unload
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to unload the commodity or commodities loaded in rolling stock assets to the industry enabled asset if it has been configured and is able to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Unload command is also used for unloading passengers at passenger enabled stations.

Command Properties:

  • <kuid:-3:10077> Unload
  • Base Command

Command Settings: 

None

Notes:

  1. If the industry where the unloading is taking place reaches its maximum capacity before all the wagons are fully unloaded, then any following wagons will not be unloaded until capacity is available again but the AI driver will not stop to wait.
  2. With passenger enabled stations the Unload command will unload a set number of passengers, specifically:-
  • Terminal stations = 100% of loaded passengers
  • Large stations = 50%
  • Standard stations = 25%
  • Small stations = 10%
The station size is set in the station properties


Back to Top

Movement Commands


AI Wait Until Green Signal
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to wait for a green signal ahead before executing the next driver command. The interface for this driver command is in Russian.

Command Properties:

  • <kuid2:151055:100101:3> AI Wait until green signal
  • DLS Command by erendir

Command Settings: 

  Ждать, пока не будет зелёный > - Translation: "Wait until it is green >" 
     На любом светофоре - Translation: "At any traffic light" - select for the next signal up to 3000m ahead
     Только на станционном зале " Z7 " /Су - Translation: "Only at the station hall " Z7 " / su" - unknown meaning


Change Train Direction
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Reverses the driving direction of the train.

Command Properties:

  • <kuid2:70791:9001:1> Change Train Direction
  • Built-in Command by mgalling

Command Settings: 

None


Halt Train
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Brings the train to an immediate stop.

Command Properties:

  • <kuid:401543:1090> Halt Train
  • Base Command

Command Settings: 

None


Set Max Speed To
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to drive up to the set maximum speed (mph). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.

Command Properties:

  • <kuid2:450022:90001:2> Set Max Speed To
  • DLS Command by nikkia

Command Settings: 

Select <No maximum speed> or <value> in mph

Notes:

The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another Set Max Speed To command.

Related Commands:


Set Max Speed To (km/h)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to drive up to the set maximum speed (km/h). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.

Command Properties:

  • <kuid:450022:90002> Set Max Speed To (km/h)
  • DLS Command by nikkia

Command Settings: 

Select <No maximum speed> or <value> in km/h

Notes:

The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another Set Max Speed To command.

Related Commands:


WaitFor
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to wait for a set time period before executing the next instruction in the command list.

Command Properties:

  • <kuid:-3:10090> WaitFor
  • Base Command

Command Settings: 

Select  from list

Notes:

There are a limited range of available times from 5 seconds to 1 hour. A time delay that is not in this list (e.g. 3 minutes) can be achieved by using two (or more) WaitFor commands with the combined total of their times equaling the required time delay.


WaitForTrigger
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to wait for a trigger event before executing the next instruction in the command list. The train triggering the event can be any train in the session.

Command Properties:

  • <kuid2:57344:80001:5> WaitFor
  • Built-in Command by marinus

Command Settings: 

Select <trigger name> from the session list
   Select <any train> or locomotive from <list of locomotive names>

Known Issues:

  • The presence of a large number of locos in a session can cause this command to fail due to a timeout error

Notes:

  • Command will not appear in a drivers command list if there are no triggers set


Back to Top

Navigation Commands


AutoDrivePastSignal
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to drive under Autopilot until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.

Command Properties:

  • <kuid2:61392:7101:1> AutoDrivePastSignal Command
  • DLS Command by pguy

Command Settings: 

  Select <signal name> from Session list

Notes:

  • It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches

Related Commands:

  • AutoPilot - drives continuously or until a specified trackmark has been passed


Autopilot
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.

Command Properties:

  • <kuid2:71155:60001:5> Autopilot Command
  • DLS Command by _mutton_

Command Settings: 

Select one of
   <activate> - starts the Autopilot Command. This will only terminate when the Autopilot Command is removed from the driver command line
   <stop at track mark> - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see Notes below)

Notes:

  1. It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
  2. If the Stop at track mark option is used then:-
  • the train will not set a path to the track mark, that is the users responsibility
  • the train will run at the full posted line speed upto the track mark and then it will slow to a stop
  • if the track mark is never reached because the correct path has not been set, the train will continue as it would for the activate option

Related Commands:


Drive To
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:11058> Drive To
  • Base Command

Command Settings: 

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

Related Commands:


Drive To Trackmark
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:11149> Drive To Trackmark
  • Base Command

Command Settings: 

Select <name of trackmark> from the session list

Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

Related Commands:


Drive Via Trackmark
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:11209> Drive Via Trackmark
  • Base Command

Command Settings: 

Select <name of trackmark> from the session list

Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.

Related Commands:


Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:10058> Navigate To
  • Base Command

Command Settings: 

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

Related Commands:

  • Drive To - does not seek alternative paths if blocked
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:10149> Navigate To Trackmark
  • Base Command

Command Settings: 

Select <name of trackmark> from the session list

Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

Related Commands:


Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Command Properties:

  • <kuid:-3:10209> Navigate Via Trackmark
  • Base Command

Command Settings: 

Select <name of trackmark> from the session list

Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.

Related Commands:


Back to Top

Session Management Commands


Copy Commands From
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Copies a driver schedule from a schedule library or another driver.

Command Properties:

  • <kuid2:192081:1:7> Copy Commands From
  • Built-in Command by brummfondel

Command Settings: 

Append - From Library - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
Append - From Vehicle - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
Insert - From Library - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
Insert - From Vehicle - select a vehicle, copy its driver commands and insert them into the current schedule (if any)

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Delete Train
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Deletes the train from the session.

Command Properties:

  • <kuid2:116387:15:3> Delete Train
  • Built-in Command by maggs

Command Settings: 

None


Insert Buff Label
Inserts a driver command as a label for a block of driver commands.

Command Properties:

  • <kuid:160293:101002> Insert buff label
  • DLS Command by trev999

Command Settings: 

Select <label number> - select the label number (1 to 10)

Notes:

Up to 10 labels can be inserted into each drivers command list

Related Commands:

  • Jump to Label - unconditionally jumps to a named command label
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Jump to Label
Unconditionally jumps to a named command label.

Command Properties:

  • <kuid2:160293:101003:2> Jump to label
  • DLS Command by trev999

Command Settings: 

Select <label number> - select the label number (1 to 20)

Notes:

A label (Insert Buff label driver command) with the matching label number must be added to the driver commands

Related Commands:

  • Insert Buff Label - inserts a driver command as a label for a block of driver commands
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Layer Control
Shows or hides a selected layer.

Command Properties:

  • <kuid:160293:101080> Layer Control
  • DLS Command by trev999

Command Settings: 

Show <list of layers in route and session> - select a layer to make visible
Hide <list of layers in route and session> - select a layer to make invisible

Related Session Rules

Examples of Use


Move to Train
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Moves the driver with all their remaining driver commands to another train.

Command Properties:

  • <kuid2:71155:60004:2> Move to train
  • DLS Command by _mutton_

Command Settings: 

All trains <list of locomotives> - select a locomotive from the Session list

Notes:

  1. The new train must not already have a driver - make sure that the Generate New Drivers for Empty Trains option in the Driver Setup Rule is not ticked.
  2. If the new train does already have a driver then the command and any following commands will not be executed.

Trainz Wiki Links:


Set Custom HUD (SP2 and later)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Sets a predefined HUD on the screen.

Command Properties:

  • <kuid2:61392:7006:37> SetCustomHud (SP2 and later)
  • DLS Command by pguy

Command Settings: 

<defHud> - select the default HUD
<altHud> - select the alternate HUD
<named Hud> - select from a number of user defined HUDs

Notes:

  1. the Quick CustomHud Manager Rule (SP2 and later) must be added to a session for a HUD to be selected by this command
  2. the default and alternate HUDs are preset but can be edited using the above rule
  3. additional user defined and named HUDs can be created with the Quick CustomHud Manager Rule (SP2 and later)

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Skip if Session-Variable
Jumps to the named command label if a selected session variable meets a set condition.

Command Properties:

  • <kuid2:160293:101014:3> Skip if session-variable
  • DLS Command by trev999

Command Settings: 

Select <label number if> - select the label number (1 to 20)
   <Variable Name> - from the InputTable Rule
      <condition> - from the InputTable Rule

Notes:

  1. The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  2. A label (Insert Buff Label driver command) with the matching label number must be added to the driver commands

Related Commands:

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Wait Until S-Variable V3
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Command Properties:

  • <kuid2:160293:101006:3> Wait Until S-variable V3
  • DLS Command by trev999

Command Settings: 

Select <Variable Name> - select the variable name from those entered in the InputTable Rule
   Select <Condition><Value> - select from those entered in the InputTable Rule

Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


WaitUntilSVariable
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Command Properties:

  • <kuid2:131986:1006:1> WaitUntilSVariable
  • DLS Command by atilabarut
  • Legacy Command has been replaced by Wait Until S-Variable

Command Settings: 

Select <Variable Name><Condition><Value> - from the InputTable Rule

Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Related Commands:

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Back to Top

Train Operation Commands


Bellz
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Rings the train bell.

Command Properties:

  • <kuid2:66277:80002:1> bellz
  • Built-in Command by smileyman

Command Settings: 

None

Notes:

the locomotive must be equipped with a working bell.

Related Commands:

  • Hornz - gives a blast of the horn (or whistle)
  • HornzExtended - gives a specified number of horn blasts


Couple
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.

Command Properties:

  • <kuid:-3:10081> Couple
  • Base Command

Command Settings: 

  <list of available wagons> - select a wagon to couple to

Notes:

  1. The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
  2. There must be a clear path to the target wagon.

Related Commands:

  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Couple At Trackmark
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.

Command Properties:

  • <kuid:2:57145:81100:1> Couple At Trackmark
  • DLS Command by marzipan

Command Settings: 

  <list of available trackmarks> - select a trackmark

Notes:

  1. The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
  2. The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
  3. There must be a clear path to the target wagon.

Related Commands:

  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The train is decoupled at the specified wagon (does not work in Driver Setup Rule).

Command Properties:

  • <kuid:-3:10082> Decouple
  • Base Command

Command Settings: 

  <list of available wagons> - select a wagon to decouple from

Known Issues:

  • This command does not work when added to a driver's command list in the Driver Setup Rule in Surveyor but it does work when manually added to the driver's command list in Driver

Notes:

  1. If programming a driver via the Driver Setup Rule, use the alternative commands Decouple DLX, Decouple Number #, Uncouplez or UncouplezFrom
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple DLX
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.

Command Properties:

  • <kuid2:160293:100120:2> Decouple DLX
  • DLS Command by trev999

Command Settings: 

  When Used in Surveyor using the Driver Setup Rule
     <1-33> - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
     <34-66> - select a wagon from 34 to 66
     <67-99> - select a wagon from 67 to 99
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number which may be beyond the last wagon in the consist
  When used in Driver Mode
     <1-33> - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range) 
        where 1 is the wagon (or tender) immediately following the locomotive
     If there are more than 33 wagons, then
        <34-66> - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
     if there are more than 66 wagons, then
        <67-99> - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number upto and including the last wagon in the consist

Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Head N
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The train is decoupled to leave the selected number (N) of wagons left in the consist.

Command Properties:

  • <kuid2:46162:70002:12> Decouple Head N
  • DLS Command by josefpav

Command Settings: 

  <select wagon number> - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling. 
        1 = the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.

Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Number #
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.

Command Properties:

  • <kuid2:147570:80008:1> Decouple number #
  • Built-in Command by erniesouchak

Command Settings: 

  <number> - select a wagon number (1-40) to decouple from.

Notes:

  1. The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Hornz
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Gives one blast of the train horn or whistle.

Command Properties:

  • <kuid2:66277:80001:2> Hornz
  • Built-in Command by smileyman

Command Settings: 

None

Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • HornzExtended - gives a specified number of horn blasts


HornzExtended
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Gives a specified number of blasts of the train horn or whistle.

Command Properties:

  • <kuid:478639:100034> HornzExtended
  • Built-in Command by ffccnn

Command Settings: 

Select one of <Play once>
              <Play twice>
              ... up to ...
              <Play 10 times>

Notes:

When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached

Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • Hornz - gives one blast of the horn or whistle


MoveTurntable
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Moves the specified turntable to the specified track position.

Command Properties:

  • <kuid2:609850:100018:1> MoveTurntable
  • Built-in Command by vandragonax

Command Settings: 

  <name of turntable> - select the named turntable (see Notes below).
  <track #> or <relative track movement> - select the track number (0 = 1st track) or a relative movement (prev, next)

Notes:

The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.

Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Priorityz
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Sets the train priority value.

Command Properties:

  • <kuid2:66277:80003:1> priorityz
  • Built-in Command by smileyman

Command Settings: 

<value> - select train priority value 1, 2 or 3

Notes:

The Priority value identifies the importance of the train for the Priority Trackmarkers. Usually (a guide only):-
  • Priority 1 = Express trains
  • Priority 2 = Local Expresses or Fast Freights
  • Priority 3 = Slow Local Freights or All Stops Services


Run Around
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.

Command Properties:

  • <kuid:-3:10083> Run Around
  • Base Command

Command Settings: 

None

Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.

Related Commands:

  • Run Around Ex - performs the run around only if there is no loco already in position at the other end


Run Around Ex
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.

Command Properties:

  • <kuid2:117667:83:3> Run Around Ex
  • DLS Command by nicroman

Command Settings: 

None

Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
  3. There must be no locomotive already coupled to the destination end of the train.

Related Commands:

  • Run Around - unconditionally performs the run around


Uncouplez
Uncouples the locomotive (plus tender if present) from the train.

Command Properties:

  • <kuid2:66277:80000:1> UnCouplez
  • Built-in Command by smileyman

Command Settings: 

None

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


UncouplezFrom
Uncouples the train at the wagon specified.

Command Properties:

  • <kuid2:66277:80005:2> UnCouplezFrom
  • Built-in Command by smileyman

Command Settings: 

  <number> - select a wagon number (0-20) to decouple from.

Notes:

  1. The first wagon after the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist


Back to Top

Trainz Wiki

More Tutorials and Guides to Using Trainz
Retrieved from "https://wiki.trainzsimulator.com/index.php?title=Driver_Commands_List&oldid=19694"