How to Use Driver Setup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎Driver Setup Rule)
m
Line 68: Line 68:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
 +
==Adding New Drivers==
 +
After selecting the '''Driver Setup Rule''' and clicking the '''Edit''' button, the Driver Setup Properties Window will be shown. The image below shows the properties window if it is opened with no locomotives placed in the layout.
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupStartWindow.JPG|link=]]</td>
 +
<td><br>
 +
[[file:DriverSetupRemoveExisting.JPG|link=]]
 +
<table cellpadding="4" bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TRS19 Settings:'''</span><br>
 +
*If '''Checked [[file:CheckBox.PNG|link=]]''' All existing drivers will be removed so all trains will become "empty" (no drivers). When used with the '''Generate new Drivers for empty trains''' option, it will produce a new list of randomly selected drivers for all trains.
 +
*If '''Unchecked [[file:CheckBoxOff.PNG|link=]]''' All existing drivers will remain with their previously assigned trains.</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
 +
<table cellpadding="4" bgcolor=#ff0000>
 +
<tr valign="top">
 +
<td>
 +
<table cellpading="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:Bug.png|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TANE Known Issues:'''</span><br>
 +
[[file:DriverSetupRemoveExisting.JPG|link=]] '''This does not appear to have any effect in TANE'''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG|link=]]</td>
 +
<td>If your session uses a rule that will expect to find a particular driver in charge of a train (e.g. driver '''Charlie''' in the '''Trigger Check Rule''') then manually assign '''Charlie''' as the driver of a train and do not select the option '''Remove all existing Drivers first'''.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
[[file:DriverSetupGenerateNew.JPG|link=]]
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>When using the '''Driver Setup Rule''' for the first time with no drivers assigned to existing trains, the '''Generate new Drivers for empty trains''' option will immediately assign drivers to each train. Each time a new train is added to the layout, it will be automatically assigned a driver.</td>
 +
</tr>
 +
</table>
 +
 +
<table cellpadding="4" bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
*If '''Checked [[file:CheckBox.PNG|link=]]''' randomly selected drivers will be assigned to all newly added ''driveable'' trains. Existing drivers will not be affected unless the '''Remove all existing Drivers first''' option has been selected.
 +
*If '''Unchecked [[file:CheckBoxOff.PNG|link=]]''' then you will have to manually assign drivers to trains by clicking the '''<span style="text-decoration: underline;">Add another Driver</span>''' link</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG|link=]]</td>
 +
<td>Adding a large number of drivers to the Driver Setup can cause '''Timeout''' errors particularly if certain driver script libraries are being used. Exactly how many is a "large number" will depend on other factors.<br><br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG|link=]]</td>
 +
<td>If '''Driver Setup Timeout''' errors are reported, then split the drivers between two copies of the '''Driver Setup Rule''' and place the second copy as a child of a [[file:WikiLink.PNG|link=]] '''[[Session Rule List with Parameters#Wait Rule|Wait Rule]]''' set for a delay of just a few seconds.<br>
 +
Information on how to use Parent and Child rules can be found at [[file:WikiLink.PNG|link=]] '''[[Parent and Child Rules]]'''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
 +
==Editing the Driver List==
 +
When drivers and trains have been added to the rule, it will appear as shown below.
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupDriverCommandList.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The first driver in the list will be given the camera focus when the Session is started.''' Unfortunately, there is no easy way of moving drivers up and down the list order.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''If a loco name appears in <span style="color: red;">red</span> then it has been removed from the layout.'''</td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
*Click on the driver '''icon''' to select a different driver from the Session list.
 +
*Click on the '''loco name''' to select a different loco from the Session list (an empty loco list means no unassigned locos are available).
 +
*Click on the '''driver name''' to type in a new name for this driver (this will '''not''' change the driver icon).
 +
*Click on '''Autodetect''' to select a new owner for this driver and loco. There are four "owner" options:-
 +
#'''AI driver''' - this train will be under AI control even if it has no ''Command Bar'' orders to follow. This can be used to prevent a user from taking control of the train.
 +
#'''Autodetect''' - if the train has ''Command Bar'' orders then it will be under AI control. If it has no ''Command Bar'' orders then it will be under user control.
 +
#'''First Human Player''' - the train will be assigned to the user or a multiplayer, whoever selects it first.
 +
