How to Use Session Editor

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
 
(2 intermediate revisions by one user not shown)
Line 237: Line 237:
 
<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">
Line 258: Line 258:
 
</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 271:
 
<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 309:
 
<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;">&#160;Move down&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Down&#160;</span> button</td>
 
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Move down&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Down&#160;</span> button</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table bgcolor="red" width=630>
+
<table bgcolor=#ff0000 width=630>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
Line 311: Line 325:
 
<td>[[image:Stop.PNG|link=]]</td>
 
<td>[[image:Stop.PNG|link=]]</td>
 
<td>The <span style="background-color: black; color: white; font-weight: 700;">&#160;Cut&#160;</span>, <span style="background-color: black; color: white; font-weight: 700;">&#160;Copy&#160;</span> and <span style="background-color: black; color: white; font-weight: 700;">&#160;Paste&#160;</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;">&#160;Cut&#160;</span>, <span style="background-color: black; color: white; font-weight: 700;">&#160;Copy&#160;</span> and <span style="background-color: black; color: white; font-weight: 700;">&#160;Paste&#160;</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>
 
−
</tr>
 
−
</table>
 
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 529: Line 540:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=629><span id="stepUDS"></span>
 
<td width=629><span id="stepUDS"></span>
−
='''TRS19 Platinum Edition, Trainz Plus and TRS22 UDS'''=
+
='''Unified Driver Surveyor Interface (UDS)'''=
 
</td>
 
</td>
 
<td width=50>&#160;</td> <!-- Skip Down -->
 
<td width=50>&#160;</td> <!-- Skip Down -->
Line 542: Line 553:
 
