Revision as of 19:11, 21 November 2018 (view source) Pware (Talk | contribs) m (→‎Load At) ← Older edit		Revision as of 19:13, 21 November 2018 (view source) Pware (Talk | contribs) m (→‎Run Around) Newer edit →
Line 652:		Line 652:
	[[file:Notes.PNG]] '''<u>Notes:</u>'''		[[file:Notes.PNG]] '''<u>Notes:</u>'''
	#There must be a path for the locomotive to follow from one end of the train to the other.		#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 end of the train to perform this movement.	+	#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
	=='''Uncouplez'''==		=='''Uncouplez'''==

---

Revision as of 19:13, 21 November 2018

This document is a work in progress

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 commands appear they will be added to this list. Only commands supplied with TANE or on the DLS are covered in this document. This document will be modified (or a separate document created) for TRS19 after it is officially released (the current release is a beta version).

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  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 TANE.
• Obsolete Command is no longer required (explanation given).
• Legacy Command has been replaced by another command (new command will be identified).

---

Contents 1 Load and Unload Commands 1.1 Instant Load Command 1.2 InstantLoadLocos 1.3 InstantUnLoad 1.4 Load 1.5 Load At 1.6 Unload 2 Movement Commands 2.1 Change Train Direction 2.2 Halt Train 2.3 Set Max Speed To 2.4 Set Max Speed To (km/h) 2.5 WaitFor 2.6 WaitForTrigger 3 Navigation Commands 3.1 Drive To 3.2 Drive To Trackmark 3.3 Drive Via Trackmark 3.4 Navigate To 3.5 Navigate To Trackmark 3.6 Navigate Via Trackmark 4 Session Management 4.1 Delete Train 5 Train Operations 5.1 Bellz 5.2 Couple 5.3 Decouple 5.4 Decouple Number # 5.5 Hornz 5.6 MoveTurntable 5.7 Priorityz 5.8 Run Around 5.9 Uncouplez 5.10 UncouplezFrom

Load and Unload Commands

Instant Load Command

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

Command Properties:

None

InstantLoadLocos

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

Command Properties:

None

InstantUnLoad

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

Command Properties:

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.

• <kuid:-3:10076> Load

• Base Command

Command Properties:

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

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. All signals and speed signs are obeyed during the "Drive To" operation.

• <kuid2:75377:84:1> Load At

• DLS Command by stagecoach

Command Properties:

Select <name of industry> or industry enabled passenger station from 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)

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.

• <kuid:-3:10077> Unload

• Base Command

Command Properties:

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

Change Train Direction

Reverses the driving direction of the train.

• <kuid2:70791:9001:1> Change Train Direction

• Builtin Command by mgalling

Command Properties:

None

Halt Train

Brings the train to an immediate stop.

• <kuid:401543:1090> Halt Train

• Base Command

Command Properties:

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.

• <kuid2:450022:90001:2> Set Max Speed To

• DLS Command by nikkia

Command Properties:

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.

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

• DLS Command by nikkia

Command Properties:

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.

• <kuid:-3:10090> WaitFor

• Base Command

Command Properties:

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.

WaitForTrigger

Instructs the AI driver to wait for a trigger event before executing the next instruction in the command list.

• <kuid2:57344:80001:5> WaitFor

• Built-in Command by marinus

Command Properties:

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

Back to Top

Navigation Commands

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.

• <kuid:-3:11058> Drive To

• Base Command

Command Properties:

Select <name of industry> or industry enabled passenger station from 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:

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

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

• Base Command

Command Properties:

Select <name of trackmark> from 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:

• Navigate To Trackmark - will seek alternative paths if blocked

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.

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

• Base Command

Command Properties:

Select <name of trackmark> from 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:

• Navigate Via Trackmark - will seek alternative paths if blocked

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.

• <kuid:-3:10058> Navigate To

• Base Command

Command Properties:

Select <name of industry> or industry enabled passenger station from 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.

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

• Base Command

Command Properties:

Select <name of trackmark> from 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 - does not seek alternative paths if blocked

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.

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

• Base Command

Command Properties:

Select <name of trackmark> from 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:

• Drive Via Trackmark - does not seek alternative paths if blocked

Back to Top

Session Management

Delete Train

Deletes the train from the session.

• <kuid2:116387:15:3> Delete Train

• Built-in Command by maggs

Command Properties:

None

Back to Top

Train Operations

Bellz

Rings the train bell.

• <kuid2:66277:80002:1> bellz

• Built-in Command by smileyman

Command Properties:

None

Notes:

the locomotive must be equipped with a working bell.

Related Commands:

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

Couple

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

Command Properties:

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

Decouple

The train is decoupled at the specified wagon.

• <kuid:-3:10082> Decouple

• Base Command

Command Properties:

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

Known Bugs:

1. This command does not work when added to a driver's command list in the Driver Setup Rule in Surveyor
2. It does work when added to the driver's command list in Driver

Notes:

If programming a driver via the Driver Setup Rule, use the alternative commands Decouple Number #, Uncouplez or UncouplezFrom

Decouple Number #

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

Command Properties:

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

Hornz

Gives one blast of the train horn or whistle.

• <kuid2:66277:80001:2> Hornz

• Built-in Command by smileyman

Command Properties:

None

Related Commands:

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

MoveTurntable

Moves the specified turntable to the specified track position.

• <kuid2:609850:100018:1> MoveTurntable

• Built-in Command by vandragonax

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:

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

Trainz Wiki Links:

• InputTable Rule

Priorityz

Sets the train priority value.

• <kuid2:66277:80003:1> priorityz

• Built-in Command by smileyman

Command Properties:

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

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.

• <kuid:-3:10083> Run Around

• Base Command

Command Properties:

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.

Uncouplez

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

• <kuid2:66277:80000:1> UnCouplez

• Built-in Command by smileyman

Command Properties:

None

UncouplezFrom

Uncouples the train at the wagon specified.

• <kuid2:66277:80005:2> UnCouplezFrom

• Built-in Command by smileyman

Command Properties:

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

Back to Top

---