How to Use Session Editor: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The information in this Wiki Page applies to ''' | <table width=1000 bgcolor=#000000 cellpadding=2> | ||
<tr valign="top"> | |||
<td> | |||
<table width=996 bgcolor=#ffffff cellpadding=2> | |||
<tr valign="middle"> | |||
<td width=35>[[image:Information.png|35px|link=]]</td> | |||
<td><span style="font-size: 15px;">The information in this Wiki Page applies to using the '''Session Editor''' to create fully or partially automated '''Sessions''' in '''T:ANE''', '''TRS19''', '''TRS22''' and '''Trainz Plus'''.</span></td> | |||
</tr> | |||
</table> | |||
</td> | |||
</tr> | |||
</table> | |||
<br> | |||
<table width=1000> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
| Line 237: | Line 249: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|10px|link=]]</td> | <td>[[image:DotPoint.JPG|10px|link=]]</td> | ||
<td>The above operations, and more, can also be found by using a <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on a '''Rule''' to open its menu</td> | <td>The above operations, and more, can also be found by using a <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on a '''Rule''' to open its menu as shown below</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|10px|link=]]</td> | <td>[[image:DotPoint.JPG|10px|link=]]</td> | ||
<td>In '''TRS19 Platinum Edition''' and later versions, including '''Trainz Plus''', an addititional button <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> Restart All Rules </span> will appear after the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> Delete </span> button. This is for the '''UDS''' feature found in those versions and is explained on the '''Wiki Page [[image:WikiLink.PNG|link=]] [[How to Use the UDS Interface]]'''</td> | <td>In '''TRS19 Platinum Edition''' and later versions, including '''Trainz Plus''' and '''TRS22''', an addititional button <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> Restart All Rules </span> will appear after the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> Delete </span> button. This is for the '''UDS''' feature found in those versions and is explained on the '''Wiki Page [[image:WikiLink.PNG|link=]] [[How to Use the UDS Interface]]'''</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Line 258: | Line 270: | ||
</table> | </table> | ||
<br> | <br> | ||
<span style="font-weight: 700; font-size: 17px;">Rule Popup Menu</span><br> | |||
<table width=1000> | |||
<tr valign="top"> | |||
<td>As an alternative to using the '''Button Bar''' <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on a '''Rule''' in the '''Session Editor''' to open its options menu. Some of the options are the same as those found on the '''Button Bar'''</td> | |||
</tr> | |||
</table> | |||
<table width=1000> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
| Line 263: | Line 283: | ||
<td> | <td> | ||
<table width=630> | <table width=630> | ||
<tr valign="top"> | |||
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Options:</span></td> | |||
</tr> | |||
<tr valign="top"> | <tr valign="top"> | ||
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td> | <td width=10>[[image:DotPoint.JPG|10px|link=]]</td> | ||
| Line 298: | Line 321: | ||
<td>[[image:DotPoint.JPG|10px|link=]]</td> | <td>[[image:DotPoint.JPG|10px|link=]]</td> | ||
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> Move down </span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> Down </span> button</td> | <td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> Move down </span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> Down </span> button</td> | ||
</tr> | |||
</table> | |||
</td> | |||
</tr> | </tr> | ||
</table> | </table> | ||
<br> | <br> | ||
<table bgcolor= | <table bgcolor=#ff0000 width=630> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
| Line 311: | Line 337: | ||
<td>[[image:Stop.PNG|link=]]</td> | <td>[[image:Stop.PNG|link=]]</td> | ||
<td>The <span style="background-color: black; color: white; font-weight: 700;"> Cut </span>, <span style="background-color: black; color: white; font-weight: 700;"> Copy </span> and <span style="background-color: black; color: white; font-weight: 700;"> Paste </span> operations will '''NOT''' correctly copy '''ALL''' the settings in some rules, for example the '''Navigation Display Rule'''. It is a good idea to check the settings of each rule that you paste into the '''Session Editor'''. | <td>The <span style="background-color: black; color: white; font-weight: 700;"> Cut </span>, <span style="background-color: black; color: white; font-weight: 700;"> Copy </span> and <span style="background-color: black; color: white; font-weight: 700;"> Paste </span> operations will '''NOT''' correctly copy '''ALL''' the settings in some rules, for example the '''Navigation Display Rule'''. It is a good idea to check the settings of each rule that you paste into the '''Session Editor'''. | ||
</td> | </td> | ||
</tr> | </tr> | ||
| Line 348: | Line 371: | ||
<table width=1000 cellpadding=2> | <table width=1000 cellpadding=2> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: | <td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Add a Rule to the Session Editor:-</span></td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
| Line 354: | Line 377: | ||
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Add </span> button. The rule will be inserted below any currently selected (highlighted) rule or at the end of the list if there is no selected rule | <td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Add </span> button. The rule will be inserted below any currently selected (highlighted) rule or at the end of the list if there is no selected rule | ||
<table bgcolor=#000000 cellpadding=2 | <table bgcolor=#000000 cellpadding=2> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
| Line 389: | Line 412: | ||
<td width=640>[[image:SessionEditAddRule.png|link=|alt=Add a new rule]]</td> | <td width=640>[[image:SessionEditAddRule.png|link=|alt=Add a new rule]]</td> | ||
<td> | <td> | ||
<table bgcolor=#000000 cellpadding=2 | <table bgcolor=#000000 cellpadding=2> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
| Line 447: | Line 470: | ||
<table bgcolor=#ffffff cellpadding=2> | <table bgcolor=#ffffff cellpadding=2> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps:</span> | <td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Copy a Rule Between Two Sessions:-</span></td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
| Line 503: | Line 526: | ||
<table cellpadding=2> | <table cellpadding=2> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image: | <td width=25>[[image:DotPoint1RedC.png|link=]]</td> | ||
<td>'''Drivers, Driver Assignments and Driver Commands ONLY are Copied'''<br> | <td>'''Drivers, Driver Assignments and Driver Commands ONLY are Copied'''<br> | ||
Copying the '''Driver Setup Rule''' will '''NOT''' copy the actual locomotives and consists that the drivers are assigned to. These must be copied or recreated separately</td> | Copying the '''Driver Setup Rule''' will '''NOT''' copy the actual locomotives and consists that the drivers are assigned to. These must be copied or recreated separately</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image: | <td>[[image:DotPoint2RedC.png|link=]]</td> | ||
<td>'''No Duplicate Locos Allowed''' - this is only an issue if you keep both the original and the copied '''Driver Setup Rule''' in the Session<br> | <td>'''No Duplicate Locos Allowed''' - this is only an issue if you keep both the original and the copied '''Driver Setup Rule''' in the Session<br> | ||
If the same loco is present in both '''Driver Setup Rules''' then only the first loco (in the top copy of the rule) will be active. The duplicate loco in the second copy of the rule will be ignored</td> | If the same loco is present in both '''Driver Setup Rules''' then only the first loco (in the top copy of the rule) will be active. The duplicate loco in the second copy of the rule will be ignored</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image: | <td>[[image:DotPoint3RedC.png|link=]]</td> | ||
<td>'''Missing Locos will be Ignored'''<br> | <td>'''Missing Locos will be Ignored'''<br> | ||
If a loco is listed in the copied '''Driver Setup Rule''' but does not exist in the new Session because | If a loco is listed in the copied '''Driver Setup Rule''' but does not exist in the new Session because its asset was not copied across then it will be ignored</td> | ||
</td> | |||
</tr> | </tr> | ||
</table> | </table> | ||
| Line 542: | Line 564: | ||
<table width=1000> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td colspan=2>'''TRS19 Platinum Edition''' and later '''Trainz''' versions including '''Trainz Plus''' have a '''Unified Driver Surveyor (UDS)''' which allows you to switch seamlessly between '''Driver''' and '''Surveyor''' modes. The '''UDS''' allows an edited '''Session''' to be continued without having to restart it from the beginning. This includes editing the '''Session Editor''' on an active '''Session''' where some of the Rules may have already been completed or others have started. To allow for this additional features have been added to the '''Trainz''' versions with the '''UDS''' interface.<br> | <td colspan=2>'''TRS19 Platinum Edition''' and later '''Trainz''' versions including '''Trainz Plus''' and '''TRS22''' have a '''Unified Driver Surveyor (UDS)''' which allows you to switch seamlessly between '''Driver''' and '''Surveyor''' modes. The '''UDS''' allows an edited '''Session''' to be continued without having to restart it from the beginning. This includes editing the '''Session Editor''' on an active '''Session''' where some of the Rules may have already been completed or others have started. To allow for this additional features have been added to the '''Trainz''' versions with the '''UDS''' interface.<br> | ||
[[image:UDS-SessionRules.png|link=]]</td> | [[image:UDS-SessionRules.png|link=]]</td> | ||
| Line 583: | Line 605: | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
Wiki pages that show examples of using the Session Editor to solve particular problems or to carry out particular tasks can be found at the following | Wiki pages that show examples of using the Session Editor to solve particular problems or to carry out particular tasks can be found at the following pages:-<br> | ||
<table width=1000> | <table width=1000> | ||
| Line 596: | Line 618: | ||
* '''[[How to Use Variables in Sessions (Examples)|Using Variables in Sessions - Sample Applications]] | * '''[[How to Use Variables in Sessions (Examples)|Using Variables in Sessions - Sample Applications]] | ||
</div> | </div> | ||
</td> | </td> | ||
</tr> | </tr> | ||
| Line 623: | Line 633: | ||
---- | ---- | ||
---- | ---- | ||
='''Trainz Wiki'''= | ='''Trainz Wiki'''= | ||
<table cellpadding=2 bgcolor=#ffffff> | <table width=1000> | ||
<tr valign="top"> | |||
<td> | |||
<table width=500 cellpadding=2 bgcolor=#ffffff> | |||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:TrainzWiki.png|link=]]</td> | <td width=80>[[image:TrainzWiki.png|link=]]</td> | ||
<td> | <td> | ||
<span style="font-size: 17px | <span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br> | ||
*'''<span class=" | *'''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>''' | ||
*'''[[Driver Commands List]]''' | *'''[[Driver Commands List]]''' | ||
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]''' | *'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]''' | ||
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]''' | *'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]''' | ||
</td> | |||
</tr> | |||
</table> | |||
</td> | |||
<td> | |||
<table width=500 cellpadding=4 bgcolor="aquamarine"> | |||
<tr valign="top"> | |||
<td width=50>[[image:LinkWiki.PNG|link=]]</td> | |||
<td> | |||
<span style="font-size: 17px;">'''Related Links'''</span><br> | |||
*'''[[How to Use Parent and Child Rules]]'''<br> | |||
</td> | |||
</tr> | |||
</table> | |||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
---- | ---- | ||
This page was created by Trainz user '''<span class=" | This page was created by Trainz user '''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in October 2019 and was last updated as shown below. | ||
---- | ---- | ||
[[Category:How-to guides]][[Category:Rules]] | [[Category:How-to guides]][[Category:Rules]] | ||
Latest revision as of 05:04, 9 September 2026
|
|
What is the Session Editor |
| In TANE the Session Editor is found in the Surveyor Main Menu. In TRS19 and later versions it is in the Surveyor Edit Menu. In either case select the Edit Session option from the menu.
|
| Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 |
|
||||||||||||||||
| Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 | Rules can be grouped together into lists for convenience (e.g. all the Rules that set signals at the start of the Session) or because they depend on a particular event (e.g. a time, a train arriving at a set point, a wagon being loaded, etc).
|
The "Button Bar" |
At the bottom of the Session Editor is the "button Bar".
| Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 |
|
||||||||||||
|
| Left Click to Accept your edits and close the Session Editor | Left Click to Cancel your edits and close the Session Editor |
Rule Popup Menu
| As an alternative to using the Button Bar Right Click on a Rule in the Session Editor to open its options menu. Some of the options are the same as those found on the Button Bar |
![]() |
|
||||||||||||||||||||
|
||||
Adding Rules to Sessions |
| Only rules that have been installed in your copy of Trainz can be added to a Session. Many rules are available on the DLS for downloading. | |
| There is a extensive (but incomplete) catalogue of rules, built-in and available for download, at |
| Steps: To Add a Rule to the Session Editor:- | ||||||||||
Left Click on the Add button. The rule will be inserted below any currently selected (highlighted) rule or at the end of the list if there is no selected rule
|
||||||||||
A new window showing all the installed and available rules will appear.
|
||||||||||
Copying Rules Between Sessions |
| Rules can be copied between Sessions (with some restrictions) |
| The Copy and Paste commands can be used to copy configured rules from one session to another. This saves you having to reenter the same data sets, such as driver commands, in each session. |
|
||||||||||||
|
||||
|
Unified Driver Surveyor Interface (UDS) |
TRS19 Platinum Edition and later Trainz versions including Trainz Plus and TRS22 have a Unified Driver Surveyor (UDS) which allows you to switch seamlessly between Driver and Surveyor modes. The UDS allows an edited Session to be continued without having to restart it from the beginning. This includes editing the Session Editor on an active Session where some of the Rules may have already been completed or others have started. To allow for this additional features have been added to the Trainz versions with the UDS interface.![]() |
|
| At the bottom of the Session Editor is a new button, Restart All Rules . This will reset or restart ALL rules in the Session. |
|
![]() |
Some rules, as shown in the screen shot above, have the label (complete was-complete) after the rule name. This indicates that the rule has already been completed. These rules can be individually restarted by a Right Click on the rule and selecting the Reset option from the pop up menu. This will change the rule status to (paused). |
| When the Driver Mode is selected again, all the reset or (paused) rules will be restarted. | |
|
A detailed description of the UDS can be found on the Trainz Wiki Page at:- |
Examples of Using the Session Editor |
Wiki pages that show examples of using the Session Editor to solve particular problems or to carry out particular tasks can be found at the following pages:-
Trainz Wiki
|
|
This page was created by Trainz user pware in October 2019 and was last updated as shown below.






