Revision as of 14:20, 30 November 2019

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus.

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

Only driver commands supplied with Trainz or on the DLS are covered in this document.

The driver commands listed in this page are all accessible in the Surveyor Session Editor using the Driver Setup Rule.

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 Trainz.
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 and Trainz Plus.

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:

RemoveMissionCode (SP2 and Later) - sets a mission code for the train
SetMissionCode (SP2 and Later) - removes a mission code from those already set for the train

Required Session Rules:

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

Mission Code Manager Rule (SP2 and later)

IT CancelEnhancedPath

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:

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

Related Commands:

IT SetPath - sets an active path

IT SetPath

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:

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

Related Commands:

IT CancelEnhancedPath - cancels an active EIT path
IT SetPathAndWaitActive - sets an active IT or EIT path and waits until it is active
IT SetPathAndWaitNotRed - sets an active IT or EIT path and waits until the signal ahead is not red

IT SetPathAndWaitActive

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:

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

Related Commands:

IT CancelEnhancedPath - cancels an active EIT path
IT SetPath - sets an active IT or EIT path
IT SetPathAndWaitNotRed - sets an active IT or EIT path and waits until the signal ahead is not red

IT SetPathAndWaitNotRed

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:

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

Related Commands:

IT CancelEnhancedPath - cancels an active EIT path
IT SetPath - sets an active IT or EIT path
IT SetPathAndWaitActive - sets an active IT or EIT path and waits until it is active

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:

AddMissionCode (SP2 and Later) - adds another mission code to the train
SetMissionCode (SP2 and Later) - removes a mission code from those already set for the train

Required Session Rules:

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

Mission Code Manager Rule (SP2 and later)

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:

AddMissionCode (SP2 and Later) - adds another mission code to the train
RemoveMissionCode (SP2 and Later) - sets a mission code for the train

Required Session Rules:

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

Mission Code Manager Rule (SP2 and later)

Junction and Signal Commands

ControlJunction

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

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

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:

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

Load and Unload Commands

Instant Load

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

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

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

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:

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.
With passenger enabled stations the Load command will first execute an Unload command to unload some of the passengers.

Load At

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 select  <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes:

The AI driver will select the shortest available path to the destination.
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 indefinitely until the blockage is removed.
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.
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

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:

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

Unload

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:

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.
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

Movement Commands

AI Wait Until Green Signal

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

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

Brings the train to an immediate stop.

Command Properties:

<kuid:401543:1090> Halt Train

Base Command

Command Settings:

None

Set Max Speed To

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) - set the maximum speed in km/h

Set Max Speed To (km/h)

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:

Set Max Speed To - set the maximum speed in mph

WaitFor

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 <time delay> 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.

Related Commands:

Wait Until II - sets the wait to a set clock time

WaitForTrigger

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
In TANE this command will not appear in a drivers command list if there are no triggers set

Related Session Rules:

Trigger Check Rule

Wait Until II

Instructs the AI driver to wait until the specified time

Command Properties:

<kuid:32711:100025> Wait Until II

Built-in Command by dap

Command Settings:

Select <hours> 1 to 24
   Select <minutesx10> minutes 0 to 50 in increments of 10
      Select <minutesx1> minutes 0 to 9

Notes:

If the driver is running up to 4 hours late this command will terminate immediately
If the wait until time is more than 4 hours behind the game time, the command will wait until tomorrow
The game time rate must be set to x1 (normal speed) for the command to work correctly
Run-time editing is not available for this command. To edit in Driver the command must be removed first

Related Commands:

WaitFor - sets the wait period for up to 1 hour

Navigation Commands

Autodrive

Instructs the AI driver to drive under Autopilot to or through the specified trackmark 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:192081:4:5> Autodrive

Built-in Command by brummfondel

Command Settings:

 Select one of:- 
   <Drive to> - select a trackmark from the session list.
   <Drive through> - select a trackmark from the session list.

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:

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

Related Commands:

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

AutoDrivePastSignal

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:

Autodrive - drives to or through a specified trackmark
AutoPilot - drives continuously or until a specified trackmark has been passed

AutoPilot

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:

It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
If the Stop at track mark option is used then:-

the AI will not set a path to the track mark, that is the users responsibility
the AI 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 AI will continue as it would for the activate option

Related Commands:

Autodrive - drives to or through a specified trackmark
AutoDrivePastSignal - drives until a specified signal has been passed

Drive To

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 indefinitely until the blockage is removed.

Related Commands:

Navigate To - will seek alternative paths if blocked

Drive To Trackmark

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 indefinitely until the blockage is removed.

Related Commands:

Drive Via Trackmark - drives through trackmark, will NOT seek alternative paths if blocked
Navigate To Trackmark - stops at trackmark, will seek alternative paths if blocked
Navigate Via Trackmark - drives through trackmark, will seek alternative paths if blocked

Trainz Wiki Links:

How to Use Track Markers

Drive Via Trackmark

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:

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.
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 indefinitely until the blockage is removed.

Related Commands:

Drive To Trackmark - stops at trackmark, will NOT seek alternative paths if blocked
Navigate To Trackmark - stops at trackmark, will seek alternative paths if blocked
Navigate Via Trackmark - drives through trackmark, will seek alternative paths if blocked

Trainz Wiki Links:

