View source for How to Use Navigation Point Rules

__TOC__
<br>
The screenshots below illustrate how to configure each of the Navigation Point Rules. For examples of how to use these rules see the Trainz Wiki Page [[file:WikiLink.PNG]] '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/How_to_Use_Navigation_Point_Rules_(Applications) Navigation Point Rules (Applications)]</span>''' 
<br>
='''Navigation Display Rule'''=

The [[file:WikiLink.PNG]] '''[[Session_Rule_List_with_Parameters#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 - one copy for each set
*This rule creates the navigation set, it does not display it
<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top>
<td>[[file:DotPoint.JPG]]</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>
</table>

<table>
<tr valign="top">
<td>[[file:NavDisplaySetDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<td><font size="3">'''Settings:'''</font><br>
'''For the Navigation Set:'''<br>
*'''Set ID:''' Each Navigation Point Set must have a '''unique ID code'''. This consists of any text characters '''<u>EXCEPT</u>''' 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.
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>

<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<td><font size="3">'''Settings:'''</font><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>
</tr>
</table></td>
</tr>
</table>
<br>

='''Navigation Set Hide/Show Rule'''=

The [[file:WikiLink.PNG]] '''[[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'''.

<table>
<tr valign="top">
<td>[[file:NavPointHideDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<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
*'''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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>

='''Navigation Set Clear Rule'''=

The [[file:WikiLink.PNG]] '''[[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'''.

<table>
<tr valign="top">
<td>[[file:NavSetClearDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<td><font size="3">'''Settings:'''</font><br>
*'''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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>

='''Navigation Point Complete Rule'''=

The [[file:WikiLink.PNG]] '''[[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'''.

<table>
<tr valign="top">
<td>[[file:NavPointCompleteDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<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
*'''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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>

='''Navigation Set Check Rule'''=

The [[file:WikiLink.PNG]] '''[[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.

<table>
<tr valign="top">
<td>[[file:NavSetCheckDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<td><font size="3">'''Settings:'''</font><br>
*'''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>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>

='''Wait on Navigation Point Rule'''=

The [[file:WikiLink.PNG]] '''[[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.

<table>
<tr valign="top">
<td>[[file:NavPointWaitDialog.JPG]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Gears.PNG]]</td>
<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
*'''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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
----
----
<br>

='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:TrainzWiki.png]]</td>
<td>
<font size="3">'''More Tutorials and Guides to Using Trainz'''</font><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[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>

[[Category:How-to guides]]