How to Use Session Editor

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m
 
(48 intermediate revisions by one user not shown)
Line 1: Line 1:
−
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.
−
 
+
<table width=1000>
 +
<tr valign="top">
 +
<td>
 
__TOC__
 
__TOC__
−
 
+
</td>
−
='''What is the Session Editor'''=
+
<td>
−
 
+
<table bgcolor="lightcyan" cellpadding=2>
−
<table cellpadding="4" bgcolor=#c1e7e7>
+
<tr valign="top">
−
<tr valign="top>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
 
<td>The '''Session Editor''' allows you to add, delete and edit the '''Rules''' in a Session</td>
 
<td>The '''Session Editor''' allows you to add, delete and edit the '''Rules''' in a Session</td>
 
</tr>
 
</tr>
−
<tr valign="top>
+
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:BlueDot10x10.png|link=]]</td>
 
<td>The '''Rules''' control the operation of the Session</td>
 
<td>The '''Rules''' control the operation of the Session</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<br>
+
</td>
−
<table cellpadding="4" bgcolor=#ffffb0>
+
</tr>
 +
</table>
 +
 
 +
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 +
<tr valign="top">
 +
<td width=629><span id="stepWhat"></span>
 +
='''What is the Session Editor'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepButton|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 
 +
<table bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffb0>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
 
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
 +
----
 
The '''Rules''' added and edited by the '''Session Editor''' control:-
 
The '''Rules''' added and edited by the '''Session Editor''' control:-
−
*behaviour of drivers (and their trains)
+
<table>
−
*weather conditions
+
<tr valign="top">
−
*time of day
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
−
*signals and switches
+
<td>behaviour of drivers (and their trains)</td>
−
*display of information and instructions to the player
+
</tr>
−
*train timetables
+
<tr valign="top">
−
*responses to events (time, triggers, load levels, other trains, etc)
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
−
*decisions on what happens next
+
<td>weather conditions</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>time of day</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>signals and switches</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>display of information and instructions to the player</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>train timetables</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>responses to events (time, triggers, load levels, other trains, etc)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>decisions on what happens next</td>
 +
</tr>
 +
</table>
 
to name just a few.
 
to name just a few.
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
In '''TANE''' and '''TRS19''' the Session Editor is found in the '''Surveyor Main Menu'''. In '''TRS19 SP1''' and '''Trainz Plus''' it has been moved to the '''Surveyor Edit Menu'''. In either case select '''Edit Session''' from the menu.<br><br>
+
<table width=1000>
−
[[file:SessionEditMenuTANE.png|link=]]&nbsp;[[file:SessionEditMenuSP1.png|link=]]<br><br>
+
<tr valign="top">
 +
<td>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 <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Edit Session&#160;</span> option from the menu.<br><br>
 +
[[image:SessionEditMenuTANE.png|link=]]&#160;[[image:SessionEditMenuSP1.png|link=]]<br><br>
  
−
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.<br><br>
+
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.</td>
 +
</tr>
 +
</table>
 +
<br>
  
−
<table>
+
<table width=1000>                      <!-- BEGIN Main table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:SessionEditRulesSP1.png|480px|link=]]</td>
+
<td width=480>[[image:SessionEditRulesSP1.png|480px|link=]]</td>
 
<td>
 
<td>
−
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>
−
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
+
<table bgcolor=#ffffb0 cellpadding=2>
−
*the <span style="text-decoration: underline; font-weight: 700;">Name</span> of the Session is the '''Username''' tag entry in the '''config.txt''' file
+
<tr valign="top">
−
*the <span style="text-decoration: underline; font-weight: 700;">Session Description</span> of the Session is the '''Description''' tag entry in the '''config.txt''' file
+
<td width=25>[[image:NotePad.PNG|link=]]</td>
−
Both entries can be edited in the Session Editor and the '''config.txt''' file for the Session asset will be updated when you save the Session and exit Surveyor.
+
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
----
 
</td>
 
</td>
 
</tr>
 
</tr>
−
</table>
 
−
<br>
 
−
<table cellpadding="4" bgcolor=#c1e7e7>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
−
<td>'''The order of the Rules in the Editor list is <span style="text-decoration: underline;">usually</span> not important.''' All the rules shown will be executed ''simultaneously'' although some rules will take longer to complete than others</td>
+
<td>the <span style="text-decoration: underline; font-weight: 700;">Name</span> of the Session is the '''Username''' tag entry in the '''config.txt''' file</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="text-decoration: underline; font-weight: 700;">Description</span> of the Session is the '''Description''' tag entry in the '''config.txt''' file</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>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.</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>
−
<td>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 [[file:WikiLink.PNG|link=]] '''[[How to Use Parent and Child Rules#Ordered Lists|Using Ordered Lists]]'''</td>
+
<table bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
 +
----
 +
'''The order of the Rules in the Editor list is <span style="text-decoration: underline;">usually</span> not important.''' All the rules will be executed '''simultaneously''' although some rules will take longer to complete than others</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>
 +
<table bgcolor=#ffffe0 width=496>
 +
<tr valign="top">
 +
<td>[[image:PencilTips.PNG|link=]]</td>
 +
<td>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 [[image:WikiLink.PNG|link=]]&#160;'''[[How to Use Parent and Child Rules#Ordered Lists|Using Ordered Lists]]'''
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<br>
 
−
Rules can be grouped together 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. Click on an arrow head to open up its nested list of child Rules.
 
−
<br><br>
 
−
[[file:SessionEditOpenLayerSP1.png|480px|link=]]
 
−
<br><br>
 
−
Each of the Rules that have been nested under the '''Ordered List Rule''' in the image above have been '''indented''' one level to the right.
 
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
+
</td>
−
<table cellpadding="4" bgcolor="Aquamarine">
+
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td width=480>[[image:SessionEditOpenLayerSP1.png|480px|link=]]</td>
 +
<td>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).
 +
<br>
 +
These form '''Nested Rules''' and are indicated by '''arrow heads''' as shown in the image on the left. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on an arrow head to open up its nested list of child Rules as shown in the image.
 +
<br>
 +
Each of the Rules that have been nested under the '''Ordered List Rule''' in the image have been '''indented''' one level to the right. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the ''arrow head'' again to close the list.
 +
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
 
More information on the various types of '''List Rules''' and how to create '''Nested Rules''' can be found on the '''Trainz Wiki Page''' at:-<br>
 
More information on the various types of '''List Rules''' and how to create '''Nested Rules''' can be found on the '''Trainz Wiki Page''' at:-<br>
 
*'''[[How to Use Parent and Child Rules]]'''<br>
 
*'''[[How to Use Parent and Child Rules]]'''<br>
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table width="100%">
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=629><span id="stepButton"></span>
 +
='''The "Button Bar"'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepWhat|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepAdding|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
−
='''The "Button Bar"'''=
 
 
At the bottom of the Session Editor is the "button Bar".<br>
 
At the bottom of the Session Editor is the "button Bar".<br>
  
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=480>[[image:SessionEditButtonsSP1.png|480px|link=]]</td>
 +
<td>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:SessionEditButtonsSP1.png|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Add&#160;</span> button will insert a new Rule below the selected (highlighted) Rule or at the end of the list if no Rule has been selected</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>To use the other buttons, first select a '''Rule''' with a <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Edit&#160;</span> button will open the selected (highlighted) Rule for editing</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Delete&#160;</span> button will delete the selected Rule</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Indent/Outdent&#160;</span> buttons will move the selected Rule right or left</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Up/Down&#160;</span> buttons will move the selected Rule Up or Down</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 
<td>
 
<td>
−
*the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Add&nbsp;</span> button will insert a new Rule below the selected (highlighted) Rule or at the end of the list if no Rule has been selected
+
<table bgcolor=#ffffb0 cellpadding=2>
−
To use the other buttons, select a Rule first by clicking on it
+
<tr valign="top">
−
*the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Edit&nbsp;</span> button will open the selected (highlighted) Rule for editing
+
<td width=25>[[image:NotePad.PNG|link=]]</td>
−
*the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Delete&nbsp;</span> button will delete the selected Rule
+
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
−
*the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Indent/Outdent&nbsp;</span> buttons will move the selected Rule right or left
+
----
−
*the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Up/Down&nbsp;</span> buttons will move the selected Rule Up or Down</td>
+
</td>
 +
</tr>
 +
<tr valign="top">
 +
<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 as shown below</td>
 +
</tr>
 +
<tr valign="top">
 +
<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;">&#160;Restart All Rules&#160;</span> will appear after the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Delete&#160;</span> button. This is for the '''UDS''' feature found in those versions and is explained on the '''Wiki Page [[image:WikiLink.PNG|link=]]&#160;[[How to Use the UDS Interface]]'''</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Tick.PNG|link=]]</td>
+
<td>[[image:Tick.PNG|link=]]</td>
−
<td>Click to '''Accept''' your edits and close the Session Editor</td>
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> to '''Accept''' your edits and close the Session Editor</td>
−
<td>&nbsp;&nbsp;</td>
+
<td>&#160;&#160;</td>
−
<td>[[file:Cross.PNG|link=]]</td>
+
<td>[[image:Cross.PNG|link=]]</td>
−
<td>Click to '''Cancel''' your edits and close the Session Editor</td>
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> to '''Cancel''' your edits and close the Session Editor</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
 +
<span style="font-weight: 700; font-size: 17px;">Rule Popup Menu</span><br>
  
−
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<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>
−
<td>The above operations, and more, can also be found by right mouse clicking on a Rule to open up a menu</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:SessionEditPopupMenu.png|link=]]</td>
+
<td width=370>[[image:SessionEditPopupMenu.png|link=]]</td>
 
