How to Use the UDS Interface

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Some Questions Answered)
m
Line 1: Line 1:
The information in this Wiki Page applies to '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22'''. Older versions of '''Trainz''', including '''T:ANE''' and '''TRS19 (standard)''', do not have the '''UDS''' feature described in this document. A more detailed description of the '''UDS''' can be found on the Trainz Wiki Page [[image:WikiLink.PNG|link=]] '''[[Unified_Driver_Surveyor]]'''.
+
<table width=1000>
<table>
+
<tr valign="top">
 +
<td>
 +
The information in this Wiki Page applies to '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22'''. Older versions of '''Trainz''', including '''T:ANE''' and '''TRS19 (standard)''', do not have the '''UDS''' feature described in this document. A more detailed description of the '''UDS''' can be found on the Trainz Wiki Page [[image:WikiLink.PNG|link=]] '''[[Unified_Driver_Surveyor]]'''.</td>
 +
</tr>
 +
</table>
 +
 
 +
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''UDS''' (<span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;U&#160;</span>niversal <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;D&#160;</span>river <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;S&#160;</span>urveyor) Interface allows you to switch instantly between '''Surveyor''' and '''Driver''' modes without having to reload</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
 
__TOC__
 
__TOC__
 
</td>
 
</td>
<td width=800>
+
<td>
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=800 bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">In Summary:</span></td>
+
<td>
</tr>
+
<table width=796 bgcolor=#ffffff cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>The '''UDS''' is only found in '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22'''</td>
 
<td>The '''UDS''' is only found in '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>It provides a method of quickly switching from '''Driver''' mode to '''Surveyor''' mode and back to '''Driver''' again without having to restart a running session after each switch</td>
 
<td>It provides a method of quickly switching from '''Driver''' mode to '''Surveyor''' mode and back to '''Driver''' again without having to restart a running session after each switch</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>After switching from '''Driver''' to '''Surveyor''' and editing you can save your edits before switching back into '''Driver''' but it is '''<u>recommended</u>''' that you save your work as a new session (unless you really do want to '''overwrite''' the original session)</td>
 
<td>After switching from '''Driver''' to '''Surveyor''' and editing you can save your edits before switching back into '''Driver''' but it is '''<u>recommended</u>''' that you save your work as a new session (unless you really do want to '''overwrite''' the original session)</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>The '''<u>virtual location</u>''' of all consists is now stored as part of the '''Session''' even if the consists themselves are placed in the '''Route'''</td>
 
<td>The '''<u>virtual location</u>''' of all consists is now stored as part of the '''Session''' even if the consists themselves are placed in the '''Route'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>The '''Session Editor''' has a new feature that allows you to reset any or all of the Session Rules before restarting a session</td>
+
<td>The '''Session Editor''' has a feature that allows you to reset any or all of the Session Rules before restarting a session</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 40: Line 56:
 
<td width=46>&nbsp;</td>
 
<td width=46>&nbsp;</td>
 
<td width=75>&nbsp;</td>
 
<td width=75>&nbsp;</td>
<td width=75>[[file:NextDown.png|link=#stepSwitch|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepSwitch|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
 
='''What is the UDS Interface?'''=
 
='''What is the UDS Interface?'''=
  
'''UDS''' stands for '''<u>U</u>'''nified '''<u>D</u>'''river '''<u>S</u>'''urveyor and is an "interface" or option built into '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22''' that allows you to jump seamlessly from '''Driver''' into '''Surveyor''' and then back into '''Driver''' again to resume a session at the point where you left it. There is no need to restart a '''Driver''' session from the very beginning.<br><br>
+
<table width=1000>
 +
<tr valign="top">
 +
<td>
 +
'''UDS''' stands for <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;U&#160;</span>'''niversal''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;D&#160;</span>'''river''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;S&#160;</span>'''urveyor''' and is an "interface" or option built into '''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22''' that allows you to jump seamlessly from '''Driver''' into '''Surveyor''' and then back into '''Driver''' again to resume a session at the point where you left it. There is no need to restart a '''Driver''' session from the very beginning.</td>
 +
</tr>
 +
</table>
 +
<br><br>
  
<table bgcolor=#ffffb0 width=900>
+
<table bgcolor=#ffffb0 width=1000>
 