<table width=1000>
 
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td colspan=2>'''TRS19 Platinum Edition''' and later '''Trainz''' versions 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''' 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 596: Line 607:
 
* '''[[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>
 
−
</tr>
 
−
</table>
 
−
<br>
 
−
 
−
='''Related Links'''=
 
−
 
−
<table cellpadding=2 bgcolor=#ffffff>
 
−
<tr valign="top">
 
−
<td>[[image:LinkWiki.PNG|link=]]</td>
 
−
<td>
 
−
* '''[[How to Use Parent and Child Rules]]'''
 
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 623: Line 622:
 
----
 
----
 
----
 
----
−
 
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
−
<table cellpadding=2 bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[image:TrainzWiki.png|link=]]</td>
 
 
<td>
 
<td>
−
<span style="font-size: 17px; font-weight:700;">More Tutorials and Guides to Using Trainz</span><br>
+
<table width=500 cellpadding=2 bgcolor=#ffffff>
−
*'''<span class="plainlinks" style="font-weight:700;">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>
+
<tr valign="top">
 +
<td width=80>[[image:TrainzWiki.png|link=]]</td>
 +
<td>
 +
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 +
*'''<span class="plainlinks">[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>

Latest revision as of 20:39, 22 November 2023

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

Contents
BlueDot10x10.png The Session Editor allows you to add, delete and edit the Rules in a Session
BlueDot10x10.png The Rules control the operation of the Session

[edit] What is the Session Editor

     Top   Next Down Bottom
NotePad.PNG Notes:

The Rules added and edited by the Session Editor control:-

DotPoint.JPG behaviour of drivers (and their trains)
DotPoint.JPG weather conditions
DotPoint.JPG time of day
DotPoint.JPG signals and switches
DotPoint.JPG display of information and instructions to the player
DotPoint.JPG train timetables
DotPoint.JPG responses to events (time, triggers, load levels, other trains, etc)
DotPoint.JPG decisions on what happens next

to name just a few.


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.

SessionEditMenuTANE.png SessionEditMenuSP1.png

When loaded, the Session Editor will show all the Rules that have been added to the Session. If you have just opened the Editor on a Route without a Session then it will show a very basic set of Rules. The Editor will allow you to add additional Rules, and delete or edit those shown. Links to extensive lists of Rules that are built into Trainz or available on the DLS can be found at the end of this document.


SessionEditRulesSP1.png
NotePad.PNG Notes:
DotPoint.JPG the Name of the Session is the Username tag entry in the config.txt file
DotPoint.JPG the Description of the Session is the Description tag entry in the config.txt file
Both can be directly edited in the Session Editor, or in the config.txt file using a text editor. The session asset will be updated when you save the Session and exit Surveyor.


NotePad.PNG Notes:
The order of the Rules in the Editor list is usually not important. All the rules will be executed simultaneously although some rules will take longer to complete than others
PencilTips.PNG If the order in which some of the Rules are executed is important, then group them together in a Ordered List Rule (examples are shown in the image) in the order you want them to be executed. Information on using Ordered Lists can be found at WikiLink.PNG Using Ordered Lists


SessionEditOpenLayerSP1.png 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).


These form Nested Rules and are indicated by arrow heads as shown in the image on the left. Left Click on an arrow head to open up its nested list of child Rules as shown in the image.
Each of the Rules that have been nested under the Ordered List Rule in the image have been indented one level to the right. Left Click on the arrow head again to close the list.

LinkWiki.PNG

More information on the various types of List Rules and how to create Nested Rules can be found on the Trainz Wiki Page at:-


[edit] The "Button Bar"

     Top Next Up Next Down Bottom

At the bottom of the Session Editor is the "button Bar".

SessionEditButtonsSP1.png
DotPoint.JPG the  Add  button will insert a new Rule below the selected (highlighted) Rule or at the end of the list if no Rule has been selected
To use the other buttons, first select a Rule with a Left Click
DotPoint.JPG the  Edit  button will open the selected (highlighted) Rule for editing
DotPoint.JPG the  Delete  button will delete the selected Rule
DotPoint.JPG the  Indent/Outdent  buttons will move the selected Rule right or left
DotPoint.JPG the  Up/Down  buttons will move the selected Rule Up or Down


NotePad.PNG Notes:
DotPoint.JPG The above operations, and more, can also be found by using a Right Click on a Rule to open its menu as shown below
DotPoint.JPG In TRS19 Platinum Edition and later versions, including Trainz Plus, an addititional button  Restart All Rules  will appear after the  Delete  button. This is for the UDS feature found in those versions and is explained on the Wiki Page WikiLink.PNG How to Use the UDS Interface


Tick.PNG Left Click to Accept your edits and close the Session Editor    Cross.PNG 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
SessionEditPopupMenu.png
Options:
DotPoint.JPG  Edit rule  is the same as the  Edit  button
DotPoint.JPG  Insert above  is the same as the  Add  button but inserts the new Rule above the selected Rule
DotPoint.JPG  Insert below  is the same as the  Add  button (inserts the new rule below the selected Rule)
DotPoint.JPG  Cut  Copy  Paste  will move/copy the rule (and its nested child rules if it has any) between the Session Editor and the Clipboard
DotPoint.JPG  Delete  is the same as the  Delete  button
DotPoint.JPG  Indent  is the same as the  Indent  button
DotPoint.JPG  Outdent  is the same as the  Outdent  button
DotPoint.JPG  Move up  is the same as the  Up  button
DotPoint.JPG  Move down  is the same as the  Down  button


Warning:
Stop.PNG The  Cut ,  Copy  and  Paste  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.


[edit] Adding Rules to Sessions

     Top Next Up Next Down Bottom
BlueDot10x10.png 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.
BlueDot10x10.png There is a extensive (but incomplete) catalogue of rules, built-in and available for download, at WikiLink.PNG Session Rules List (Alphabetical)


Steps: To add a Rule to the Session Editor:-
DotPoint1.JPG 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 >
PencilTips.PNG Alternatively, Right Click on a rule that is already in the Session Editor and select either:-
Ablue.png  Insert above , OR
Bblue.png  Insert below 
to position the new rule above or below the selected rule.
DotPoint2.JPG A new window showing all the installed and available rules will appear.
Add a new rule >
PencilTips.PNG If a rule that you want to use does not appear in the list, then check in Content Manager that it has been installed and is free of errors.


DotPoint3.JPG Left Click on rule you want add and Left Click on the Tick.PNG icon.


[edit] Copying Rules Between Sessions

     Top Next Up Next Down Bottom
BlueDot10x10.png 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.


Steps: To copy a rule between two sessions:-
DotPoint1.JPG in the Session Editor Right Click on the rule to be copied (more than one rule can be selected)
DotPoint2.JPG select  Copy  from the popup menu
DotPoint3.JPG exit the Session back to the Load Route/Session screen
DotPoint4.JPG load the Route and the second Session (where the Rules are to be copied to) into Surveyor and open the Session Editor
DotPoint5.JPG Right Click after the last rule entry and select  Paste  from the popup menu


Warning:
Stop.PNG The  Cut ,  Copy  and  Paste  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.


NotePad.PNG Copying the Driver Setup Rule:

The Driver Setup Rule can be copied from one Session to another using the method described above, but there are some conditions that must be met for this to work.

DotPoint1.JPG Drivers, Driver Assignments and Driver Commands ONLY are Copied
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
DotPoint2.JPG No Duplicate Locos Allowed - this is only an issue if you keep both the original and the copied Driver Setup Rule in the Session
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
DotPoint3.JPG Missing Locos will be Ignored

If a loco is listed in the copied Driver Setup Rule but does not exist in the new Session because it was not copied across then it will be ignored


[edit] Unified Driver Surveyor Interface (UDS)

     Top Next Up Next Down Bottom
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.
UDS-SessionRules.png
SessionEditMenuRestartRules.png At the bottom of the Session Editor is a new button,  Restart All Rules . This will reset or restart ALL rules in the Session.
UDS-CompleteWasComplete.png 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.


LinkWiki.PNG

A detailed description of the UDS can be found on the Trainz Wiki Page at:-
How to Use the UDS Interface

[edit] Examples of Using the Session Editor

     Top Next Up   Bottom

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


  Top Next Up    

[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
LinkWiki.PNG

Related Links

This page was created by Trainz user pware in October 2019 and was last updated as shown below.

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