Driver Commands List

From TrainzOnline
Revision as of 07:44, 8 January 2019 by Pware (Talk | contribs)

Jump to: navigation, search
This document is a work in progress - current count: 50 Driver Commands


Train Railroad Simulator 2019 (TRS19) and TRAINZ A New Era (TANE) SP3. List of Trainz Session Rules in Alphabetical Order with Properties. All commands are the Copyright of N3V Games

This page is always under construction. As new commands appear they will be added to this list.

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 WikiLink.PNG Driver Command Rule and the WikiLink.PNG Driver Setup Rule.

See the Trainz Wiki Page WikiLink.PNG 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.

Contents

Interlocking Tower and Mission Code Commands


AddMissionCode (SP2 and Later)

CMD AddMissionCode.PNG 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)
  • <kuid2:61392:8203:56> AddMissionCode (SP2 and later)
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created using the Interlocking Tower Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


IT CancelEnhancedPath
CMD ITCancelEnhancedPath.png Cancels an active Enhanced Interlocking Tower (EIT) path for the train that had been set by the IT SetPath Command
  • <kuid2:61392:8114:54> IT CancelEnhancedPath
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

  1. The active path must be created using the Interlocking Tower Enhanced Manager Rule (SP2 and later)
  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

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


IT SetPath
CMD ITSetPath.png 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
  • <kuid2:61392:8111:54> IT SetPath
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

  1. The paths must be created using the Interlocking Tower Set Path Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


IT SetPathAndWaitActive
CMD ITSetPath.png 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
  • <kuid2:61392:8113:54> IT SetPathAndWaitActive
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

  1. The paths must be created using the Interlocking Tower Set Path Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


IT SetPathAndWaitNotRed
CMD ITSetPath.png 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
  • <kuid2:61392:8112:54> IT SetPathAndWaitNotRed
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

  1. The paths must be created using the Interlocking Tower Set Path Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


RemoveMissionCode (SP2 and Later)

CMD RemoveMissionCode.PNG 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
  • <kuid2:61392:8204:56> RemoveMissionCode (SP2 and later)
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created using the Interlocking Tower Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


SetMissionCode (SP2 and Later)

CMD SetMissionCode.PNG 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)
  • <kuid2:61392:8201:56> SetMissionCode (SP2 and later)
  • DLS Command by pguy

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created using the Interlocking Tower Rule or the Interlocking Tower Enhanced Manager Rule (SP2 and later)

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


Back to Top

Junction and Signal Commands


ControlJunction
CMD ControlJunction.png Sets the direction for a single specified junction switch.
  • <kuid:131986:1011> ControlJunction
  • DLS Command by atilabarut

Properties.PNG Command Properties: 

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

PageLink2.PNG Related Commands:

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


SetOneJunction
CMD SetOneJunction.png Sets the direction for a single specified junction switch.
  • <kuid:121843:100445> SetOneJunction
  • DLS Command by pitkin

Properties.PNG Command Properties: 

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

PageLink2.PNG Related Commands:

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


Set Signal Ahead
CMD SignalAhead.png Sets the state of the next signal ahead.
  • <kuid2:368725:60003:6> Set Signal Ahead
  • DLS Command by elstoko

Properties.PNG Command Properties: 

  <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.PNG 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 Command
CMD InstantLoad.png Instantly loads all rolling stock (except locos and tenders) in the train with the item(s) in their commodity queues.
  • <kuid2:45324:555017:7> Instant Load Command
  • DLS Command by norfolksouthern37

Properties.PNG Command Properties: 

None


InstantLoadLocos
CMD InstantLoadLocos.png Instantly loads all locos and tenders in the train with the item(s) in their commodity queues (coal, water, diesel fuel).
  • <kuid2:117290:1022:1> InstantLoadLocos
  • Builtin Command by nzhorse

Properties.PNG Command Properties: 

None


InstantUnLoad
CMD InstantUnLoad.png Instantly unloads the commodities in all rolling stock (except locos and tenders) in the train.
  • <kuid2:67585:1021:2> InstantUnload
  • DLS Command by robin_hoods

Properties.PNG Command Properties: 

None


Load
CMD Load.png 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.
  • <kuid:-3:10076> Load
  • Base Command

Properties.PNG Command Properties: 

None

Notes.PNG 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
CMD IndustryIcon.png 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.
  • <kuid2:75377:84:1> Load At
  • DLS Command by stagecoach

