How to Use Navigation Point Rules

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(added Wait on Navigation Point rule)
m (→‎Trainz Wiki)
 
(123 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. It describes how to configure the various '''Navigation Point Rules'''.
  
−
The screenshots shown below give examples of the Navigation Point Rules.
+
<table width=1000>
 +
<tr valign="top">
 +
<td width=250>
 +
__TOC__
 +
</td>
 +
<td>
 +
<table bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>'''Navigation Points''' are icons that appear at set track locations or on set rail vehicles that indicate destinations for user driven trains and tasks to be performed</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The navigation points are created and controlled by the set of Session rules that are described in this document</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding=4 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
For examples of how to use these rules in '''Trainz''' Sessions, see the '''Trainz Wiki Page''' at:-<br>
 +
* '''[[How to Use Navigation Point Rules (Applications)]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
  
−
==='''Example 1: Navigation Display Rule'''===
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepDisplay"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepHide|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
The '''[[#Navigation Display Rule|Navigation Display Rule]]''' settings shown in this example will direct TANE to create a set of Navigation Points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.
+
='''Navigation Display Rule'''=
 +
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Navigation Set Hide/Show Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Display Rule|Navigation Display Rule]]''' create a '''set of Navigation Points'''</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=996 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>A navigation set must be created by the '''Navigation Display Rule''' before it can be used by the other navigation rules</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Multiple sets can be created by adding additional copies of this rule - one copy for each set</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>This rule creates the navigation set and displays it. If you have created multiple sets then all of them will be displayed unless you use the '''Navigation Set Hide/Show Rule''' to hide those sets you do not want to be seen immediately</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=640>[[image:NavDisplaySetDialogUpper.JPG|link=]]</td>
 +
<td>
 +
<table width=360 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=356 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 '''Upper''' section of the Rule Dialogue Box identifies the '''Navigation Display Set''' and how it will operate</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
  
−
A navigation set must be created before it can be used by the other navigation rules.
+
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 +
<table>
 +
<tr valign="top">
 +
<td colspan=2>'''For the Navigation Set:'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' Each Navigation Point Set must have a '''unique ID code'''. This consists of any text characters <span style="background-color: red; color: white; font-weight: 700; font-size: 15px">&#160;EXCEPT&#160;</span> the '''SPACE''' character and '''UPPER CASE''' characters</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Train (optional):''' You can add a specific locomotive that this Navigation Point set will be applied to</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Navigation mode:''' Select '''one''' of three options:-
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:PortalOptionButtonEmpty.PNG|link=]] '''All points must be completed in sequence''' - the order of the points listed below is the order in which they must be executed. No exceptions</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:PortalOptionButtonEmpty.PNG|link=]] '''Points will be completed in sequence, but can be skipped''' - the order of the points below is the order in which they must be executed but points can be skipped. You cannot go back to complete a missed point</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:PortalOptionButtonEmpty.PNG|link=]] '''All points must be completed but in any order''' - the order is not important but no points can be missed. All the Navigation Points in the set will be displayed when this option is selected</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
  
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=640>[[image:NavDisplaySetDialogLower.JPG|link=]]</td>
 +
<td>
 +
<table width=360 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=356 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 '''lower''' section of the Rule Dialogue Box defines the individual '''Navigation Points''' in this '''Navigation Display Set'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td colspan=2>'''For each Navigation Point:'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Location:''' - this can be a trackmark, a trigger, track object or a rolling stock vehicle</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Icon:''' - a graphic icon to be displayed representing the Navigation point. Icons are selected from a preset list</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Display text:''' - a short message up to 25 characters long</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Style:''' - the operational style of the Navigation Point. Select '''one''' of:-
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Automatic''' - the Navigation Point will be completed and disappear when the consist reaches its location</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Manual''' - the Navigation Point must be completed by another rule</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Require Stop''' - the Navigation Point will be completed and disappear when the consist stops at its location</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>Navigation points can be added and deleted, but their order cannot be changed
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Add Navigation Point''' - new points are added by a <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the '''+''' icon. The new point will be inserted in the line below</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Delete Navigation Point''' - existing points can be deleted by <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the '''x''' icon</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 
<tr>
 
