How to Use Navigation Point Rules

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎Trainz Wiki)
m
Line 23: Line 23:
 
The navigation points are created and controlled by the set of Session rules that are described in this document.
 
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 -->
 +
<tr valign="top">
 +
<td width=729><span id="stepDisplay"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#top|alt=Next Up|Top]]</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>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
 
='''Navigation Display Rule'''=
 
='''Navigation Display Rule'''=
Line 100: Line 109:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepHide"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepDisplay|alt=Next Up|Top]]</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>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Navigation Set Hide/Show Rule'''=
 
='''Navigation Set Hide/Show Rule'''=
Line 136: Line 149:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepClear"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepHide|alt=Next Up|Top]]</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>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Navigation Set Clear Rule'''=
 
='''Navigation Set Clear Rule'''=
Line 171: Line 188:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="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 -->
  
 
='''Navigation Point Complete Rule'''=
 
='''Navigation Point Complete Rule'''=
Line 207: Line 228:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepCheck"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepComplete|alt=Next Up|Top]]</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>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Navigation Set Check Rule'''=
 
='''Navigation Set Check Rule'''=
Line 243: Line 268:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepWait"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepCheck|alt=Next Up|Top]]</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>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Wait on Navigation Point Rule'''=
 
='''Wait on Navigation Point Rule'''=
Line 279: Line 308:
 
</table>
 
</table>
  
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="bottom"></span>&nbsp;</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>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----

Revision as of 10:25, 15 August 2021

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus. 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 Up 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://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_Navigation_Point_Rules&oldid=29971"
Personal tools