<td>
 
<td>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Edit rule&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Edit&nbsp;</span> button
+
<table width=630>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Insert above&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Add&nbsp;</span> button but inserts the new Rule '''above''' the selected Rule
+
<tr valign="top">
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Insert below&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Add&nbsp;</span> button (inserts the new rule '''below''' the selected Rule)
+
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Options:</span></td>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Cut&nbsp;&nbsp;Copy&nbsp;&nbsp;Paste&nbsp;</span> will move/copy the rule (and its nested child rules if it has any) between the Session Editor and the Clipboard
+
</tr>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Delete&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Delete&nbsp;</span> button
+
<tr valign="top">
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Indent&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Indent&nbsp;</span> button
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Outdent&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Outdent&nbsp;</span> button
+
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Edit rule&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Edit&#160;</span> button</td>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Move up&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Up&nbsp;</span> button
+
</tr>
−
*<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Move down&nbsp;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Down&nbsp;</span> button
+
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Insert above&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Add&#160;</span> button but inserts the new Rule '''above''' the selected Rule</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Insert below&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Add&#160;</span> button (inserts the new rule '''below''' the selected Rule)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Cut&#160;&#160;Copy&#160;&#160;Paste&#160;</span> will move/copy the rule (and its nested child rules if it has any) between the '''Session Editor''' and the '''Clipboard'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Delete&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Delete&#160;</span> button</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Indent&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Indent&#160;</span> button</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Outdent&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Outdent&#160;</span> button</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Move up&#160;</span> is the same as the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Up&#160;</span> button</td>
 +