Properties.PNG Command Properties: 

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

PageLink2.PNG 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)


Unload
CMD Unload.png 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.
  • <kuid:-3:10077> Unload
  • Base Command

Properties.PNG Command Properties: 

None

Notes.PNG 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
CMD WaitUntilGreen.png 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.
  • <kuid2:151055:100101:3> AI Wait until green signal
  • DLS Command by erendir

Properties.PNG Command Properties: 

  Ждать, пока не будет зелёный > - 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
CMD ChangeDirection.png Reverses the driving direction of the train.
  • <kuid2:70791:9001:1> Change Train Direction
  • Builtin Command by mgalling

Properties.PNG Command Properties: 

None


Halt Train
CMD HaltTrain.png Brings the train to an immediate stop.
  • <kuid:401543:1090> Halt Train
  • Base Command

Properties.PNG Command Properties: 

None


Set Max Speed To
CMD MaxSpeed.png 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.
  • <kuid2:450022:90001:2> Set Max Speed To
  • DLS Command by nikkia

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

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

PageLink2.PNG Related Commands:


Set Max Speed To (km/h)
CMD MaxSpeed.png 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.
  • <kuid:450022:90002> Set Max Speed To (km/h)
  • DLS Command by nikkia

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

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

PageLink2.PNG Related Commands:


WaitFor
CMD WaitFor.png Instructs the AI driver to wait for a set time period before executing the next instruction in the command list.
  • <kuid:-3:10090> WaitFor
  • Base Command

Properties.PNG Command Properties: 

Select <time delay> from list

Notes.PNG 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
CMD WaitForTrigger.png 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.
  • <kuid2:57344:80001:5> WaitFor
  • Built-in Command by marinus

Properties.PNG Command Properties: 

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

Issues.PNG 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.PNG Notes:

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


Back to Top

Navigation Commands


Autopilot Command
CMD AutoPilot.png 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.
  • <kuid2:71155:60001:5> Autopilot Command
  • DLS Command by _mutton_

Properties.PNG Command Properties: 

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

  1. It is the users responsibility to set all junction switches ahead of the train
  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


Drive To
CMD IndustryIcon.png 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.
  • <kuid:-3:11058> Drive To
  • Base Command

Properties.PNG Command Properties: 

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

PageLink2.PNG Related Commands:


Drive To Trackmark
CMD NavigateTo.png 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.
  • <kuid:-3:11149> Drive To Trackmark
  • Base Command

Properties.PNG Command Properties: 

Select <name of trackmark> from the session list

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

PageLink2.PNG Related Commands:


Drive Via Trackmark
CMD NavigateTo.png 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.
  • <kuid:-3:11209> Drive Via Trackmark
  • Base Command

Properties.PNG Command Properties: 

Select <name of trackmark> from the session list

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

PageLink2.PNG Related Commands:


Navigate To
CMD IndustryIcon.png 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.
  • <kuid:-3:10058> Navigate To
  • Base Command

Properties.PNG Command Properties: 

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

PageLink2.PNG Related Commands:

  • Drive To - does not seek alternative paths if blocked


Navigate To Trackmark
CMD NavigateTo.png 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.
  • <kuid:-3:10149> Navigate To Trackmark
  • Base Command

Properties.PNG Command Properties: 

Select <name of trackmark> from the session list

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

PageLink2.PNG Related Commands:


Navigate Via Trackmark
CMD NavigateTo.png 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.
  • <kuid:-3:10209> Navigate Via Trackmark
  • Base Command

Properties.PNG Command Properties: 

Select <name of trackmark> from the session list

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

PageLink2.PNG Related Commands:


Back to Top

Session Management Commands


Delete Train
CMD DeleteTrain.png Deletes the train from the session.
  • <kuid2:116387:15:3> Delete Train
  • Built-in Command by maggs

Properties.PNG Command Properties: 

None


Insert Buff Label
CMD InsertBuffLabel.png Inserts a driver command as a label for a block of driver commands.
  • <kuid:160293:101002> Insert buff label
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

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

PageLink2.PNG 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
CMD JumpToLabel.png Unconditionally jumps to a named command label.
  • <kuid2:160293:101003:2> Jump to label
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

Notes.PNG Notes:

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