<tr valign="top">
 
<tr valign="top">
 
<td><span style="font-weight: 700; font-size:17px;">The Scenario:</span><br>
 
<td><span style="font-weight: 700; font-size:17px;">The Scenario:</span><br>
Line 55: Line 77:
 
</tr>
 
</tr>
 
</table>
 
</table>
<table bgcolor=#ffffb0 width=900>
+
 
 +
<table bgcolor=#ffffb0 width=1000>
 
<tr valign="top">
 
<tr valign="top">
 
<td width=450>[[image:UDS-Scenario1.png|link=]]</td>
 
<td width=450>[[image:UDS-Scenario1.png|link=]]</td>
<td width=450>Previously (before '''UDS''') your only options would be to choose one of the following:-
+
<td width=550>Previously (before the '''UDS''') your only options would be to choose one of the following:-
 
<span style="font-weight: 700; font-size: 15px;">Options:</span><br>
 
<span style="font-weight: 700; font-size: 15px;">Options:</span><br>
 
<table>
 
<table>
Line 111: Line 134:
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>The '''UDS''' interface allows you to switch, via a menu option, directly to '''Surveyor''' without having to stop and exit '''Driver''' mode first</td>
 
<td>The '''UDS''' interface allows you to switch, via a menu option, directly to '''Surveyor''' without having to stop and exit '''Driver''' mode first</td>
 
</tr>
 
</tr>
Line 121: Line 144:
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
Using '''UDS''' you switch from '''Driver''' to '''Surveyor''' with the currently active '''Driver''' consist still as the focus and at the place it was located when you switched into '''Surveyor''' from '''Driver'''.</td>
+
When using the '''UDS''' you switch from '''Driver''' to '''Surveyor''' with the currently active '''Driver''' consist still as the focus and at the place it was located when you switched into '''Surveyor''' from '''Driver'''.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 146: Line 169:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepSwitch"></span>&nbsp;</td>
 
<td width=729><span id="stepSwitch"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#top|alt=Next Up|Next Up]]</td>
+
<td width=75>[[image:NextUp.png|link=#top|alt=Next Up|Next Up]]</td>
<td width=75>[[file:NextDown.png|link=#stepSaving|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepSaving|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 159: Line 182:
 
<table width=400>
 
<table width=400>
 
<tr valign="top">
 
<tr valign="top">
<td width=20>[[file:DotPoint.JPG|link=]]</td>
+
<td width=20>[[image:DotPoint.JPG|link=]]</td>
 
<td><span style="font-weight: 700; font-size: 17px;">Driver Mode to Surveyor</span></td>
 
<td><span style="font-weight: 700; font-size: 17px;">Driver Mode to Surveyor</span></td>
 
</tr>
 
</tr>
Line 186: Line 209:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:Stop.PNG|link=]]</td>
 
<td>When you switch to '''Surveyor mode''' the '''Pause''' option (at the top of the '''Tools menu''') will be automatically turned '''ON'''. If you turn this option '''OFF''' in '''Surveyor mode''' then any consists that were moving in '''Driver mode''' (and were then paused when you switched) will start moving again. This will almost certainly cause problems such as derailments.
 
<td>When you switch to '''Surveyor mode''' the '''Pause''' option (at the top of the '''Tools menu''') will be automatically turned '''ON'''. If you turn this option '''OFF''' in '''Surveyor mode''' then any consists that were moving in '''Driver mode''' (and were then paused when you switched) will start moving again. This will almost certainly cause problems such as derailments.
 
</td>
 
</td>
Line 207: Line 230:
 
<table width=400>
 
<table width=400>
 
<tr valign="top">
 
<tr valign="top">
<td width=20>[[file:DotPoint.JPG|link=]]</td>
+
<td width=20>[[image:DotPoint.JPG|link=]]</td>
 
<td><span style="font-weight: 700; font-size: 17px;">Surveyor Mode to Driver</span></td>
 
<td><span style="font-weight: 700; font-size: 17px;">Surveyor Mode to Driver</span></td>
 
<td>&nbsp;</td>
 
<td>&nbsp;</td>
Line 260: Line 283:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepSaving"></span>&nbsp;</td>
 
<td width=729><span id="stepSaving"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepSwitch|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepSwitch|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepReset|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepReset|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 282: Line 305:
 
<table bgcolor=#ffffe0>
 
<table bgcolor=#ffffe0>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>[[image:PencilTips.PNG|link=]]</td>
 
<td>It is '''<u>strongly recommended</u>''' that all consists be placed into a '''Session Layer''' and become part of a '''Session''' instead of the '''Route'''
 
<td>It is '''<u>strongly recommended</u>''' that all consists be placed into a '''Session Layer''' and become part of a '''Session''' instead of the '''Route'''
 
</td>
 
</td>
Line 302: Line 325:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:Stop.PNG|link=]]</td>
 