</tr>
 +
<tr valign="top">
 +
<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>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#fcbcbc>
+
<table bgcolor=#ff0000 width=630>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#fcbcbc width=626>
 
<tr valign="top">
 
<tr valign="top">
 
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
 
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:Stop.PNG|link=]]</td>
−
<td>The <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Cut&nbsp;</span>, <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Copy&nbsp;</span> and <span style="background-color: black; color: white; font-weight: 700;">&nbsp;Paste&nbsp;</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>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>
 
</tr>
 
</table>
 
</table>
Line 154: Line 332:
 
</table>
 
</table>
 
<br>
 
<br>
−
<table width="100%">
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=629><span id="stepAdding"></span>
 +
='''Adding Rules to Sessions'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepButton|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepCopying|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 
 +
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>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.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>There is a extensive (but incomplete) catalogue of rules, built-in and available for download, at [[image:WikiLink.PNG|link=]]&#160;'''[[Session Rule List with Parameters|Session Rules List (Alphabetical)]]'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
='''Copying Rules Between Sessions'''=
+
<table width=1000 cellpadding=2>
−
<table cellpadding="4" bgcolor=#c1e7e7>
+
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps:</span> To add a Rule to the Session Editor:-</td>
−
<td>'''Rules can be copied between Sessions'''</td>
+
 