#'''Multiplayer Driver''' - the train will be assigned to a multiplayer.
 +
If you need to remove a driver:-
 +
*Click '''remove''' to delete this driver from the rule.
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
==Adding Driver Commands==
 +
 +
The grey area below the driver details (name, loco, owner) is the '''Driver Command Bar'''. This is where the driving instructions (the "train orders") used by the Trainz AI system are given to the driver.
 +
 +
<table>
 +
<tr valign="top">
 +
<td width="560">[[file:DriverSetupAddCommand.JPG|link=]]<br>
 +
Shown below is a ''Command Bar'' after two Driver Commands have been added. Each command has its own icon. Move the mouse pointer onto a command icon to reveal a ''tooltip'' showing the contents of the command, as shown in the image.<br>
 +
[[file:DriverSetupAddedCommand.JPG|link=]]
 +
</td>
 +
<td><table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click the small "double chevron" icon shown in the image on the left. This will open a Command List menu which will show the driver commands that can be added to this drivers ''Command Bar''.
 +
#Click on a command to add it to the ''Command Bar''.</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td width="162">[[file:DriverSetupCommandMenu.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
*The commands that will be shown and are available for use are decided by another rule, the [[file:PageLink.PNG|link=]] '''[[#Driver Command Rule|Driver Command Rule]]'''. If a command that you want is not in the list then open and edit the '''Driver Command Rule'''.
 +
*Many of the items in the menu will open sub-menus. These are indicated by the '''>''' character after the command name. For example:-
 +
**The '''Drive To Trackmark''' will open a sub-menu listing all the available trackmarks
 +
**The '''Navigate To''' will open a sub-menu of all the interactive industries
 +
**The '''Wait For''' will open a sub-menu of different wait times</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
When a driver command has been executed in ''Driver Mode'' by the Trainz AI system, it will be deleted from the ''Command Bar'' and the next command in the sequence will then be executed. This will continue until the last command has been executed and deleted. Then the AI control of the train will terminate.</td>
 +
</tr>
 +
</table>
 +
 +
==Deleting Driver Commands==
 +
To remove a command from the ''Command Bar''...
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupDeleteCommand.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click on the command and hold down the left mouse button
 +
#Drag the command out of the ''Command Bar '' area</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
==The "Repeat" Command==
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr align="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The "Repeat" command is a special built in command that allows all the driver commands to be repeated endlessly.'''
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupAddRepeat.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The "Repeat" command is only available when at least one command is present in the ''Command Bar''.''' Only one '''Repeat''' command can be added to a ''Command Bar''.
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click the ''Add Command'' button on the ''Command Bar''
 +
#Select the '''Repeat''' option
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupRepeatIcon.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The ''Repeat'' icon will ''always'' be placed at the end of the ''Command Bar'' after the ''Add Command'' button.'''
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
As each command is executed by the Trainz AI system, it will be deleted from the front of the command list and added to the end of the list to create an "endless loop" of commands.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupRemoveRepeat.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
*If a '''Repeat''' command is already present, then the ''Add Command'' menu list will show '''Don't Repeat''' as its first option
 +
*Select '''Don't Repeat''' to remove the '''Repeat''' command</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ff0000 width="640">
 +
<tr valign="top">
 +
<td>
 +
<table cellpading="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:Bug.png|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TANE Known Issues:'''</span><br>
 +
If a '''Repeat''' command is present in the ''Command Bar'' and all the other commands are then deleted, the '''Repeat''' command will remain in the ''Command Bar'' and cannot be removed. Because there are no other commands to be repeated this will not cause a problem. However when later adding new commands the presence of the '''Repeat''' command can be easily overlooked. This bug has been fixed in '''TRS19'''.
 +
<table cellpadding="4" bgcolor=#bbffbb width="640">
 +
<tr valign="top">
 +
<td>[[file:Spanner.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Workaround:'''</span><br>
 +
Add a command (any command) to the ''Command Bar''. The '''Don't Repeat''' option will then become available and the '''Repeat''' command can be removed.</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
 +
==Adding New Drivers==
 +
After selecting the '''Driver Setup Rule''' and clicking the '''Edit''' button, the Driver Setup Properties Window will be shown. The image below shows the properties window if it is opened with no locomotives placed in the layout.
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupStartWindow.JPG|link=]]</td>
 +