<td>If you decide to save your '''Surveyor''' edits and select the option to<br>
 
<td>If you decide to save your '''Surveyor''' edits and select the option to<br>
 
[[image:UDS-OverwriteExistingSession.png|link=]]<br><br>
 
[[image:UDS-OverwriteExistingSession.png|link=]]<br><br>
Line 313: Line 336:
 
</table>
 
</table>
 
<br>
 
<br>
Most of the problems users seem to be experiencing with the '''UDS''', judging from the posts in the Trainz Forums, is when saving their edited '''Driver''' session after switching to '''Surveyor''' mode. <br>
+
<table width=1000>
 
+
<table cellpadding=4 bgcolor=#c1e7e7>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>
<td>Using '''Driver Mode''' involves driving consists (either manually or through the AI) and activating rules. '''These will change the session parameters'''</td>
+
Most of the problems users seem to be experiencing with the '''UDS''', judging from the posts in the Trainz Forums, is when saving their edited '''Driver''' session after switching to '''Surveyor''' mode.</td>
 
</tr>
 
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>
 +
<table bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
----
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Using '''Driver Mode''' involves driving consists (either manually or through the AI) and activating session rules. '''This will change the session parameters'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>'''Overwriting the Session will save the consist locations and Session Rules in their new positions/conditions'''</td>
 
<td>'''Overwriting the Session will save the consist locations and Session Rules in their new positions/conditions'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
When you are in '''Driver Mode''' at least one of the consists will probably be moving. Some of the Session rules may have already been completed while others may still be running or waiting for events (e.g. triggers to be activated).
+
</td>
 
+
</tr>
If, after switching to '''Surveyor Mode''', you then choose to save using the '''Overwrite existing session''' option then you will be replacing your original starting Session with a new one with the consists saved in their new positions and the Session rules saved in their new states. So when you later load and restart the Session things will not be the same as they were in the original or starting Session.
+
</table>
 
<br>
 
<br>
<span style="font-size: 17px; background-color: yellow; font-weight: 700">&nbsp;Unless you have a particular reason for overwriting the original Session then the recommended save options are:-</span><br>
+
<table width=1000>
 +
<tr valign="top">
 +
<td>When you are in '''Driver Mode''' at least one of the consists will probably be moving. Some of the Session rules may have already been completed while others may still be running or waiting for events (e.g. triggers to be activated).
 +
 
 +
If, after switching to '''Surveyor Mode''', you then choose to save using the '''Overwrite existing session''' option then you will be replacing your original starting Session with a new one with the consists saved in their new positions and the Session rules saved in their new states. So when you later load and restart the Session things will not be the same as they were in the original or starting Session.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-size: 17px; background-color: yellow; font-weight: 700">&nbsp;Unless you have a particular reason for overwriting the original Session then the recommended save options are:-</span></td>
 +
</tr>
 +
</table>
 +
 
 
<table width=1000>
 
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
Line 410: Line 457:
 
</tr>
 
</tr>
 
</table>
 
</table>
<br>
+
 
 
<table width=1000 bgcolor=#000000>
 
<table width=1000 bgcolor=#000000>
 
<tr valign="top">
 
