How to Use Navigation Point Rules

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m
Line 1: Line 1:
−
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. It gives examples of how to use the various '''Navigation Point Rules''' in Sessions.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. It describes how to configure the various '''Navigation Point Rules'''.
  
−
<table>
 
−
<tr valign="top">
 
−
<td>
 
−
__TOC__
 
−
</td>
 
−
<td width=700>
 
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:LinkWiki.PNG|link=]]</td>
 
<td>[[file:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
−
For information on how to configure these rules in '''Trainz''' see the '''Trainz Wiki Page''' at:-<br>
+
For examples of how to use these rules in '''Trainz''' Sessions, see the '''Trainz Wiki Page''' at:-<br>
−
:*'''[[How to Use Navigation Point Rules]]'''
+
* '''[[How to Use Navigation Point Rules (Applications)]]'''
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
</td>
+
<br>
 +
 
 +
__TOC__
 +
<br>
 +
<table cellpadding=4 bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG|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>
 
</table>
 
</table>
 +
<br>
 +
The navigation points are created and controlled by the set of Session rules that are described in this document.
 
<br>
 
<br>
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepUnused"></span>&nbsp;</td>
+
<td width=729><span id="stepDisplay"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=75>&nbsp;</td>
 
<td width=75>&nbsp;</td>
−
<td width=75>[[file:NextDown.png|link=#stepIncomplete|alt=Next Down|Next Down]]</td>
+
<td width=75>[[file:NextDown.png|link=#stepHide|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
  
−
='''Application 1: Clearing Unused Navigation Sets'''=
+
='''Navigation Display Rule'''=
  
−
<table cellpadding=4 bgcolor=#ffffff>
+
The [[file:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Navigation Display Rule|Navigation Display Rule]]''' settings shown in this example will direct '''Trainz''' to create a '''set of Navigation Points'''.
−
<tr valign="top">
+
<table cellpadding=4 bgcolor=#c1e7e7>
−
<td width="58">[[file:magnifier.png|link=]]</td>
+
<tr valign="top>
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
<td>[[file:DotPoint.JPG|link=]]</td>
−
----</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>
−
</table>
+
<tr valign="top>
−
A user decides to ignore navigation points at a location and drives straight through. When the consist passes over a trigger the unused navigation point sets are removed.
+
<td>[[file:DotPoint.JPG|link=]]</td>
−
<br><br>
+
<td>Multiple sets can be created by adding additional copies of this rule - one copy for each set</td>
−
<table cellpadding=4 bgcolor=#ffffff>
+
</tr>
−
<tr valign="top">
+
<tr valign="top>
−
<td width="58">[[file:conditions.PNG|link=]]</td>
+
<td>[[file:DotPoint.JPG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Preconditions:'''</span><br>
+
<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>
−
----</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' creates the navigation point sets.
 
 
<br>
 
<br>
−
<table cellpadding=4 bgcolor=#ffffff>
+
The '''Navigation Display Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor.
 +
<br>
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<td>[[file:NavDisplaySetDialog.JPG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
*'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' to trigger the event.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Set_Clear_Rule|Navigation Set Clear Rule]]''' to manually complete navigation sets.
 
−
<br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
'''For the Navigation Set:'''<br>
 +
*'''Set ID:''' Each Navigation Point Set must have a '''unique ID code'''. This consists of any text characters&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;EXCEPT&nbsp;</span>&nbsp;the '''SPACE''' character and '''UPPER CASE''' characters.
 +
*'''Train (optional):''' You can add a specific locomotive that this Navigation Point set will be applied to.
 +
*'''Navigation mode:''' Select '''one''' of three options:-
 +
::[[file: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.
 +
::[[file: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.
 +
::[[file: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>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<table>
+
 
 +
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
−
<td>[[file:NavClearSets.JPG|link=]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
<br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
'''For each Navigation Point:'''<br>
 +
*'''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. Icons are selected from a preset list.
 +
*'''Display text:''' - a short message up to 25 characters long.
 +
*'''Style:''' - the operational 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.
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''Line 1: Trigger Check''' the event is triggered by the consist leaving the location with the navigation points.
 
−
**'''Line 2: Navigation Set Clear''' a navigation set is manually completed and any visible icons are removed. This can be performed on any sets that have already been completely or partially completed.
 
−
Lines 3 and 4 repeat the process for any other navigation sets.
 
  
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepIncomplete"></span>&nbsp;</td>
+
<td width=729><span id="stepHide"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
<td width=75>[[file:NextUp.png|link=#stepUnused|alt=Next Up|Top]]</td>
+
<td width=75>[[file:NextUp.png|link=#stepDisplay|alt=Next Up|Top]]</td>
−
<td width=75>[[file:NextDown.png|link=#stepWait|alt=Next Down|Next Down]]</td>
+
<td width=75>[[file:NextDown.png|link=#stepClear|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
  
−
='''Application 2: Checking for Incomplete Navigation Sets'''=
+
='''Navigation Set Hide/Show Rule'''=
  
−
<table cellpadding=4 bgcolor=#ffffff>
+
The [[file: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'''.
−
<tr valign="top">
+
−
<td width="58">[[file:magnifier.png|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
−
----</td>
+
−
</tr>
+
−
</table>
+
−
A check is made to see if all the navigation points in a navigation set have been completed. If not then the set will be manually completed and a message displayed.
+
−
<br><br>
+
−
<table cellpadding=4 bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td width="58">[[file:conditions.PNG|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''Preconditions:'''</span><br>
+
−
----</td>
+
−
</tr>
+
−
</table>
+
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' creates the navigation point sets.
+
 
<br>
 
<br>
−
<table cellpadding=4 bgcolor=#ffffff>
+
The '''Navigation Set Hide/Show Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor.
 +
<br>
 +
 
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<td>[[file:NavPointHideDialog.JPG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
*'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' to trigger the event.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Set_Check_Rule|Navigation Set Check Rule]]''' to check if a navigation set has been completed.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Set_Clear_Rule|Navigation Set Clear Rule]]''' to manually complete navigation sets.
 
−
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen.
 
−
<br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
−
----</td>
+
*'''Hide/Show''' click to select one. '''Hide''' will make the entire set invisible. '''Show''' will display the next navigation point or more depending on the ''Navigation Mode'' that has been selected for this particular set
 +
*'''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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 
</tr>
 
</tr>
−
</table>
 
−
<table>
 
 
<tr>
 
<tr>
−
<td>[[file:NavSetCheck.JPG|link=]]</td>
+
<td colspan="2">
−
</tr>
+
−
</table>
+
−
<br>
+
−
<table cellpadding=4 bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
 
----</td>
 
----</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''Line 1: Trigger Check''' the event is triggered by the consist leaving the location with the navigation points.
 
−
**'''Line 2: Navigation Set Check''' the identified navigation set is checked to see if all its points have been completed. If not then the following lines will be executed simultaneously:-
 
−
***'''Line 3: Navigation Set Clear''' the navigation set is cleared so all of its navigation points will be cleared (completed).
 
−
***'''Line 4: Message Popup Rule''' a suitable message is displayed on the screen.
 
  
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepWait"></span>&nbsp;</td>
+
<td width=729><span id="stepClear"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
<td width=75>[[file:NextUp.png|link=#stepIncomplete|alt=Next Up|Top]]</td>
+
<td width=75>[[file:NextUp.png|link=#stepHide|alt=Next Up|Top]]</td>
−
<td width=75>[[file:NextDown.png|link=#stepPath|alt=Next Down|Next Down]]</td>
+
<td width=75>[[file:NextDown.png|link=#stepComplete|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
  
−
='''Application 3: Wait for Loading to be Completed'''=
+
='''Navigation Set Clear Rule'''=
  
−
<table cellpadding=4 bgcolor=#ffffff>
+
The [[file: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'''.
 +
<br>
 +
The '''Navigation Set Clear Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor.
 +
<br>
 +
 
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:magnifier.png|link=]]</td>
+
<td>[[file:NavSetClearDialog.JPG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
A user controlled train arrives at a Navigation Point positioned at a coal loader. Coal loading proceeds. The Navigation Point remains in place  until the last wagon is loaded.
 
−
<br><br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:conditions.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Preconditions:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
*'''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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' creates the navigation point set. The Navigation Point is created with its ''Style'' set to '''manual''' which means it will be completed by another rule and not the arrival of the consist.
 
  
−
<table>
+
<table> <!-- BEGIN Nav Buttons Table -->
−
<tr>
+
<tr valign="top">
−
<td>[[file:NavManualSet.JPG|link=]]</td>
+
<td width=729><span id="stepComplete"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepClear|alt=Next Up|Top]]</td>
 +
<td width=75>[[file:NextDown.png|link=#stepCheck|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
−
The '''Multiple Resouce Check Rule''' is configured to watch the load of coal in the last wagon of the consist exceeding a set value that is close to the maximum for that wagon (apologies for the colour scheme).
+
='''Navigation Point Complete Rule'''=
  
−
<table>
+
The [[file: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 '''Navigation Display Rule'''. This rule is used to complete Navigation Points with their ''Style'' property set to '''manual'''.
−
<tr>
+
−
<td>[[file:MultResCheck.JPG|link=]]</td>
+
−
</tr>
+
−
</table>
+
 
<br>
 
<br>
−
<table cellpadding=4 bgcolor=#ffffff>
+
The '''Navigation Point Complete Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor.
 +
<br>
 +
 
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<td>[[file:NavPointCompleteDialog.JPG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
*'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' to trigger the message event.
 
−
*'''[[Session_Rule_List_with_Parameters#Multiple_Resource_Check_Rule|Multiple Resource Check Rule]]''' to monitor the load level in the last wagon.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Point_Complete_Rule|Navigation Point Complete Rule]]''' to manually complete a navigation point.
 
−
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen.
 
−
 
−
The more obvious '''Wait on Navigation Point Rule''' is not used because the Navigation Point will be completed manually some time after the consist has arrived at the location. By using the '''Trigger Check Rule''' instead (the Navigation Point is attached to a trigger), the navigation icon remains on the screen until the loading has been completed and then it will be manually cleared.
 
−
<br><br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
−
----</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
 +
*'''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>
 
</tr>
−
</table>
 
−
<table>
 
 
<tr>
 
<tr>
−
<td>[[file:NavPointComplete.JPG|link=]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
−
</table>
+
</table></td>
−
<br>
+
−
<table cellpadding=4 bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
−
----</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''Line 1: Trigger Check''' the event is triggered by the arrival of the consist at the coal loader (the Navigation Point).
 
−
**'''Line 2: Multiple Resource Check''' when the last wagon has been loaded the following lines are executed simultaneously:-
 
−
***'''Line 3: Navigation Point Complete''' the Navigation Point is completed and its icon is removed from the screen.
 
−
***'''Line 4: Message Popup''' a "Loading completed" message appears on the screen.
 
  
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepPath"></span>&nbsp;</td>
+
<td width=729><span id="stepCheck"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
<td width=75>[[file:NextUp.png|link=#stepWait|alt=Next Up|Top]]</td>
+
<td width=75>[[file:NextUp.png|link=#stepComplete|alt=Next Up|Top]]</td>
−
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
+
<td width=75>[[file:NextDown.png|link=#stepWait|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
  
−
='''Application 4: User Path Selection'''=
+
='''Navigation Set Check Rule'''=
  
−
<table cellpadding=4 bgcolor=#ffffff>
+
The [[file: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.
−
<tr valign="top">
+
<br>
−
<td width="58">[[file:magnifier.png|link=]]</td>
+
The '''Navigation Set Check Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. It is a [[file:WikiLink.PNG|link=]] '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/How_to_Use_Parent_and_Child_Rules Parent Rule]</span>'''.
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
−
----</td>
+
−
</tr>
+
−
</table>
+
−
A user controlled train stops at a navigation point in front of a junction and the driver is offered a choice of paths to allow a passing movement by an AI controlled train. Each path is indicated by different sets of navigation points. The path selected will determine other operations such as junction settings and AI train commands.
+
 
<br>
 
<br>
  
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td>[[file:NavSetCheckDialog.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
−
<td>[[file:NavSidingMap.JPG|link=]]</td>
+
<td colspan="2">
−
</tr>
+
−
</table>
+
−
 
+
−
Three sets of navigation points are created, one for each location on the map diagram above.
+
−
*'''Set A:''' at the junction, Point '''A''' in the map diagram. The two signals are set to STOP, '''Switch 2''' is locked in position and the user is presented with a choice of using the Main Line or the Loop Line
+
−
*'''Set B:''' at the end signal on the Main Line. '''Switch 2''' is set to the Loop Line and the AI train is given its instructions to pass on the Loop.
+
−
*'''Set C:''' at the end signal on the Loop Line. '''Switch 2''' is set to the Main Line and the AI train is given its instructions to pass on the Main.
+
−
 
+
−
<br>
+
−
<table cellpadding=4 bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
 
----</td>
 
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' creates the navigation point sets.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Set_Hide/Show_Rule|Navigation Set Hide/Show Rule]]''' to hide and display the navigation point sets.
 
−
*'''[[Session_Rule_List_with_Parameters#Wait_on_Navigation_Point_Rule|Wait on Navigation Point Rule]]''' to trigger the message event.
 
−
*'''[[Session_Rule_List_with_Parameters#Navigation_Set_Clear_Rule|Navigation Set Clear Rule]]''' to manually terminate a navigation point set.
 
−
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen.
 
−
*'''[[Session_Rule_List_with_Parameters#Set_Junctions_Rule|Set Junctions Rule]]''' to set and lock junctions.
 
−
*'''[[Session_Rule_List_with_Parameters#Set_Signal_Extended_Rule|Set Signal Extended Rule]]''' to set signals.
 
−
*'''[[Session_Rule_List_with_Parameters#Wait_Rule|Wait Rule]]''' to introduce a short delay.
 
−
*'''[[Session_Rule_List_with_Parameters#Driver_Schedule_Rule|Driver Schedule Rule]]''' to give commands to the AI controlled train.
 
−
<br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
−
----</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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters
 +
*'''Complete/Incomplete''' click to select one. 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>
 
</tr>
−
</table>
 
−
===Creating the Navigation Point Sets===
 
−
 
−
<table>
 
 
<tr>
 
<tr>
−
<td>[[file:NavDisplaySets.JPG|link=]]</td>
+
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
*Each set is created separately and sets '''B''' and '''C''' are hidden.
+
<table> <!-- BEGIN Nav Buttons Table -->
−
*Each navigation point is attached to a track trigger - Point 1 in Set A is attached to a trigger placed in front of '''Switch 1''' in the map diagram.
+
<tr valign="top">
−
 
+
<td width=729><span id="stepWait"></span>&nbsp;</td>
−
<table>
+
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
<tr>
+
<td width=75>[[file:NextUp.png|link=#stepCheck|alt=Next Up|Top]]</td>
−
<td>[[file:NavPointSet.JPG|link=]]</td>
+
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
<tr>
+
</table> <!-- END Nav Buttons Table -->
−
<td>Navigation Point Set '''A'''. Sets '''B''' and '''C''' are similar.</td>
+
−
</tr>
+
−
</table>
+
  
−
===At Navigation Set A Point 1 The Junction===
+
='''Wait on Navigation Point Rule'''=
  
−
<table>
+
The [[file: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.
−
<tr>
+
<br>
−
<td>[[file:NavSetsChoose.JPG|link=]]</td>
+
The '''Wait on Navigation Point Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. It is a [[file:WikiLink.PNG|link=]] '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/How_to_Use_Parent_and_Child_Rules Parent Rule]</span>'''.
−
</tr>
+
−
</table>
+
 
<br>
 
<br>
−
<table cellpadding=4 bgcolor=#ffffff>
 
−
<tr valign="top">
 
−
<td width="58">[[file:explanation.PNG|link=]]</td>
 
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
 
−
----</td>
 
−
</tr>
 
−
</table>
 
−
*'''Line 1: Wait on Navigation Point''' The event is triggered when the consist reaches (and stops at) '''Navigation Point 1''' in '''Set A'''.
 
−
**'''Line 2: Navigation Set Hide/Show''' The '''Navigation Set B''' is made visible.
 
−
**'''Line 3: Navigation Set Hide/Show''' The '''Navigation Set C''' is made visible.
 
−
**'''Line 4: Set Junctions''' The junction '''Switch 2''' is locked against user and AI control.
 
−
**'''Line 5: Set Signals Extended''' '''Signal A''' is set to '''STOP'''
 
−
**'''Line 6: Set Signals Extended''' '''Signal B''' is set to '''STOP'''
 
−
**'''Line 7: Message Popup''' A message browser window is shown giving instruction to the user to set '''Switch 1''' to the Loop Line or the Main Line and then move the consist forward to the next signal.
 
−
 
−
===At Navigation Set B Point 1 The Stop signal on the Main Line===
 
  
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td>[[file:NavPointWaitDialog.JPG|link=]]</td>
 +
<td>
 +
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
−
<td>[[file:NavMainSet.JPG|link=]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
−
</table>
 
−
<br>
 
−
<table cellpadding=4 bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
<td>[[file:Gears.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
−
----</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
 +
*'''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>
 
</tr>
−
</table>
 
−
*'''Line 1: Wait on Navigation Point''' The event is triggered when the consist reaches (and stops at) '''Navigation Point 1''' in '''Set B'''.
 
−
**'''Line 2: Navigation Set Clear''' The '''Navigation Set C''' is deleted and its visible Navigation Point disappears from the screen as the Loop Line path was not selected.
 
−
**'''Line 3: Message Popup''' A message browser window is shown giving instruction to the user to wait until the passing train has cleared '''Switch 1'''
 
−
**'''Line 4: Set Junctions''' The junction '''Switch 2''' is set to the Loop Line but is still locked against user and AI control.
 
−
**'''Line 5: Wait''' A wait of 20 seconds then ...
 
−
***'''Line 6: Driver Schedule''' The AI train is given commands to move to the next destination via the Loop Line.
 
−
 
−
===At Navigation Set C Point 1 The Stop Signal on the Loop Line===
 
−
 
−
<table>
 
 
<tr>
 
<tr>
−
<td>[[file:NavLoopSet.JPG|link=]]</td>
+
<td colspan="2">
−
</tr>
+
−
</table>
+
−
<table cellpadding=4 bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
 
----</td>
 
----</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''Line 1: Wait on Navigation Point''' The event is triggered when the consist reaches (and stops at) '''Navigation Point 1''' in '''Set C'''.
 
−
**'''Line 2: Navigation Set Clear''' The '''Navigation Set C''' is deleted and its visible Navigation Point disappears from the screen as the Main Line path was not selected.
 
−
**'''Line 3: Message Popup''' A message browser window is shown giving instruction to the user to wait until the passing train has cleared '''Switch 1'''
 
−
**'''Line 4: Set Junctions''' The junction '''Switch 2''' is set to the Main Line but is still locked against user and AI control.
 
−
**'''Line 5: Wait''' A wait of 20 seconds then ...
 
−
***'''Line 6: Driver Schedule''' The AI train is given commands to move to the next destination via the Main Line.
 
  
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
Line 382: Line 312:
 
<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>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
<td width=75>[[file:NextUp.png|link=#stepPath|alt=Next Up|Top]]</td>
+
<td width=75>[[file:NextUp.png|link=#stepWait|alt=Next Up|Top]]</td>
−
<td width=75></td>
+
<td width=75>&nbsp;</td>
−
<td width=75></td>
+
<td width=75>&nbsp;</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
 +
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
 
<table cellpadding=4 bgcolor=#ffffff>
 
<table cellpadding=4 bgcolor=#ffffff>

Revision as of 21:33, 2 April 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.

LinkWiki.PNG

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


Contents


DotPoint.JPG 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


The navigation points are created and controlled by the set of Session rules that are described in this document.

  Top   Next Down Bottom

Navigation Display Rule

The WikiLink.PNG Navigation Display Rule settings shown in this example will direct Trainz to create a set of Navigation Points.

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


The Navigation Display Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor.

NavDisplaySetDialog.JPG
Gears.PNG Settings:

For the Navigation Set:

  • 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.
  • Train (optional): You can add a specific locomotive that this Navigation Point set will be applied to.
  • 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.
Gears.PNG Settings:

For each Navigation Point:

  • 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. Icons are selected from a preset list.
  • Display text: - a short message up to 25 characters long.
  • Style: - the operational 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.
  Top Next Up Next Down Bottom

Navigation Set Hide/Show Rule

The WikiLink.PNG Navigation Set Hide/Show Rule hides and displays the navigation sets created by the Navigation Display Rule.
The Navigation Set Hide/Show Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor.

NavPointHideDialog.JPG
Gears.PNG Settings:
  • Hide/Show click to select one. Hide will make the entire set invisible. Show will display the next navigation point or more depending on the Navigation Mode that has been selected for this particular set
  • 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 Navigation Display Rule and consists of any text characters EXCEPT the SPACE character and UPPER CASE characters
  Top Next Up Next Down Bottom

Navigation Set Clear Rule

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

NavSetClearDialog.JPG
Gears.PNG Settings:
  • 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 Navigation Display Rule and consists of any text characters EXCEPT the SPACE character and UPPER CASE characters
  Top Next Up Next Down Bottom

Navigation Point Complete Rule

The WikiLink.PNG 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.
The Navigation Point Complete Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor.

NavPointCompleteDialog.JPG
Gears.PNG Settings:
  • 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
  • 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 Next Down Bottom

Navigation Set Check Rule

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

NavSetCheckDialog.JPG
Gears.PNG Settings:
  • 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 Navigation Display Rule and consists of any text characters EXCEPT the SPACE character and UPPER CASE characters
  • Complete/Incomplete click to select one. 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 Next Down Bottom

Wait on Navigation Point Rule

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

NavPointWaitDialog.JPG
Gears.PNG Settings:
  • 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
  • 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    

Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

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

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