How to Use Navigation Point Rules

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(→‎Navigation Point Complete Rule)
Line 53: Line 53:
 
</table>
 
</table>
 
<br>
 
<br>
−
 
 
='''Navigation Set Hide/Show Rule'''=
 
='''Navigation Set Hide/Show Rule'''=
  
Line 67: Line 66:
 
<td><font size="3">'''Settings:'''</font><br>
 
<td><font size="3">'''Settings:'''</font><br>
 
*'''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
 
*'''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</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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 
</tr>
 
</tr>
−
</table><br>
+
</table></td>
−
The '''Set ID:''' must be the same one 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>
Line 87: Line 85:
 
<td>[[file:Gears.PNG]]</td>
 
<td>[[file:Gears.PNG]]</td>
 
<td><font size="3">'''Settings:'''</font><br>
 
<td><font size="3">'''Settings:'''</font><br>
−
*'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set to be cleared</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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 
</tr>
 
</tr>
−
</table><br>
+
</table></td>
−
The '''Set ID:''' must be the same one 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>
Line 108: Line 105:
 
<td><font size="3">'''Settings:'''</font><br>
 
<td><font size="3">'''Settings:'''</font><br>
 
*'''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
 
*'''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 containing the Navigation Point to be completed</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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 
</tr>
 
</tr>
−
</table><br>
+
</table></td>
−
*'''Navigation Point Number:''' must be a point within the set
+
−
*'''Set ID:''' must be the same one 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>
Line 129: Line 124:
 
<td>[[file:Gears.PNG]]</td>
 
<td>[[file:Gears.PNG]]</td>
 
<td><font size="3">'''Settings:'''</font><br>
 
<td><font size="3">'''Settings:'''</font><br>
−
*'''Set ID:''' The unique Navigation Point '''Set ID''' code for the set containing the Navigation Point Set to be completed
+
*'''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
 
*'''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>
 
*'''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>
+
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters.
 
 
<br>
 
<br>
  
Line 152: Line 145:
 
<td><font size="3">'''Settings:'''</font><br>
 
<td><font size="3">'''Settings:'''</font><br>
 
*'''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
 
*'''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 containing the Navigation Point to be completed</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 '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters</td>
 
</tr>
 
</tr>
−
</table>
+
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
−
*'''Set ID:''' must be the same one as entered in the '''Navigation Display Rule''' and consists of any text characters '''EXCEPT''' the ''SPACE'' character and ''UPPER CASE'' characters.
 
−
*'''Navigation Point Number:''' must be a point within the set.
 
 
----
 
----
 
----
 
----
 
<br>
 
<br>
−
 
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
 
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''

Revision as of 14:24, 10 July 2018

Contents


The screenshots below illustrate how to use each of the Navigation Point Rules.

Navigation Display Rule

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

DotPoint.JPG A navigation set must be created by the Navigation Display Rule before it can be used by the other navigation rules.
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:-
    • 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.
    • 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.
    • 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.


Navigation Set Hide/Show Rule

The Navigation Set Hide/Show Rule hides and displays the navigation sets created by the Navigation Display Rule.

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


Navigation Set Clear Rule

The Navigation Set Clear Rule clears or completes any uncompleted Navigation Points in a set created by the Navigation Display Rule.

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


Navigation Point Complete Rule

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

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


Navigation Set Check Rule

The Navigation Set Check Rule checks if the specified Navigation set has been completed or not completed then executes any following child rules.

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


Wait on Navigation Point Rule

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


Trainz Wiki


Route Creation Tutorials:


Session Creation Tutorials:

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