<tr valign="top">
Line 424: Line 471:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
 
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td>move that '''Session Layer''' to the '''Route Layer Group''' before starting the Session in Driver. See [[file:WikiLink.PNG|link=]] '''[[How_to_Use_Layers#Moving_a_Layer|Moving Layers]]''' for more details</td>
+
<td>move that '''Session Layer''' to the '''Route Layer Group''' before starting the Session in Driver. See [[image:WikiLink.PNG|link=]] '''[[How_to_Use_Layers#Moving_a_Layer|Moving Layers]]''' for more details</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 450: Line 497:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint3.JPG|link=]]</td>
 
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>move the layer from the '''Route Layer Group''' back to the  '''Session Layer Group'''. See [[file:WikiLink.PNG|link=]] '''[[How_to_Use_Layers#Moving_a_Layer|Moving Layers]]''' for more details</td>
+
<td>move the layer from the '''Route Layer Group''' back to the  '''Session Layer Group'''. See [[image:WikiLink.PNG|link=]] '''[[How_to_Use_Layers#Moving_a_Layer|Moving Layers]]''' for more details</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 467: Line 514:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepReset"></span>&nbsp;</td>
 
<td width=729><span id="stepReset"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepSaving|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepSaving|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepQuestions|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepQuestions|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
  
 
='''Resetting the Session Rules'''=
 
='''Resetting the Session Rules'''=
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>After you switch from '''Driver Mode''' to '''Surveyor Mode''' it may be necessary to restart or reset some of the '''Session Rules'''</td>
 