How to Use Track Markers

Navigate To

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

Navigate To Trackmark

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:

Drive To Trackmark - stops at trackmark, will NOT seek alternative paths if blocked
Drive Via Trackmark - drives through trackmark, will NOT seek alternative paths if blocked
Navigate Via Trackmark - drives through trackmark, will seek alternative paths if blocked

Trainz Wiki Links:

How to Use Track Markers

Navigate Via Trackmark

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:

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.
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:

Drive To Trackmark - stops at trackmark, will NOT seek alternative paths if blocked
Drive Via Trackmark - drives through trackmark, will NOT seek alternative paths if blocked
Navigate To Trackmark - stops at trackmark, will seek alternative paths if blocked

Trainz Wiki Links:

How to Use Track Markers

Session Management Commands

Copy Commands From

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

Schedule Library Rule

Delete Train

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:

Show/Hide Layer Rule

Examples of Use:

Layers in Driver Mode

Move to Train

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:

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.
If the new train does already have a driver then the command and any following commands will not be executed.

Trainz Wiki Links:

How to Use the Driver Setup Rule

Set Custom HUD (SP2 and later)

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:

the Quick CustomHud Manager Rule (SP2 and later) must be added to a session for a HUD to be selected by this command
the default and alternate HUDs are preset but can be edited using the above rule
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

Quick CustomHud Manager Rule (SP2 and later)

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

Known Issues:

TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

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).
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
Jump to Label - unconditionally jumps to a named command label

Required Session Rules:

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

InputTable Rule

Wait Until S-Variable V3

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

Known Issues:

TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

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

InputTable Rule

WaitUntilSVariable

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 V3

Command Settings:

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

Known Issues:

TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

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:

Wait Until S-Variable V3 - AI driver waits for specified variable condition

Required Session Rules:

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

InputTable Rule

Train Operation Commands

Bellz

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

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:

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.
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

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:

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.
The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
There must be a clear path to the target wagon.

Related Commands:

Couple - couples wagons in a consist
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

Trainz Wiki Links:

How to Use Track Markers

Decouple

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:

If programming a driver via the Driver Setup Rule, use the alternative commands Decouple DLX, Decouple Number #, Uncouplez or UncouplezFrom
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

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:

This decoupling command works in the Driver Setup Rule in Surveyor because it identifies wagons by their position in the consist (e.g. "7") and not by their given name.

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

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:

This decoupling command works in the Driver Setup Rule in Surveyor because it identifies wagons by their position in the consist (e.g. "7") and not by their given name.
Allows for a maximum of 75 wagons.

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 #

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:

The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc upto #40.
This decoupling command works in the Driver Setup Rule in Surveyor because it identifies wagons by their position in the consist (e.g. "7") and not by their given name.

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

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

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

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

InputTable Rule

Priorityz

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

Trainz Wiki Links:

How to Use Track Priority Markers

Run Around

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:

There must be a path for the locomotive to follow from one end of the train to the other.
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

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:

There must be a path for the locomotive to follow from one end of the train to the other.
The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
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. Works on a maximum of 20 wagons only.

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:

The first wagon after the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc upto #20.
This decoupling command works in the Driver Setup Rule in Surveyor because it identifies wagons by their position in the consist (e.g. "7") and not by their given name.

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

Trainz Wiki

More Tutorials and Guides to Using Trainz

@@ Line 839: / Line 839: @@
 [[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 *The presence of a large number of locos in a session can cause this command to fail due to a timeout error
+*In '''TANE''' this command will not appear in a drivers command list if there are no triggers set
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*Command will not appear in a drivers command list if there are no triggers set
 [[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Session Rules:</span>

Driver Commands List

Revision as of 14:20, 30 November 2019

Contents

Interlocking Tower and Mission Code Commands

AddMissionCode (SP2 and Later)

IT CancelEnhancedPath

IT SetPath

IT SetPathAndWaitActive

IT SetPathAndWaitNotRed

RemoveMissionCode (SP2 and Later)

SetMissionCode (SP2 and Later)

Junction and Signal Commands

ControlJunction

SetOneJunction

Set Signal Ahead

Load and Unload Commands

Instant Load

InstantLoadLocos

InstantUnLoad

Load

Load At

Terminate Passenger Train

Unload

Movement Commands

AI Wait Until Green Signal

Change Train Direction

Halt Train

Set Max Speed To

Set Max Speed To (km/h)

WaitFor

WaitForTrigger

Wait Until II

Navigation Commands

Autodrive

AutoDrivePastSignal

AutoPilot

Drive To

Drive To Trackmark

Drive Via Trackmark

Navigate To

Navigate To Trackmark

Navigate Via Trackmark

Session Management Commands

Copy Commands From

Delete Train

Insert Buff Label

Jump to Label

Layer Control

Move to Train

Set Custom HUD (SP2 and later)

Skip if Session-Variable

Wait Until S-Variable V3

WaitUntilSVariable

Train Operation Commands

Bellz

Couple

Couple At Trackmark

Decouple

Decouple DLX

Decouple Head N

Decouple Number #

Hornz

HornzExtended

MoveTurntable

Priorityz

Run Around

Run Around Ex

Uncouplez

UncouplezFrom

Trainz Wiki

Views

Personal tools

Navigation

Search

Toolbox