<td><br>
 +
[[file:DriverSetupRemoveExisting.JPG|link=]]
 +
<table cellpadding="4" bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TRS19 Settings:'''</span><br>
 +
*If '''Checked [[file:CheckBox.PNG|link=]]''' All existing drivers will be removed so all trains will become "empty" (no drivers). When used with the '''Generate new Drivers for empty trains''' option, it will produce a new list of randomly selected drivers for all trains.
 +
*If '''Unchecked [[file:CheckBoxOff.PNG|link=]]''' All existing drivers will remain with their previously assigned trains.</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
 +
<table cellpadding="4" bgcolor=#ff0000>
 +
<tr valign="top">
 +
<td>
 +
<table cellpading="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:Bug.png|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TANE Known Issues:'''</span><br>
 +
[[file:DriverSetupRemoveExisting.JPG|link=]] '''This does not appear to have any effect in TANE'''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG|link=]]</td>
 +
<td>If your session uses a rule that will expect to find a particular driver in charge of a train (e.g. driver '''Charlie''' in the '''Trigger Check Rule''') then manually assign '''Charlie''' as the driver of a train and do not select the option '''Remove all existing Drivers first'''.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
[[file:DriverSetupGenerateNew.JPG|link=]]
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>When using the '''Driver Setup Rule''' for the first time with no drivers assigned to existing trains, the '''Generate new Drivers for empty trains''' option will immediately assign drivers to each train. Each time a new train is added to the layout, it will be automatically assigned a driver.</td>
 +
</tr>
 +
</table>
 +
 +
<table cellpadding="4" bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
*If '''Checked [[file:CheckBox.PNG|link=]]''' randomly selected drivers will be assigned to all newly added ''driveable'' trains. Existing drivers will not be affected unless the '''Remove all existing Drivers first''' option has been selected.
 +
*If '''Unchecked [[file:CheckBoxOff.PNG|link=]]''' then you will have to manually assign drivers to trains by clicking the '''<span style="text-decoration: underline;">Add another Driver</span>''' link</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG|link=]]</td>
 +
<td>Adding a large number of drivers to the Driver Setup can cause '''Timeout''' errors particularly if certain driver script libraries are being used. Exactly how many is a "large number" will depend on other factors.<br><br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG|link=]]</td>
 +
<td>If '''Driver Setup Timeout''' errors are reported, then split the drivers between two copies of the '''Driver Setup Rule''' and place the second copy as a child of a [[file:WikiLink.PNG|link=]] '''[[Session Rule List with Parameters#Wait Rule|Wait Rule]]''' set for a delay of just a few seconds.<br>
 +
Information on how to use Parent and Child rules can be found at [[file:WikiLink.PNG|link=]] '''[[Parent and Child Rules]]'''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
 +
==Editing the Driver List==
 +
When drivers and trains have been added to the rule, it will appear as shown below.
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupDriverCommandList.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The first driver in the list will be given the camera focus when the Session is started.''' Unfortunately, there is no easy way of moving drivers up and down the list order.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''If a loco name appears in <span style="color: red;">red</span> then it has been removed from the layout.'''</td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
*Click on the driver '''icon''' to select a different driver from the Session list.
 +
*Click on the '''loco name''' to select a different loco from the Session list (an empty loco list means no unassigned locos are available).
 +
*Click on the '''driver name''' to type in a new name for this driver (this will '''not''' change the driver icon).
 +
*Click on '''Autodetect''' to select a new owner for this driver and loco. There are four "owner" options:-
 +
#'''AI driver''' - this train will be under AI control even if it has no ''Command Bar'' orders to follow. This can be used to prevent a user from taking control of the train.
 +
#'''Autodetect''' - if the train has ''Command Bar'' orders then it will be under AI control. If it has no ''Command Bar'' orders then it will be under user control.
 +
#'''First Human Player''' - the train will be assigned to the user or a multiplayer, whoever selects it first.
 +
#'''Multiplayer Driver''' - the train will be assigned to a multiplayer.
 +
If you need to remove a driver:-
 +
*Click '''remove''' to delete this driver from the rule.
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
==Adding Driver Commands==
 +
 +