<td>After you switch from '''Driver Mode''' to '''Surveyor Mode''' it may be necessary to restart or reset some of the '''Session Rules'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 
As mentioned above, when '''Driver Mode''' is running some of the Session rules may be completed while others may still be running or waiting for certain events (e.g. triggers to be activated). When you switch to '''Surveyor Mode''' these rules may be in a different state compared to what they were at the start of the Session. When you restart '''Driver Mode''' these rules may not be in a useful condition.<br>
 
As mentioned above, when '''Driver Mode''' is running some of the Session rules may be completed while others may still be running or waiting for certain events (e.g. triggers to be activated). When you switch to '''Surveyor Mode''' these rules may be in a different state compared to what they were at the start of the Session. When you restart '''Driver Mode''' these rules may not be in a useful condition.<br>
  
The '''Session Editor''' built into all Trainz versions allows you to add, delete and modify the rules that will operate during a Session.<br>
+
The '''Session Editor''' built into all Trainz versions allows you to add, delete and modify the rules that will operate during a Session.</td>
 
+
</tr>
 +
</table>
 +
<br>
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>Information on the '''Session Editor''' can be found at:-<br>
 
<td>Information on the '''Session Editor''' can be found at:-<br>
 
* '''[[How to Use Session Editor|Using the Session Editor]]'''
 
* '''[[How to Use Session Editor|Using the Session Editor]]'''
Line 518: Line 570:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepQuestions"></span>&nbsp;</td>
 
<td width=729><span id="stepQuestions"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepReset|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepReset|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 534: Line 586:
 
</table>
 
</table>
 
<br>
 
<br>
Many scenery assets actually have their properties stored in the Session, even when the assets themselves are in a Route layer. Editing the properties of these assets is considered to be a change to the Session. These include:-
+
<table width=1000>
*junction switches - the left/right switch direction is stored in the Session (but the switch '''default''' direction is stored in the Route)
+
<tr valign="top">
*industries - the commodities and quantities loaded/unloaded are stored in the Session
+
<td colspan=2>Many scenery assets actually have their properties stored in the Session, even when the assets themselves are in a Route layer. Editing the properties of these assets is considered to be a change to the Session. These include:-</td>
*industry enabled wagons - the commodities and quantities carried are stored in the Session
+
</tr>
*consist locations - this is stored in the Session ('''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22''' only)
+
<tr valign="top">
*named route objects - while the name is stored in the Route, adding or changing the name is treated as a change to the Session
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
If you have not altered any Session data or assets that have been placed in a session layer then you can ignore the request to save the Session as well as the Route. Changing the name of an asset, for example, does not alter any session data.
+
<td>junction switches - the left/right switch direction is stored in the Session (but the switch '''default''' direction is stored in the Route)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>industries - the commodities and quantities loaded/unloaded are stored in the Session</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>industry enabled wagons - the commodities and quantities carried are stored in the Session</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>consist locations - this is stored in the Session ('''TRS19 Platinum Edition''', '''Trainz Plus''' and '''TRS22''' only</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>named route objects - while the name is stored in the Route, adding or changing the name is treated as a change to the Session</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>If you have not altered any Session data or assets that have been placed in a session layer then you can ignore the request to save the Session as well as the Route. Changing the name of an asset, for example, does not alter any session data.</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
 
<table cellpadding=4 bgcolor=#bbffff>
 
<table cellpadding=4 bgcolor=#bbffff>
Line 550: Line 623:
 
</table>
 
</table>
 
<br>
 
<br>
If you make the switch from '''Driver Mode''' to '''Surveyor Mode''' after an '''IT/EIT''' path has been activated (but not yet cleared or cancelled) then you will be unable to edit that path. In addition, you will not be able to add new paths to an '''IT/EIT''' that has an open active path.<br>
+
<table width=1000>
 
+
<tr valign="top">
Pierre ('''pguy'''), the creator of the '''EIT''' asset and associated rules, has a detailed description of this and some possible solutions in a Trainz Forum post at:- '''<span class="plainlinks">[https://forums.auran.com/trainz/showthread.php?159841-Interlocking-Towers-Session-Only&p=1825875#post1825875 EITs and the UDS]</span>'''<br>
+
<td>If you make the switch from '''Driver Mode''' to '''Surveyor Mode''' after an '''IT/EIT''' path has been activated (but not yet cleared or cancelled) then you will be unable to edit that path. In addition, you will not be able to add new paths to an '''IT/EIT''' that has an open active path.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>Pierre ('''pguy'''), the creator of the '''EIT''' asset and associated rules, has a detailed description of this and some possible solutions in a Trainz Forum post at:- '''<span class="plainlinks">[https://forums.auran.com/trainz/showthread.php?159841-Interlocking-Towers-Session-Only&p=1825875#post1825875 EITs and the UDS]</span>'''</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
 
<table cellpadding=4 bgcolor=#bbffff>
 
<table cellpadding=4 bgcolor=#bbffff>
Line 562: Line 640:
 
</table>
 
</table>
 
<br>
 
<br>
You can add additional trains and replace existing ones when in '''Surveyor mode''' but it is advised that:-
+
<table>
# the '''Paused''' option be set ON (the default condition) in '''Surveyor mode''', and
+
<tr valign="top">
# you may have to reset the '''Driver Setup Rule''' in the '''Session Editor''' particularly if you have added/edited driver commands to the new or altered consist
+
<td colspan=2>You can add additional trains and replace existing ones when in '''Surveyor mode''' but it is advised that:-</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the '''Paused''' option be set ON (the default condition) in '''Surveyor mode''', and</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>you may have to reset the '''Driver Setup Rule''' in the '''Session Editor''' particularly if you have added/edited driver commands to the new or altered consist</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
 
<table cellpadding=4 bgcolor=#bbffff>
 
<table cellpadding=4 bgcolor=#bbffff>
Line 573: Line 661:
 
</tr>
 
</tr>
 
</table>
 
</table>
'''This issue is now under investigation by N3V'''<br>
+
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>'''This issue is now under investigation by N3V'''<br>
  
 
A train that is driven into a portal and later returned to the layout will be returned in the same layer as the portal and not in the trains originally assigned layer. Trains that are produced by a portal will be assigned to the same layer as the portal. This has <span style="background-color: yellow; font-weight: 700;">&nbsp;possibly always been the case with portals&nbsp;</span> but was probably unnoticed until the arrival of the '''UDS'''. It seems to have no other noticeable effect on trains.<br>
 
A train that is driven into a portal and later returned to the layout will be returned in the same layer as the portal and not in the trains originally assigned layer. Trains that are produced by a portal will be assigned to the same layer as the portal. This has <span style="background-color: yellow; font-weight: 700;">&nbsp;possibly always been the case with portals&nbsp;</span> but was probably unnoticed until the arrival of the '''UDS'''. It seems to have no other noticeable effect on trains.<br>
Line 581: Line 672:
 
If you save the '''Route''' after switching to '''Surveyor''' then the train will be saved in the '''Route''' and not in the '''Session'''. If this is an issue then the remedy is to open the property dialogue window of any wagon in the train after it has left the portal and change its assigned layer to the correct one. This will set all vehicles in that train to the same correct layer.<br>
 
If you save the '''Route''' after switching to '''Surveyor''' then the train will be saved in the '''Route''' and not in the '''Session'''. If this is an issue then the remedy is to open the property dialogue window of any wagon in the train after it has left the portal and change its assigned layer to the correct one. This will set all vehicles in that train to the same correct layer.<br>
  
'''Note:''' It is not recommended that you solve this by moving portals to a '''Session Layer''' if you have multiple '''Sessions''' because the portals will then only appear in the '''Session''' that contains the portals.
+
'''Note:''' It is not recommended that you solve this by moving portals to a '''Session Layer''' if you have multiple '''Sessions''' because the portals will then only appear in the '''Session''' that contains the portals.</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="bottom"></span>&nbsp;</td>
 
<td width=729><span id="bottom"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepQuestions|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepQuestions|alt=Next Up|Top]]</td>
 