<tr>
−
<td>[[file:NavDisplaySetDialog.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*'''Unique set ID:''' Each Navigation Point Set must have a unique ID code. This must consist of text characters using any combination of lowercase keyboard symbols except the SPACE character.
+
<table> <!-- BEGIN Nav Buttons Table -->
−
*'''Train (optional):''' You can add a specific locomotive that this Navigation Point set will be applied to.
+
<tr valign="top">
−
*'''Navigation mode:''' Select '''one''' of three options:-
+
<td width=729><span id="stepHide"></span>&#160;</td>
−
**'''All points must be completed in sequence''' - the order of the points listed below is the order in which they must be executed. No exceptions.
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
**'''Points will be completed in sequence, but can be skipped''' - the order of the points below is the order in which they must be executed but points can be skipped. You cannot go back to complete a missed point.
+
<td width=75>[[image:NextUp.png|link=#stepDisplay|alt=Next Up|Top]]</td>
−
**'''All points must be completed but in any order''' - the order is not important but no points can be missed. All the Navigation Points in the set will be displayed when this option is selected.
+
<td width=75>[[image:NextDown.png|link=#stepClear|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
For each Navigation Point you must identify ...
+
='''Navigation Set Hide/Show Rule'''=
−
*'''Location:''' - this can be a trackmark, a trigger, track object or a rolling stock vehicle.
+
−
*'''Icon:''' - a graphic icon to be displayed representing the Navigation point.
+
−
*'''Display text:''' - a short message up to 25 characters long.
+
−
*'''Style:''' - the operation style of the Navigation Point. Select '''one''' of:-
+
−
**'''Automatic''' - the Navigation Point will be completed and disappear when the consist reaches its location.
+
−
**'''Manual''' - the Navigation Point must be completed by another rule.
+
−
**'''Require Stop''' - the Navigation Point will be completed and disappear when the consist stops at its location
+
−
Navigation points can be added and deleted, but their order cannot be changed.
+
−
*'''Add Navigation Point''' - new points are added by clicking the '''+''' icon. The new point will be inserted in the line below.
+
−
*'''Delete Navigation Point''' - existing points can be deleted by clicking the '''x''' icon.
+
  
−
==='''Example 2: Navigation Set Hide/Show Rule'''===
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Navigation Set Hide/Show Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' hides and displays the navigation sets created by the '''Navigation Display Rule'''</td>
 +
</tr>
 +
</table>
  
−
The '''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' hides and displays the navigation sets created by the '''Navigation Display Rule'''.
+
<table width=1000>
 +
<tr valign="top">
 +
<td width=500>[[image:NavPointHideDialog.JPG|500px|link=]]</td>
 +
<td>
 +
<table width=500 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=496 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>
 +
----
 +
All '''Navigation Sets''' created by the '''Navigation Display Rule''' are visible in Driver by default. If you want to hide any sets until they are needed then use this rule to '''Hide''' them immediately after the sets have been created.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
  
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Hide/Show:''' <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> to select one of these two options:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td> '''Hide''' will make the entire set invisible</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Show''' will display the next navigation point or more depending on the '''Navigation Mode''' (see [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]''' above) that has been selected for this particular set</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set to be hidden or shown. This must be the same ID as entered in the [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]''' and consists of any text characters <span style="background-color: red; color: white; font-weight: 700; font-size: 15px">&#160;EXCEPT&#160;</span> the '''SPACE''' character and '''UPPER CASE''' characters</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 
<tr>
 
<tr>
−
<td>[[file:NavPointHideDialog.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and use text characters with any combination of lowercase keyboard symbols except the SPACE character.
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepClear"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepHide|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepComplete|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
==='''Example 3: Navigation Set Clear Rule'''===
+
='''Navigation Set Clear Rule'''=
  
−
The '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' clears or completes any uncompleted Navigation Points in a set created by the '''Navigation Display Rule'''.
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Navigation Set Clear Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor</td>
 +
</tr>
 +
<tr>
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' clears or completes any uncompleted Navigation Points in a set created by the '''Navigation Display Rule'''</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=500>[[image:NavSetClearDialog.JPG|500px|link=]]</td>
 +
<td>
 +
<table width=500 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=496 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>
 +
----
 +
Visible '''Navigation Sets''' will be cleared automatically when they have been completed. However, you can clear an unfinished set at any time using this rule.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
  
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set to be cleared. This must be the same ID as entered in the [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]''' and consists of any text characters <span style="background-color: red; color: white; font-weight: 700; font-size: 15px">&#160;EXCEPT&#160;</span> the '''SPACE''' character and '''UPPER CASE''' characters</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 
<tr>
 
<tr>
−
<td>[[file:NavSetClearDialog.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and use text characters with any combination of lowercase keyboard symbols except the SPACE character.
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepComplete"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepClear|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepCheck|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
==='''Example 4: Navigation Point Complete Rule'''===
+
='''Navigation Point Complete Rule'''=
  
−
The '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' clears or completes the selected Navigation Point in a set created by the '''Navigation Display Rule'''. This rule is used to complete Navigation Points with their ''Style'' property set to '''manual'''.
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Navigation Point Complete Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' clears or completes the selected '''Navigation Point''' in a set created by the [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]'''. This rule is used to complete Navigation Points with their ''Style'' property set to '''manual'''</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=500>[[image:NavPointCompleteDialog.JPG|500px|link=]]</td>
 +
<td>
 +
<table width=500 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=496 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>
 +
----
 +
'''Navigation Points''' with their '''Style:''' set to '''Automatic''' or '''Require Stop''' will be cleared automatically when they have been completed. Those set to '''Manual''' must be cleared by using this rule.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Navigation Point Number'''  A valid number identifying the particular Navigation Point to be completed. If the number entered does not exist then the rule will be ignored</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set. This must be the same ID as entered in the [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]''' and consists of any text characters <span style="background-color: red; color: white; font-weight: 700; font-size: 15px">&#160;EXCEPT&#160;</span> the '''SPACE''' character and '''UPPER CASE''' characters</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
  
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepCheck"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepComplete|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepWait|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 +
='''Navigation Set Check Rule'''=
 +
 +
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Navigation Set Check Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. It is a [[image:WikiLink.PNG|link=]] '''[[How_to_Use_Parent_and_Child_Rules|Parent Rule]]'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Set Check Rule|Navigation Set Check Rule]]''' checks if the specified '''Navigation Set''' has been completed, or not completed, then executes any following child rules</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=500>[[image:NavSetCheckDialog.JPG|500px|link=]]</td>
 +
<td>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<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>
 +
----
 +
This rule allows you to check if all the '''Navigation Points''' in an identified '''Navigation Point Set''' have been completed or not. It is a '''Parent Rule''' so it can be used to perform other actions (execute '''Child Rules''') based on the result of the check</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set to be checked. This must be the same ID as entered in the [[image:PageLink.PNG|link=]] '''[[#stepDisplay|Navigation Display Rule]]''' and consists of any text characters <span style="background-color: red; color: white; font-weight: 700; font-size: 15px">&#160;EXCEPT&#160;</span> the '''SPACE''' character and '''UPPER CASE''' characters</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Complete/Incomplete:''' <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> to select one of these two options. The selected Navigation Point Set will be tested to see if it has been '''Completed''' (all of its Navigation Points have been cleared/completed) or if it is '''Incomplete''' (not all of its Navigation Points have been cleared/completed)</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 
<tr>
 
<tr>
−
<td>[[file:NavPointCompleteDialog.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and use text characters with any combination of lowercase keyboard symbols except the SPACE character.
+
<table> <!-- BEGIN Nav Buttons Table -->
−
*'''Navigation Point Number:''' must be a point within the set.
+
<tr valign="top">
 +
<td width=729><span id="stepWait"></span>&#160;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepCheck|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 -->
  
−
==='''Example 5: Wait on Navigation Point Rule'''===
+
='''Wait on Navigation Point Rule'''=
  
−
The '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' waits until the specified Navigation Point in the specified set has been completed then executes any following child rules.
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The '''Wait on Navigation Point Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. It is a [[image:WikiLink.PNG|link=]] '''[[How_to_Use_Parent_and_Child_Rules|Parent Rule]]'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' waits until the specified Navigation Point in the specified set has been completed then executes any following child rules</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=500>[[image:NavPointWaitDialog.JPG|500px|link=]]</td>
 +
<td>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<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>
 +
----
 +
This rule allows you to set a '''Wait''' condition until a particular '''Navigation Point''' in a specific '''Navigation Point Set''' has been completed. It is a '''Parent Rule''' so it can be used to perform other actions (execute '''Child Rules''') when the specific '''Navigation Point''' has been completed</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
  
 +
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Navigation Point Number'''  A valid number identifying the particular Navigation Point to be completed. If the number entered does not exist then the rule will be ignored</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set. This must be the same ID as entered in the '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 
<tr>
 
<tr>
−
<td>[[file:NavPointWaitDialog.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and use text characters with any combination of lowercase keyboard symbols except the SPACE character.
+
<table> <!-- BEGIN Nav Buttons Table -->
−
*'''Navigation Point Number:''' must be a point within the set.
+
<tr valign="top">
 +
<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=#stepWait|alt=Next Up|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>&#160;</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
----
 +
----
  
−
==='''Related Trainz Wiki Links:'''===
+
='''Trainz Wiki'''=
−
*'''[[Controlling Junctions in Sessions|Controlling Junctions in Sessions]]
+
<table width=1000>
−
*'''[[Message Popup Rule Applications|Message Popup Rule Applications]]'''
+
<tr valign="top">
−
*'''[[MiniBrowser|Trainz HTML Reference]]'''
+
<td>
−
*'''[[Navigation Point Applications|Navigation Point Applications]]'''
+
<table width=500 cellpadding=2 bgcolor=#ffffff>
−
*'''[[Using Variables in Sessions - Examples|Using Variables in Sessions - Examples]]
+
<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]]'''
 +
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) 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 Session Editor|How to Use the Session Editor]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
----
 +
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in May 2018 and was last updated as shown below.
 +
----
 +
[[Category:How-to guides]][[Category:Rules]]

Latest revision as of 08:17, 23 November 2023

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22. It describes how to configure the various Navigation Point Rules.

Contents
BlueDot10x10.png Navigation Points are icons that appear at set track locations or on set rail vehicles that indicate destinations for user driven trains and tasks to be performed
BlueDot10x10.png The navigation points are created and controlled by the set of Session rules that are described in this document


LinkWiki.PNG

For examples of how to use these rules in Trainz Sessions, see the Trainz Wiki Page at:-
  Top   Next Down Bottom

[edit] Navigation Display Rule

BlueDot10x10.png The Navigation Set Hide/Show Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor
BlueDot10x10.png The WikiLink.PNG Navigation Display Rule create a set of Navigation Points


NotePad.PNG Notes:
DotPoint.JPG A navigation set must be created by the Navigation Display Rule before it can be used by the other navigation rules
DotPoint.JPG Multiple sets can be created by adding additional copies of this rule - one copy for each set
DotPoint.JPG This rule creates the navigation set and displays it. If you have created multiple sets then all of them will be displayed unless you use the Navigation Set Hide/Show Rule to hide those sets you do not want to be seen immediately


NavDisplaySetDialogUpper.JPG
NotePad.PNG Notes:
The Upper section of the Rule Dialogue Box identifies the Navigation Display Set and how it will operate
Gears.PNG Settings:
For the Navigation Set:
BlackDot10x10.png Set ID: Each Navigation Point Set must have a unique ID code. This consists of any text characters  EXCEPT  the SPACE character and UPPER CASE characters
BlackDot10x10.png Train (optional): You can add a specific locomotive that this Navigation Point set will be applied to
BlackDot10x10.png Navigation mode: Select one of three options:-
PortalOptionButtonEmpty.PNG All points must be completed in sequence - the order of the points listed below is the order in which they must be executed. No exceptions
PortalOptionButtonEmpty.PNG Points will be completed in sequence, but can be skipped - the order of the points below is the order in which they must be executed but points can be skipped. You cannot go back to complete a missed point
PortalOptionButtonEmpty.PNG All points must be completed but in any order - the order is not important but no points can be missed. All the Navigation Points in the set will be displayed when this option is selected
NavDisplaySetDialogLower.JPG
NotePad.PNG Notes:
The lower section of the Rule Dialogue Box defines the individual Navigation Points in this Navigation Display Set
Gears.PNG Settings:
For each Navigation Point:
BlackDot10x10.png Location: - this can be a trackmark, a trigger, track object or a rolling stock vehicle
BlackDot10x10.png Icon: - a graphic icon to be displayed representing the Navigation point. Icons are selected from a preset list
BlackDot10x10.png Display text: - a short message up to 25 characters long
BlackDot10x10.png Style: - the operational style of the Navigation Point. Select one of:-
BlackDot10x10.png Automatic - the Navigation Point will be completed and disappear when the consist reaches its location
BlackDot10x10.png Manual - the Navigation Point must be completed by another rule
BlackDot10x10.png Require Stop - the Navigation Point will be completed and disappear when the consist stops at its location
Navigation points can be added and deleted, but their order cannot be changed
BlackDot10x10.png Add Navigation Point - new points are added by a Left Click on the + icon. The new point will be inserted in the line below
BlackDot10x10.png Delete Navigation Point - existing points can be deleted by Left Click on the x icon
  Top Next Up Next Down Bottom

[edit] Navigation Set Hide/Show Rule

BlueDot10x10.png The Navigation Set Hide/Show Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor
BlueDot10x10.png The WikiLink.PNG Navigation Set Hide/Show Rule hides and displays the navigation sets created by the Navigation Display Rule
NavPointHideDialog.JPG
NotePad.PNG Notes:
All Navigation Sets created by the Navigation Display Rule are visible in Driver by default. If you want to hide any sets until they are needed then use this rule to Hide them immediately after the sets have been created.
Gears.PNG Settings:
BlackDot10x10.png Hide/Show: Left Click to select one of these two options:-
BlackDot10x10.png Hide will make the entire set invisible
BlackDot10x10.png Show will display the next navigation point or more depending on the Navigation Mode (see PageLink.PNG Navigation Display Rule above) that has been selected for this particular set
BlackDot10x10.png Set ID: The unique Navigation Point Set ID code for the set to be hidden or shown. This must be the same ID as entered in the PageLink.PNG Navigation Display Rule and consists of any text characters  EXCEPT  the SPACE character and UPPER CASE characters
  Top Next Up Next Down Bottom

[edit] Navigation Set Clear Rule

BlueDot10x10.png The Navigation Set Clear Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor
BlueDot10x10.png The WikiLink.PNG Navigation Set Clear Rule clears or completes any uncompleted Navigation Points in a set created by the Navigation Display Rule


NavSetClearDialog.JPG
NotePad.PNG Notes:
Visible Navigation Sets will be cleared automatically when they have been completed. However, you can clear an unfinished set at any time using this rule.
Gears.PNG Settings:
BlackDot10x10.png Set ID: The unique Navigation Point Set ID code for the set to be cleared. This must be the same ID as entered in the PageLink.PNG Navigation Display Rule and consists of any text characters  EXCEPT  the SPACE character and UPPER CASE characters
  Top Next Up Next Down Bottom

[edit] Navigation Point Complete Rule

BlueDot10x10.png The Navigation Point Complete Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor
BlueDot10x10.png The WikiLink.PNG Navigation Point Complete Rule clears or completes the selected Navigation Point in a set created by the PageLink.PNG Navigation Display Rule. This rule is used to complete Navigation Points with their Style property set to manual


NavPointCompleteDialog.JPG
NotePad.PNG Notes:
Navigation Points with their Style: set to Automatic or Require Stop will be cleared automatically when they have been completed. Those set to Manual must be cleared by using this rule.
Gears.PNG Settings:
BlackDot10x10.png Navigation Point Number A valid number identifying the particular Navigation Point to be completed. If the number entered does not exist then the rule will be ignored
BlackDot10x10.png Set ID: The unique Navigation Point Set ID code for the set. This must be the same ID as entered in the PageLink.PNG Navigation Display Rule and consists of any text characters  EXCEPT  the SPACE character and UPPER CASE characters
  Top Next Up Next Down Bottom

[edit] Navigation Set Check Rule

BlueDot10x10.png The Navigation Set Check Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor. It is a WikiLink.PNG Parent Rule
BlueDot10x10.png The WikiLink.PNG Navigation Set Check Rule checks if the specified Navigation Set has been completed, or not completed, then executes any following child rules


NavSetCheckDialog.JPG
NotePad.PNG Notes:
This rule allows you to check if all the Navigation Points in an identified Navigation Point Set have been completed or not. It is a Parent Rule so it can be used to perform other actions (execute Child Rules) based on the result of the check
Gears.PNG Settings:
BlackDot10x10.png Set ID: The unique Navigation Point Set ID code for the set to be checked. This must be the same ID as entered in the PageLink.PNG Navigation Display Rule and consists of any text characters  EXCEPT  the SPACE character and UPPER CASE characters
BlackDot10x10.png Complete/Incomplete: Left Click to select one of these two options. The selected Navigation Point Set will be tested to see if it has been Completed (all of its Navigation Points have been cleared/completed) or if it is Incomplete (not all of its Navigation Points have been cleared/completed)
  Top Next Up   Bottom

[edit] Wait on Navigation Point Rule

BlueDot10x10.png The Wait on Navigation Point Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor. It is a WikiLink.PNG Parent Rule
BlueDot10x10.png The WikiLink.PNG Wait on Navigation Point Rule waits until the specified Navigation Point in the specified set has been completed then executes any following child rules


NavPointWaitDialog.JPG
NotePad.PNG Notes:
This rule allows you to set a Wait condition until a particular Navigation Point in a specific Navigation Point Set has been completed. It is a Parent Rule so it can be used to perform other actions (execute Child Rules) when the specific Navigation Point has been completed
Gears.PNG Settings:
BlackDot10x10.png Navigation Point Number A valid number identifying the particular Navigation Point to be completed. If the number entered does not exist then the rule will be ignored
BlackDot10x10.png Set ID: The unique Navigation Point Set ID code for the set. This must be the same ID as entered in the Navigation Display Rule and consists of any text characters EXCEPT the SPACE character and UPPER CASE characters
  Top Next Up    

[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
LinkWiki.PNG

Related Links
How to Use the Session Editor

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

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