</tr>
 
</tr>
−
</table>
+
<tr valign="top">
 +
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
 +
<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;">&#160;Add&#160;</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
  
−
The '''Copy''' and '''Paste''' commands can be used to copy rules between different sessions. This can save you having to reenter complex sets of data, such as driver commands, in a new session.
+
<table bgcolor=#000000 cellpadding=2>>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<tr valign="top">
−
<tr>
+
<td>
−
<td colspan="2">
+
<table bgcolor=#ffffe0 cellpadding=2>
−
----</td>
+
<tr valign="top">
 +
<td>[[image:PencilTips.PNG|link=]]</td>
 +
<td>Alternatively, <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on a rule that is already in the Session Editor and select either:-
 +
<table>
 +
<tr valign="top">
 +
<td width=25>[[image:Ablue.png|link=]]</td>
 +
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Insert above&#160;</span>, <span style="font-weight: 700; font-size: 15px;">OR</span></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Steps.PNG|link=]]</td>
+
<td width=25>[[image:Bblue.png|link=]]</td>
−
<td><span style="font-size: 17px; font-weight: 700;">Steps:'''</span><br>
+
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Insert below&#160;</span></td>
−
#in the Session Editor right mouse click on the Rule to be copied (more than one Rule can be highlighted)
+
−
#select '''Copy''' from the popup menu
+
−
#exit the session
+
−
#load the second session (where the Rules are to be copied to) into Surveyor and open the Session Editor
+
−
#right mouse click after the last rule entry and select '''Paste'''</td>
+
 
</tr>
 
</tr>
−
<tr>
+
<tr valign="top">
−
<td colspan="2">
+
<td colspan=2>to position the new rule above or below the selected rule.</td>
−
----</td>
+
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint2.JPG|link=]]</td>
 +
<td>A new window showing all the installed and available rules will appear.
 +
<table>
 +
<tr valign="top">
 +
<td width=640>[[image:SessionEditAddRule.png|link=|alt=Add a new rule]]</td>
 +
<td>
 +
<table bgcolor=#000000 cellpadding=2>>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffe0 cellpadding=2>
 +
<tr valign="top">
 +
<td>[[image:PencilTips.PNG|link=]]</td>
 +
<td>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.</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
If, for example, the '''Driver Setup Rule''' was copied by this method from one Session to another, then all the drivers with their assigned locos and driver commands will now be duplicated in the second Session.  
+
<table>
 +
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on rule you want add and <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the [[image:Tick.PNG|link=]] icon.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 +
<tr valign="top">
 +
<td width=629><span id="stepCopying"></span>
 +
='''Copying Rules Between Sessions'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepAdding|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepUDS|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
If the second Session already has a Driver Setup Rule then there will now be two copies of that rule, the original and the imported copy. This will only be a problem if the imported copy '''uses the same locos or drivers''' as the original Rule. If this is the case then you will need to edit one of the Driver Setup Rules to remove or reassign the duplicates.
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>Rules can be copied between Sessions (with some restrictions)</td>
 +
</tr>
 +
</table>
  
−
<table cellpadding="4" bgcolor=#fcbcbc>
+
<table width=1000>
 +
<tr valign="top">
 +
<td>The <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Copy&#160;</span> and <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;Paste&#160;</span> 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.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps:</span> To copy a rule between two sessions:-</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
 +
<td>in the Session Editor <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the rule to be copied (more than one rule can be selected)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint2.JPG|link=]]</td>
 +
<td>select <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Copy&#160;</span> from the popup menu</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td>exit the Session back to the '''Load Route/Session''' screen</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint4.JPG|link=]]</td>
 +