The grey area below the driver details (name, loco, owner) is the '''Driver Command Bar'''. This is where the driving instructions (the "train orders") used by the Trainz AI system are given to the driver.
 +
 +
<table>
 +
<tr valign="top">
 +
<td width="560">[[file:DriverSetupAddCommand.JPG|link=]]<br>
 +
Shown below is a ''Command Bar'' after two Driver Commands have been added. Each command has its own icon. Move the mouse pointer onto a command icon to reveal a ''tooltip'' showing the contents of the command, as shown in the image.<br>
 +
[[file:DriverSetupAddedCommand.JPG|link=]]
 +
</td>
 +
<td><table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click the small "double chevron" icon shown in the image on the left. This will open a Command List menu which will show the driver commands that can be added to this drivers ''Command Bar''.
 +
#Click on a command to add it to the ''Command Bar''.</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td width="162">[[file:DriverSetupCommandMenu.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
*The commands that will be shown and are available for use are decided by another rule, the [[file:PageLink.PNG|link=]] '''[[#Driver Command Rule|Driver Command Rule]]'''. If a command that you want is not in the list then open and edit the '''Driver Command Rule'''.
 +
*Many of the items in the menu will open sub-menus. These are indicated by the '''>''' character after the command name. For example:-
 +
**The '''Drive To Trackmark''' will open a sub-menu listing all the available trackmarks
 +
**The '''Navigate To''' will open a sub-menu of all the interactive industries
 +
**The '''Wait For''' will open a sub-menu of different wait times</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
When a driver command has been executed in ''Driver Mode'' by the Trainz AI system, it will be deleted from the ''Command Bar'' and the next command in the sequence will then be executed. This will continue until the last command has been executed and deleted. Then the AI control of the train will terminate.</td>
 +
</tr>
 +
</table>
 +
 +
==Deleting Driver Commands==
 +
To remove a command from the ''Command Bar''...
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupDeleteCommand.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click on the command and hold down the left mouse button
 +
#Drag the command out of the ''Command Bar '' area</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
==The "Repeat" Command==
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr align="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The "Repeat" command is a special built in command that allows all the driver commands to be repeated endlessly.'''
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupAddRepeat.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The "Repeat" command is only available when at least one command is present in the ''Command Bar''.''' Only one '''Repeat''' command can be added to a ''Command Bar''.
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
 +
#Click the ''Add Command'' button on the ''Command Bar''
 +
#Select the '''Repeat''' option
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupRepeatIcon.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|link=]]</td>
 +
<td>'''The ''Repeat'' icon will ''always'' be placed at the end of the ''Command Bar'' after the ''Add Command'' button.'''
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
As each command is executed by the Trainz AI system, it will be deleted from the front of the command list and added to the end of the list to create an "endless loop" of commands.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:DriverSetupRemoveRepeat.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
*If a '''Repeat''' command is already present, then the ''Add Command'' menu list will show '''Don't Repeat''' as its first option
 +
*Select '''Don't Repeat''' to remove the '''Repeat''' command</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ff0000 width="640">
 +
<tr valign="top">
 +
<td>
 +
<table cellpading="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:Bug.png|link=]]</td>
 +
<td><span style="font-size: 17px;">'''TANE Known Issues:'''</span><br>
 +
If a '''Repeat''' command is present in the ''Command Bar'' and all the other commands are then deleted, the '''Repeat''' command will remain in the ''Command Bar'' and cannot be removed. Because there are no other commands to be repeated this will not cause a problem. However when later adding new commands the presence of the '''Repeat''' command can be easily overlooked. This bug has been fixed in '''TRS19'''.
 +
<table cellpadding="4" bgcolor=#bbffbb width="640">
 +
<tr valign="top">
 +