<td width=75>&nbsp;</td>
 
<td width=75>&nbsp;</td>
 
<td width=75>&nbsp;</td>
 
<td width=75>&nbsp;</td>
Line 598: Line 691:
 
<table cellpadding=4 bgcolor=#ffffff>
 
<table cellpadding=4 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:TrainzWiki.png|link=]]</td>
+
<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>
 
<span style="font-size: 17px; font-weight: 700;">More Tutorials and Guides to Using Trainz</span><br>

Revision as of 21:24, 16 September 2023

The information in this Wiki Page applies to TRS19 Platinum Edition, Trainz Plus and TRS22. Older versions of Trainz, including T:ANE and TRS19 (standard), do not have the UDS feature described in this document. A more detailed description of the UDS can be found on the Trainz Wiki Page WikiLink.PNG Unified_Driver_Surveyor.
BlueDot10x10.png The UDS ( U niversal  D river  S urveyor) Interface allows you to switch instantly between Surveyor and Driver modes without having to reload


Contents

DotPoint.JPG The UDS is only found in TRS19 Platinum Edition, Trainz Plus and TRS22
DotPoint.JPG It provides a method of quickly switching from Driver mode to Surveyor mode and back to Driver again without having to restart a running session after each switch
DotPoint.JPG After switching from Driver to Surveyor and editing you can save your edits before switching back into Driver but it is recommended that you save your work as a new session (unless you really do want to overwrite the original session)
DotPoint.JPG The virtual location of all consists is now stored as part of the Session even if the consists themselves are placed in the Route
DotPoint.JPG The Session Editor has a feature that allows you to reset any or all of the Session Rules before restarting a session


      Next Down Bottom

What is the UDS Interface?

UDS stands for  U niversal  D river  S urveyor and is an "interface" or option built into TRS19 Platinum Edition, Trainz Plus and TRS22 that allows you to jump seamlessly from Driver into Surveyor and then back into Driver again to resume a session at the point where you left it. There is no need to restart a Driver session from the very beginning.



The Scenario:

You are in Driver mode testing out a route and session when you discover a problem.
UDS-Scenario1.png Previously (before the UDS) your only options would be to choose one of the following:-

Options:

Ablue.png ignore the problem (if possible) to continue the session in Driver and fix the problem later, OR
Bblue.png immediately halt the session to fix the problem now


In both cases you would have to:-

Steps: To fix the problem

DotPoint1.JPG terminate Driver and exit back to the Main Menu
DotPoint2.JPG load the route into Surveyor and try to recall exactly where the problem is located
DotPoint3.JPG locate and fix the problem
DotPoint4.JPG save and exit Surveyor
DotPoint5.JPG restart the session in Driver from the beginning (a bit tough if you were 2 hrs or more into the session)


BlueDot10x10.png The UDS interface allows you to switch, via a menu option, directly to Surveyor without having to stop and exit Driver mode first


When using the UDS you switch from Driver to Surveyor with the currently active Driver consist still as the focus and at the place it was located when you switched into Surveyor from Driver.
UDS-Scenario2.png All the Surveyor tools and options are available for you to use, including the Session Editor (more on that later).
UDS-Scenario3.png You use the Surveyor tools to fix the problem, such as deleting (as shown left), moving or adding a scenery object.

You can then (if you wish) save the edited route and/or session (again there will be more on that later).

UDS-Scenario4.png You then switch back into Driver to continue driving the session with the problem fixed.


  Top Next Up Next Down Bottom

Switching Modes

DotPoint.JPG Driver Mode to Surveyor
  UDS-DriverToSurveyor.png