<td>load the Route and the second Session (where the Rules are to be copied to) into Surveyor and open the '''Session Editor'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint5.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> after the last rule entry and select <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Paste&#160;</span> from the popup menu</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 bgcolor=#ff0000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#fcbcbc>
 
<tr valign="top">
 
<tr valign="top">
 
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
 
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:Stop.PNG|link=]]</td>
−
<td>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</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>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
='''Examples of Using the Session Editor'''=
+
<table width=1000 bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[image:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px; font-weight: 700;">Copying the Driver Setup Rule:'''</span><br>
 +
----
 +
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.
 +
<br>
 +
<table cellpadding=2>
 +
<tr valign="top">
 +
<td>[[image:DotPoint1.JPG|link=]]</td>
 +
<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>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint2.JPG|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>
 +
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 valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<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 it was not copied across then it will be ignored
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 +
<tr valign="top">
 +
<td width=629><span id="stepUDS"></span>
 +
='''Unified Driver Surveyor Interface (UDS)'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepCopying|alt=Next Up|Next Up]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepExamples|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</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 links:-<br>
+
<table width=1000>
 +
<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>
  
−
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
+
[[image:UDS-SessionRules.png|link=]]</td>
−
* [[How to Use Message Popup Rule (Applications)|Adding Message Popups - Sample Applications]]
+
</tr>
−
* [[How to Use Navigation Point Rules (Applications)|Adding Navigation Points - Sample Applications]]
+
<tr valign="top">
−
* [[How to Control Junctions in Sessions|Controlling Junctions in Sessions]]
+
<td>[[image:SessionEditMenuRestartRules.png|link=]]</td>
−
* [[How to Control Signals in Sessions|Controlling Signals in Sessions]]
+
<td>At the bottom of the '''Session Editor''' is a new button, <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Restart All Rules&#160;</span>. This will reset or restart '''ALL''' rules in the Session.<br></td>
−
* [[How to Use Track Triggers|Using Track Triggers]]
+
</tr>
−
* [[How to Use Variables in Sessions (Examples)|Using Variables in Sessions - Sample Applications]]
+
<tr valign="top">
−
</div>
+
<td>[[image:UDS-CompleteWasComplete.png|link=]]</td>
 +
<td>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 <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the rule and selecting the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Reset&#160;</span> option from the pop up menu. This will change the rule status to '''(paused)'''.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>When the '''Driver Mode''' is selected again, all the reset or '''(paused)''' rules will be restarted.</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
A detailed description of the '''UDS''' can be found on the '''Trainz Wiki Page''' at:-<br>
 +
'''[[How to Use the UDS Interface]]'''<br>
 +
</td>
 +
</tr>
 +
</table>
  
−
='''Trainz (TRS19) "Plus"'''=
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
−
 
+
<tr valign="top">
−
The '''Plus''' version of '''TRS19''' (also known as '''Trainz Plus''') has the ability to edit saved Driver Games in Surveyor and allowing the edited game to be continued without having to restart the entire Session. This includes using the Session Editor on an active Driver Game Session where some of the Rules may have already been completed and others partially completed. To allow for these possibilities, additional features have been added to the Session Editor in the Plus version.<br>
+
<td width=629><span id="stepExamples"></span>
 +
='''Examples of Using the Session Editor'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepUDS|alt=Next Up|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
This version is currently undergoing '''beta testing'''.<br>
+
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:-<br>
−
 
+
−
='''Related Links'''=
+
  
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
 
 
<td>
 
<td>
−
* '''[[How to Use Parent and Child Rules]]'''
+
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
 +
* '''[[How to Use Message Popup Rule (Applications)|Adding Message Popups - Sample Applications]]'''
 +
* '''[[How to Use Navigation Point Rules (Applications)|Adding Navigation Points - Sample Applications]]'''
 +
* '''[[How to Control Junctions in Sessions|Controlling Junctions in Sessions]]'''
 +
* '''[[How to Control Signals in Sessions|Controlling Signals in Sessions]]'''
 +
* '''[[How to Use Track Triggers|Using Track Triggers]]'''
 +
* '''[[How to Use Variables in Sessions (Examples)|Using Variables in Sessions - Sample Applications]]
 +
</div>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="bottom"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepExamples|alt=Next Up|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>&#160;</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
−
 
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file: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