<td>[[file:Spanner.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Workaround:'''</span><br>
 +
Add a command (any command) to the ''Command Bar''. The '''Don't Repeat''' option will then become available and the '''Repeat''' command can be removed.</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
  
 
='''Driver Command Rule'''=
 
='''Driver Command Rule'''=
Line 74: Line 686:
 
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>'''The [[file:WikiLink.PNG|link=]] [[Session Rule List with Parameters#Driver Command Rule|Driver Command Rule]] controls which ''Driver Commands'' will be available in a Session.''' This applies to both:-
 
<td>'''The [[file:WikiLink.PNG|link=]] [[Session Rule List with Parameters#Driver Command Rule|Driver Command Rule]] controls which ''Driver Commands'' will be available in a Session.''' This applies to both:-
−
*Driver Commands added to the '''Driver Setup Rule''' in the '''Session Editor''' in ''Surveyor Mode'', and
+
*Driver Commands added to the [[file:WikiLink.PNG|link=]] '''[[How to Use Driver Setup Rule|Driver Setup Rule]]''' in the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in ''Surveyor Mode'', and
 
*Driver Commands for the user to manually add to the ''Command Bar'' of user and AI controlled trains running in ''Driver Mode''.</td>
 
*Driver Commands for the user to manually add to the ''Command Bar'' of user and AI controlled trains running in ''Driver Mode''.</td>
 
</tr>
 
</tr>

Revision as of 14:29, 31 October 2019

The information in this Wiki Page applies to both TANE and TRS19.

Contents

Driver Setup Rule

DotPoint.JPG The Driver Setup Rule assigns drivers to consists and issues them with Driver Commands.
DotPoint.JPG Driver Commands are lists of instructions or "orders" that drivers are tasked to complete under the control of the Trainz AI system.


LinkWiki.PNG

A list of available Driver Commands can be found on the Trainz Wiki Page at:-


The WikiLink.PNG Driver Setup Rule is automatically added to the Session Editor of every Session.

EditSessionWindow.JPG
Steps.PNG Steps:
  1. Open the WikiLink.PNG Session Editor by selecting Edit Session from the Surveyor Main Menu in TANE/TRS19 or the Surveyor Edit Menu in TRS19 SP1
  2. Select the Driver Setup Rule shown left (it is usually the rule at the top of the list)
  3. Click the Edit button at the bottom of the Session Editor window


Stop.PNG If the Driver Setup Rule is not shown in the list then...
  1. Click the Add button at the bottom of the Session Editor window
  2. Scroll through the list of rules to locate and select the Driver Setup Rule
  3. Click the Tick.PNG icon on the rule list window

LinkWiki.PNG

More information on the Session Editor can be found on the Trainz Wiki Page at:-

Adding New Drivers

After selecting the Driver Setup Rule and clicking the Edit button, the Driver Setup Properties Window will be shown. The image below shows the properties window if it is opened with no locomotives placed in the layout.

DriverSetupStartWindow.JPG

DriverSetupRemoveExisting.JPG

Gears.PNG TRS19 Settings:
  • If Checked CheckBox.PNG All existing drivers will be removed so all trains will become "empty" (no drivers). When used with the Generate new Drivers for empty trains option, it will produce a new list of randomly selected drivers for all trains.
  • If Unchecked CheckBoxOff.PNG All existing drivers will remain with their previously assigned trains.
Bug.png TANE Known Issues:
DriverSetupRemoveExisting.JPG This does not appear to have any effect in TANE
Stop.PNG If your session uses a rule that will expect to find a particular driver in charge of a train (e.g. driver Charlie in the Trigger Check Rule) then manually assign Charlie as the driver of a train and do not select the option Remove all existing Drivers first.


DriverSetupGenerateNew.JPG

DotPoint.JPG When using the Driver Setup Rule for the first time with no drivers assigned to existing trains, the Generate new Drivers for empty trains option will immediately assign drivers to each train. Each time a new train is added to the layout, it will be automatically assigned a driver.
Gears.PNG Settings:
  • If Checked CheckBox.PNG randomly selected drivers will be assigned to all newly added driveable trains. Existing drivers will not be affected unless the Remove all existing Drivers first option has been selected.
  • If Unchecked CheckBoxOff.PNG then you will have to manually assign drivers to trains by clicking the Add another Driver link


Stop.PNG Adding a large number of drivers to the Driver Setup can cause Timeout errors particularly if certain driver script libraries are being used. Exactly how many is a "large number" will depend on other factors.

PencilTips.PNG If Driver Setup Timeout errors are reported, then split the drivers between two copies of the Driver Setup Rule and place the second copy as a child of a WikiLink.PNG Wait Rule set for a delay of just a few seconds.
Information on how to use Parent and Child rules can be found at WikiLink.PNG Parent and Child Rules


Editing the Driver List

When drivers and trains have been added to the rule, it will appear as shown below.

DriverSetupDriverCommandList.JPG
DotPoint.JPG The first driver in the list will be given the camera focus when the Session is started. Unfortunately, there is no easy way of moving drivers up and down the list order.
DotPoint.JPG If a loco name appears in red then it has been removed from the layout.
Steps.PNG Steps:
  • Click on the driver icon to select a different driver from the Session list.
  • Click on the loco name to select a different loco from the Session list (an empty loco list means no unassigned locos are available).
  • Click on the driver name to type in a new name for this driver (this will not change the driver icon).
  • Click on Autodetect to select a new owner for this driver and loco. There are four "owner" options:-
  1. AI driver - this train will be under AI control even if it has no Command Bar orders to follow. This can be used to prevent a user from taking control of the train.
  2. Autodetect - if the train has Command Bar orders then it will be under AI control. If it has no Command Bar orders then it will be under user control.
  3. First Human Player - the train will be assigned to the user or a multiplayer, whoever selects it first.
  4. Multiplayer Driver - the train will be assigned to a multiplayer.

If you need to remove a driver:-

  • Click remove to delete this driver from the rule.

Adding Driver Commands

The grey area below the driver details (name, loco, owner) is the Driver Command Bar. This is where the driving instructions (the "train orders") used by the Trainz AI system are given to the driver.

DriverSetupAddCommand.JPG

Shown below is a Command Bar after two Driver Commands have been added. Each command has its own icon. Move the mouse pointer onto a command icon to reveal a tooltip showing the contents of the command, as shown in the image.
DriverSetupAddedCommand.JPG

Steps.PNG Steps:
  1. Click the small "double chevron" icon shown in the image on the left. This will open a Command List menu which will show the driver commands that can be added to this drivers Command Bar.
  2. Click on a command to add it to the Command Bar.
DriverSetupCommandMenu.JPG
NotePad.PNG Notes:
  • The commands that will be shown and are available for use are decided by another rule, the PageLink.PNG Driver Command Rule. If a command that you want is not in the list then open and edit the Driver Command Rule.
  • Many of the items in the menu will open sub-menus. These are indicated by the > character after the command name. For example:-
    • The Drive To Trackmark will open a sub-menu listing all the available trackmarks
    • The Navigate To will open a sub-menu of all the interactive industries
    • The Wait For will open a sub-menu of different wait times


NotePad.PNG Notes:
When a driver command has been executed in Driver Mode by the Trainz AI system, it will be deleted from the Command Bar and the next command in the sequence will then be executed. This will continue until the last command has been executed and deleted. Then the AI control of the train will terminate.

Deleting Driver Commands

To remove a command from the Command Bar...

DriverSetupDeleteCommand.JPG
Steps.PNG Steps:
  1. Click on the command and hold down the left mouse button
  2. Drag the command out of the Command Bar area

The "Repeat" Command

DotPoint.JPG The "Repeat" command is a special built in command that allows all the driver commands to be repeated endlessly.
DriverSetupAddRepeat.JPG
DotPoint.JPG The "Repeat" command is only available when at least one command is present in the Command Bar. Only one Repeat command can be added to a Command Bar.
Steps.PNG Steps:
  1. Click the Add Command button on the Command Bar
  2. Select the Repeat option
DriverSetupRepeatIcon.JPG
DotPoint.JPG The Repeat icon will always be placed at the end of the Command Bar after the Add Command button.
NotePad.PNG Notes:
As each command is executed by the Trainz AI system, it will be deleted from the front of the command list and added to the end of the list to create an "endless loop" of commands.
DriverSetupRemoveRepeat.JPG
NotePad.PNG Notes:
  • If a Repeat command is already present, then the Add Command menu list will show Don't Repeat as its first option
  • Select Don't Repeat to remove the Repeat command


Bug.png TANE Known Issues:

If a Repeat command is present in the Command Bar and all the other commands are then deleted, the Repeat command will remain in the Command Bar and cannot be removed. Because there are no other commands to be repeated this will not cause a problem. However when later adding new commands the presence of the Repeat command can be easily overlooked. This bug has been fixed in TRS19.

Spanner.PNG Workaround:
Add a command (any command) to the Command Bar. The Don't Repeat option will then become available and the Repeat command can be removed.


Adding New Drivers

After selecting the Driver Setup Rule and clicking the Edit button, the Driver Setup Properties Window will be shown. The image below shows the properties window if it is opened with no locomotives placed in the layout.

DriverSetupStartWindow.JPG

DriverSetupRemoveExisting.JPG

Gears.PNG TRS19 Settings:
  • If Checked CheckBox.PNG All existing drivers will be removed so all trains will become "empty" (no drivers). When used with the Generate new Drivers for empty trains option, it will produce a new list of randomly selected drivers for all trains.
  • If Unchecked CheckBoxOff.PNG All existing drivers will remain with their previously assigned trains.
Bug.png TANE Known Issues:
DriverSetupRemoveExisting.JPG This does not appear to have any effect in TANE
Stop.PNG If your session uses a rule that will expect to find a particular driver in charge of a train (e.g. driver Charlie in the Trigger Check Rule) then manually assign Charlie as the driver of a train and do not select the option Remove all existing Drivers first.


DriverSetupGenerateNew.JPG

DotPoint.JPG When using the Driver Setup Rule for the first time with no drivers assigned to existing trains, the Generate new Drivers for empty trains option will immediately assign drivers to each train. Each time a new train is added to the layout, it will be automatically assigned a driver.
Gears.PNG Settings:
  • If Checked CheckBox.PNG randomly selected drivers will be assigned to all newly added driveable trains. Existing drivers will not be affected unless the Remove all existing Drivers first option has been selected.
  • If Unchecked CheckBoxOff.PNG then you will have to manually assign drivers to trains by clicking the Add another Driver link


Stop.PNG Adding a large number of drivers to the Driver Setup can cause Timeout errors particularly if certain driver script libraries are being used. Exactly how many is a "large number" will depend on other factors.

PencilTips.PNG If Driver Setup Timeout errors are reported, then split the drivers between two copies of the Driver Setup Rule and place the second copy as a child of a WikiLink.PNG Wait Rule set for a delay of just a few seconds.
Information on how to use Parent and Child rules can be found at WikiLink.PNG Parent and Child Rules


Editing the Driver List

When drivers and trains have been added to the rule, it will appear as shown below.

DriverSetupDriverCommandList.JPG
DotPoint.JPG The first driver in the list will be given the camera focus when the Session is started. Unfortunately, there is no easy way of moving drivers up and down the list order.
DotPoint.JPG If a loco name appears in red then it has been removed from the layout.
Steps.PNG Steps:
  • Click on the driver icon to select a different driver from the Session list.
  • Click on the loco name to select a different loco from the Session list (an empty loco list means no unassigned locos are available).
  • Click on the driver name to type in a new name for this driver (this will not change the driver icon).
  • Click on Autodetect to select a new owner for this driver and loco. There are four "owner" options:-
  1. AI driver - this train will be under AI control even if it has no Command Bar orders to follow. This can be used to prevent a user from taking control of the train.
  2. Autodetect - if the train has Command Bar orders then it will be under AI control. If it has no Command Bar orders then it will be under user control.
  3. First Human Player - the train will be assigned to the user or a multiplayer, whoever selects it first.
  4. Multiplayer Driver - the train will be assigned to a multiplayer.

If you need to remove a driver:-

  • Click remove to delete this driver from the rule.

Adding Driver Commands

The grey area below the driver details (name, loco, owner) is the Driver Command Bar. This is where the driving instructions (the "train orders") used by the Trainz AI system are given to the driver.

DriverSetupAddCommand.JPG

Shown below is a Command Bar after two Driver Commands have been added. Each command has its own icon. Move the mouse pointer onto a command icon to reveal a tooltip showing the contents of the command, as shown in the image.
DriverSetupAddedCommand.JPG

Steps.PNG Steps:
  1. Click the small "double chevron" icon shown in the image on the left. This will open a Command List menu which will show the driver commands that can be added to this drivers Command Bar.
  2. Click on a command to add it to the Command Bar.
DriverSetupCommandMenu.JPG
NotePad.PNG Notes:
  • The commands that will be shown and are available for use are decided by another rule, the PageLink.PNG Driver Command Rule. If a command that you want is not in the list then open and edit the Driver Command Rule.
  • Many of the items in the menu will open sub-menus. These are indicated by the > character after the command name. For example:-
    • The Drive To Trackmark will open a sub-menu listing all the available trackmarks
    • The Navigate To will open a sub-menu of all the interactive industries
    • The Wait For will open a sub-menu of different wait times


NotePad.PNG Notes:
When a driver command has been executed in Driver Mode by the Trainz AI system, it will be deleted from the Command Bar and the next command in the sequence will then be executed. This will continue until the last command has been executed and deleted. Then the AI control of the train will terminate.

Deleting Driver Commands

To remove a command from the Command Bar...

DriverSetupDeleteCommand.JPG
Steps.PNG Steps:
  1. Click on the command and hold down the left mouse button
  2. Drag the command out of the Command Bar area

The "Repeat" Command

DotPoint.JPG The "Repeat" command is a special built in command that allows all the driver commands to be repeated endlessly.
DriverSetupAddRepeat.JPG
DotPoint.JPG The "Repeat" command is only available when at least one command is present in the Command Bar. Only one Repeat command can be added to a Command Bar.
Steps.PNG Steps:
  1. Click the Add Command button on the Command Bar
  2. Select the Repeat option
DriverSetupRepeatIcon.JPG
DotPoint.JPG The Repeat icon will always be placed at the end of the Command Bar after the Add Command button.
NotePad.PNG Notes:
As each command is executed by the Trainz AI system, it will be deleted from the front of the command list and added to the end of the list to create an "endless loop" of commands.
DriverSetupRemoveRepeat.JPG
NotePad.PNG Notes:
  • If a Repeat command is already present, then the Add Command menu list will show Don't Repeat as its first option
  • Select Don't Repeat to remove the Repeat command


Bug.png TANE Known Issues:

If a Repeat command is present in the Command Bar and all the other commands are then deleted, the Repeat command will remain in the Command Bar and cannot be removed. Because there are no other commands to be repeated this will not cause a problem. However when later adding new commands the presence of the Repeat command can be easily overlooked. This bug has been fixed in TRS19.

Spanner.PNG Workaround:
Add a command (any command) to the Command Bar. The Don't Repeat option will then become available and the Repeat command can be removed.


Driver Command Rule

DotPoint.JPG The WikiLink.PNG Driver Command Rule controls which Driver Commands will be available in a Session. This applies to both:-
  • Driver Commands added to the WikiLink.PNG Driver Setup Rule in the WikiLink.PNG Session Editor in Surveyor Mode, and
  • Driver Commands for the user to manually add to the Command Bar of user and AI controlled trains running in Driver Mode.
DotPoint.JPG Removing commands such as Navigate To will force players to manually drive trains when in Driver Mode instead of allowing them to use the Trainz AI system to do all the work.


The WikiLink.PNG Driver Command Rule is automatically added to the Session Editor of every Session.

EditSessionWindow.JPG
Steps.PNG Steps:
  1. Select the Driver Command Rule shown left (it is usually the rule near the top of the list)
  2. Click the Edit button at the bottom of the Session Editor window


Stop.PNG If the Driver Command Rule is not shown in the list then...
  1. Click the Add button at the bottom of the Session Editor window
  2. Scroll through the list of rules to locate and select the Driver Command Rule
  3. Click the Tick.PNG icon on the rule list window
This will add the rule to the Session Editor.


The Rule properties window will open to show all the Driver Commands that have been installed in TANE and TRS19 on your system. This list includes the commands that are built in and those that have been downloaded from the DLS.

DriverCommandAddCommand.JPG
Gears.PNG Settings:
  • Commands that are CheckBox.PNG Checked ON will be available in the Driver Setup Rule Command List in the Session Editor and for the user in Driver Mode
  • Commands that are CheckBoxOff.PNG Checked OFF will NOT be available in the Driver Setup Rule Command List in the Session Editor and for the user in Driver Mode
  • To change the status of a command simply check it ON or OFF


NotePad.PNG Notes:
  • Some Driver Commands that have been checked ON will not appear in the Command List if there is no target for their action. For example:
    • The Wait For Trigger command will not be available to any drivers if there are no triggers set.
    • The Call At command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
PencilTips.PNG If a command that you want to use does not appear in the list, then check in Content Manager that it has been installed or downloaded and is free of errors.


Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
Retrieved from "https://game.ts2009.com/mediaWiki/index.php?title=How_to_Use_Driver_Setup_Rule&oldid=21749"
Personal tools