Steps: To switch from Driver to Surveyor:-
DotPoint1.JPG Open the Tools Menu and select  Surveyor Mode  OR press  Ctrl  +  F1 
Warning:
Stop.PNG When you switch to Surveyor mode the Pause option (at the top of the Tools menu) will be automatically turned ON. If you turn this option OFF in Surveyor mode then any consists that were moving in Driver mode (and were then paused when you switched) will start moving again. This will almost certainly cause problems such as derailments.

It also means that ALL other animation effects (smoke, procedural track switch blades, animated scenery assets, sounds, etc) will also be PAUSED.


DotPoint.JPG Surveyor Mode to Driver  
  UDS-SurveyorToDriver.png
Steps: To switch from Surveyor to Driver:-
DotPoint1.JPG Open the Tools Menu and select  Driver Mode  OR press  Ctrl  +  F2 
DotPoint2.JPG If the Paused option is ON in Surveyor mode (the default condition unless you have turned it OFF) then the simulation will be paused and the Paused message will appear on the screen when you switch to Driver mode. Hit the  P  key to Unpause and resume the simulation.


NotePad.PNG The Undo command ( Ctrl  +  Z ) can be used in Surveyor Mode but not in Driver Mode.


  Top Next Up Next Down Bottom

Saving

NotePad.PNG Notes:

An important change that has been introduced by the UDS is that train vehicle placement is now saved as part of the Session, even if those vehicles have been placed in Route Layers.
PencilTips.PNG It is strongly recommended that all consists be placed into a Session Layer and become part of a Session instead of the Route


Warning:
Stop.PNG If you decide to save your Surveyor edits and select the option to

UDS-OverwriteExistingSession.png

then you will OVERWRITE (a nicer way of saying DESTROY) your starting or original Session


Most of the problems users seem to be experiencing with the UDS, judging from the posts in the Trainz Forums, is when saving their edited Driver session after switching to Surveyor mode.


NotePad.PNG Notes:

DotPoint.JPG Using Driver Mode involves driving consists (either manually or through the AI) and activating session rules. This will change the session parameters
DotPoint.JPG Overwriting the Session will save the consist locations and Session Rules in their new positions/conditions


When you are in Driver Mode at least one of the consists will probably be moving. Some of the Session rules may have already been completed while others may still be running or waiting for events (e.g. triggers to be activated). If, after switching to Surveyor Mode, you then choose to save using the Overwrite existing session option then you will be replacing your original starting Session with a new one with the consists saved in their new positions and the Session rules saved in their new states. So when you later load and restart the Session things will not be the same as they were in the original or starting Session.
 Unless you have a particular reason for overwriting the original Session then the recommended save options are:-
Line740.png
Option Ablue.png Do Not Save the Session
  UDS-DoNotSaveSession.png
Steps: To save the Route only:-
DotPoint1.JPG Left Click the checkbox  Do not save session 

This will save the Route only, using its existing name and it will overwrite the original route. This will save any edits that you have made to the Route but not to the Session.

Line740.png
Option Bblue.png Create a New Session
  UDS-CreateNewSession.png
Steps: To save the Route and a NEW Session:-
DotPoint1.JPG Left Click the checkbox  Create new session 
DotPoint2.JPG Enter a name for the new session

This will save the Route using its existing name and it will overwrite the original route. It will also save the Session using the name you enter in the text box below the checkbox (Stage 3 in the example shown). The original Session will not be altered. This is useful when you want to test out changes to consists, industry settings, Rules, driver commands, etc but do not want to destroy the original Session.

Line740.png
PencilTips.PNG If you have scenery assets (stationary objects) in a Session Layer that you will want to edit after switching from Driver to Surveyor and will need to save those edits but don't want to destroy your starting Session data, then:-
Steps:
DotPoint1.JPG move that Session Layer to the Route Layer Group before starting the Session in Driver. See WikiLink.PNG Moving Layers for more details
DotPoint2.JPG switch from Driver to Surveyor and edit when required. You can safely edit any Route Layer which now includes the moved Session layer
DotPoint3.JPG after each edit you can save (Overwrite) the Route but do not save the Session. Use Option Ablue.png above

When you have completed all the editing, saving and switching between Driver and Surveyor, then:-