PageLink2.PNG 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
CMD LayerControl.png Shows or hides a selected layer.
  • <kuid:160293:101080> Layer Control
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

PageLink.PNG Related Session Rules

Ex.PNG Examples of Use


Move to Train
CMD MoveToTrain.png Moves the driver with all their remaining driver commands to another train.
  • <kuid2:71155:60004:2> Move to train
  • DLS Command by _mutton_

Properties.PNG Command Properties: 

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

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

WikiLink.PNG Trainz Wiki Links:


Skip if Session-Variable
CMD SkipIfSVar.png Jumps to the named command label if a selected session variable meets a set condition.
  • <kuid2:160293:101014:3> Skip if session-variable
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

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

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

PageLink.PNG Linked Session Rules:


Wait Until S-Variable V3
CMD WaitSVariable.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed
  • <kuid2:160293:101006:3> Wait Until S-variable V3
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

PageLink.PNG Linked Session Rules:


WaitUntilSVariable
CMD WaitSVar.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed
  • <kuid2:131986:1006:1> WaitUntilSVariable
  • DLS Command by atilabarut
  • Legacy Command has been replaced by Wait Until S-Variable

Properties.PNG Command Properties: 

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

Notes.PNG 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).

PageLink2.PNG Related Commands:

PageLink.PNG Linked Session Rules:


Back to Top

Train Operation Commands


Bellz
CMD Bellz.png Rings the train bell.
  • <kuid2:66277:80002:1> bellz
  • Built-in Command by smileyman

Properties.PNG Command Properties: 

None

Notes.PNG Notes:

the locomotive must be equipped with a working bell.

PageLink2.PNG Related Commands:

  • Hornz - gives a blast of the horn (or whistle)


Couple
CMD Couple.png The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.
  • <kuid:-3:10081> Couple
  • Base Command

Properties.PNG Command Properties: 

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

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

PageLink2.PNG 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
CMD Decouple.png The train is decoupled at the specified wagon (does not work in Driver Setup Rule).
  • <kuid:-3:10082> Decouple
  • Base Command

Properties.PNG Command Properties: 

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

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

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • 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
CMD DecoupleDLX.png The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.
  • <kuid2:160293:100120:2> Decouple DLX
  • DLS Command by trev999

Properties.PNG Command Properties: 

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

PageLink2.PNG 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 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
CMD Decouple.png The train is decoupled to leave the selected number (N) of wagons left in the consist.
  • <kuid2:46162:70002:12> Decouple Head N
  • DLS Command by josefpav

Properties.PNG Command Properties: 

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

PageLink2.PNG 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 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 #
CMD DecoupleNumber.png The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.
  • <kuid2:147570:80008:1> Decouple number #
  • Built-in Command by erniesouchak

Properties.PNG Command Properties: 

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

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

PageLink2.PNG 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
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Hornz
CMD Hornz.png Gives one blast of the train horn or whistle.
  • <kuid2:66277:80001:2> Hornz
  • Built-in Command by smileyman

Properties.PNG Command Properties: 

None

PageLink2.PNG Related Commands:

  • Bellz - rings the locomotive bell (if it has one)


MoveTurntable
CMD MoveTurntable.png Moves the specified turntable to the specified track position.
  • <kuid2:609850:100018:1> MoveTurntable
  • Built-in Command by vandragonax

Properties.PNG Command Properties: 

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

PageLink.PNG Linked Session Rules:


Priorityz
CMD Priorityz.png Sets the train priority value.
  • <kuid2:66277:80003:1> priorityz
  • Built-in Command by smileyman

Properties.PNG Command Properties: 

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

Notes.PNG 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
CMD RunAround.png Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.
  • <kuid:-3:10083> Run Around
  • Base Command

Properties.PNG Command Properties: 

None

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


Uncouplez
CMD Uncouplez.png Uncouples the locomotive (plus tender if present) from the train.
  • <kuid2:66277:80000:1> UnCouplez
  • Built-in Command by smileyman

Properties.PNG Command Properties: 

None

PageLink2.PNG 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
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


UncouplezFrom
CMD Uncouplez.png Uncouples the train at the wagon specified.
  • <kuid2:66277:80005:2> UnCouplezFrom
  • Built-in Command by smileyman

Properties.PNG Command Properties: 

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

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

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


Back to Top

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=Driver_Commands_List&oldid=17155"
Personal tools