How to Use Navigation Point Rules

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Related Session Creation Tutorials:)
m (Trainz Creation Tutorials:)
Line 99: Line 99:
 
'''Related Session Creation Tutorials:'''
 
'''Related Session Creation Tutorials:'''
 
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
 
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
 +
*'''[[Creating a HTML Asset]]'''
 
*'''[[Controlling Junctions in Sessions]]'''
 
*'''[[Controlling Junctions in Sessions]]'''
 
*'''[[Controlling Signals in Sessions]]'''
 
*'''[[Controlling Signals in Sessions]]'''

Revision as of 16:43, 27 May 2018

The screenshots shown below give examples of the Navigation Point Rules.

Contents

Example 1: 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.

A navigation set must be created before it can be used by the other navigation rules.

NavDisplaySetDialog.JPG
  • 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.
  • 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.

For each Navigation Point you must identify ...

  • 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

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

NavPointHideDialog.JPG
  • 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.

Example 3: 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
  • 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.

Example 4: 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
  • 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.
  • Navigation Point Number: must be a point within the set.

Example 5: 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
  • 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.

Example 6: 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
  • 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.
  • Navigation Point Number: must be a point within the set.

Trainz Creation Tutorials:

Related Session Creation Tutorials:

Personal tools