Steps:
DotPoint1.JPG exit back to the Surveyor/Driver main screen
DotPoint2.JPG reload the original Session (the saved Session edits will be in the Route that will be loaded along with the Session)
DotPoint3.JPG move the layer from the Route Layer Group back to the Session Layer Group. See WikiLink.PNG Moving Layers for more details
DotPoint4.JPG save (Overwrite) both the Route and the Session


  Top Next Up Next Down Bottom

Resetting the Session Rules

BlueDot10x10.png After you switch from Driver Mode to Surveyor Mode it may be necessary to restart or reset some of the Session Rules


As mentioned above, when Driver Mode is running some of the Session rules may be completed while others may still be running or waiting for certain events (e.g. triggers to be activated). When you switch to Surveyor Mode these rules may be in a different state compared to what they were at the start of the Session. When you restart Driver Mode these rules may not be in a useful condition.

The Session Editor built into all Trainz versions allows you to add, delete and modify the rules that will operate during a Session.


LinkWiki.PNG Information on the Session Editor can be found at:-


To open the Session Editor open the Edit menu and select  Edit Session 
SessionEditMenuSP1.png

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


  Top Next Up Next Down Bottom

Some Questions Answered

Question.PNG I have only edited assets that are in the Route layers but selecting Save always sets the option to "Overwrite exiting session" as the default. Why?


Many scenery assets actually have their properties stored in the Session, even when the assets themselves are in a Route layer. Editing the properties of these assets is considered to be a change to the Session. These include:-
DotPoint.JPG junction switches - the left/right switch direction is stored in the Session (but the switch default direction is stored in the Route)
DotPoint.JPG industries - the commodities and quantities loaded/unloaded are stored in the Session
DotPoint.JPG industry enabled wagons - the commodities and quantities carried are stored in the Session
DotPoint.JPG consist locations - this is stored in the Session (TRS19 Platinum Edition, Trainz Plus and TRS22 only
DotPoint.JPG named route objects - while the name is stored in the Route, adding or changing the name is treated as a change to the Session
If you have not altered any Session data or assets that have been placed in a session layer then you can ignore the request to save the Session as well as the Route. Changing the name of an asset, for example, does not alter any session data.


Question.PNG Interlocking Towers (including Enhanced Interlocking Towers) show paths as "not editable" after switching to Surveyor Mode. Why?


If you make the switch from Driver Mode to Surveyor Mode after an IT/EIT path has been activated (but not yet cleared or cancelled) then you will be unable to edit that path. In addition, you will not be able to add new paths to an IT/EIT that has an open active path.
Pierre (pguy), the creator of the EIT asset and associated rules, has a detailed description of this and some possible solutions in a Trainz Forum post at:- EITs and the UDS


Question.PNG Can I add new trains or replace existing trains after switching to Surveyor mode?


You can add additional trains and replace existing ones when in Surveyor mode but it is advised that:-
DotPoint.JPG the Paused option be set ON (the default condition) in Surveyor mode, and
DotPoint.JPG you may have to reset the Driver Setup Rule in the Session Editor particularly if you have added/edited driver commands to the new or altered consist


Question.PNG Does the UDS change how portals work?


This issue is now under investigation by N3V

A train that is driven into a portal and later returned to the layout will be returned in the same layer as the portal and not in the trains originally assigned layer. Trains that are produced by a portal will be assigned to the same layer as the portal. This has  possibly always been the case with portals  but was probably unnoticed until the arrival of the UDS. It seems to have no other noticeable effect on trains.

This could become an issue if you make the switch from Driver to Surveyor after a train has been returned to the layout from a portal. For example, if a train is originally in a Session Layer (as recommended for TRS19 Platinum Edition, Trainz Plus and TRS22) then it is part of a Session. If it is returned from a portal that is in a Route Layer then it will now be in the same Route Layer as the portal and it will be part of the Route, not part of the Session.

If you save the Route after switching to Surveyor then the train will be saved in the Route and not in the Session. If this is an issue then the remedy is to open the property dialogue window of any wagon in the train after it has left the portal and change its assigned layer to the correct one. This will set all vehicles in that train to the same correct layer.

Note: It is not recommended that you solve this by moving portals to a Session Layer if you have multiple Sessions because the portals will then only appear in the Session that contains the portals.


  Top Next Up    


Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz


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


Personal tools