How to Use Track Triggers

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Configuring the Message: reorganised)
m (Creating a Track Trigger Event)
 
(2 intermediate revisions by one user not shown)
Line 300: Line 300:
 
</tr>
 
</tr>
 
</table> <!-- END Step 5 table -->
 
</table> <!-- END Step 5 table -->
 +
</td>
 +
</tr>
 +
</table> <!-- END Step Table -->
 
<table width="100%"> <!-- BEGIN Back-To-Top Table -->
 
<table width="100%"> <!-- BEGIN Back-To-Top Table -->
 
<tr valign="top">
 
<tr valign="top">
Line 372: Line 375:
 
</table> <!-- END Back-To-Top Table -->
 
</table> <!-- END Back-To-Top Table -->
  
==Configuring the Message==
+
==Configuring the Message and Testing==
  
 
<table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table -->
 
<table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table -->
Line 407: Line 410:
 
<tr>
 
<tr>
 
<td>
 
<td>
<table cellpadding="4" bgcolor="Aquamarine">
+
<table cellpadding="4" bgcolor="Aquamarine"> <!-- BEGIN Step 2 Wikilink Table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:LinkWiki.PNG|link=]]</td>
 
<td>[[file:LinkWiki.PNG|link=]]</td>
Line 415: Line 418:
 
</td>
 
</td>
 
</tr>
 
</tr>
</table>
+
</table> <!-- END Step 2 Wikilink Table -->
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 432: Line 435:
 
<td>
 
<td>
 
*Click the link '''''<span style="text-decoration: underline;">click here to set</span>''''' (shown left) and either  
 
*Click the link '''''<span style="text-decoration: underline;">click here to set</span>''''' (shown left) and either  
:**Scroll down the Texture Asset Selection List (shown below) to find a suitable icon, or
+
:*Scroll down the Texture Asset Selection List (shown below) to find a suitable icon, or
:**Simply type "icon stop" in the text box to use one of the builtin icons.
+
:*Simply type "icon stop" in the text box to use one of the builtin icons.
 
*Click on the [[file:Tick.PNG|link=]] icon</td>
 
*Click on the [[file:Tick.PNG|link=]] icon</td>
 
</tr>
 
</tr>
Line 440: Line 443:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>The completed Message Popup Rule<br>
+
<td>
 +
*click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' and return to the '''Session Editor'''<br>
 +
The completed Message Popup Rule<br>
 
[[file:MessagePopupStop.JPG|link=]]
 
[[file:MessagePopupStop.JPG|link=]]
 
<tr>
 
<tr>
Line 451: Line 456:
 
<tr valign="top">
 
<tr valign="top">
 
<td>&nbsp;</td>
 
<td>&nbsp;</td>
<td>[[file:DotPoint5.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Test the Trigger:</span><br>
+
<td>[[file:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Test the Trigger:</span><br>
<table> <!-- BEGIN Step 5 table -->
+
<table> <!-- BEGIN Step 4 table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
*Again, click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' then exit the '''Session Editor'''
+
*Exit the '''Session Editor'''
 
*Add a consist to your layout a short distance from the track trigger (but further away than its radius), save the Surveyor Session, and then test in '''Driver Mode'''</td>
 
*Add a consist to your layout a short distance from the track trigger (but further away than its radius), save the Surveyor Session, and then test in '''Driver Mode'''</td>
 
</tr>
 
</tr>
Line 462: Line 467:
 
----</td>
 
----</td>
 
</tr>
 
</tr>
</table> <!-- END Step 5 table -->
+
</table> <!-- END Step 4 table -->
 
Another example of using the '''Trigger Check Rule''' can be found in the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule (Applications)]]'''.
 
Another example of using the '''Trigger Check Rule''' can be found in the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule (Applications)]]'''.
 
<br>
 
<br>

Latest revision as of 15:50, 13 February 2020

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus.

Contents

[edit] What are Track Triggers?

DotPoint.JPG Track triggers are track markers that are invisible in Driver Mode but visible in Surveyor Mode. They are used to activate Session Rules and some Driver Commands

Track triggers can be programmed to respond when a train (any train or a specific train) passes over them in Driver Mode. The response comes from executing a set of Session Rules that have been attached to a WikiLink.PNG Trigger Check Rule (or a similar rule) or a Driver Command that is monitoring the track trigger.

TrackTrigger.JPG

Shown at left is a Track Trigger placed on a track in Surveyor Mode. It is NOT visible in Driver Mode. The "5.00m" shown below the trigger name is the trigger detection radius


[edit] Route or Session?

DotPoint.JPG Track Triggers can be placed in a Route layer or in a Session layer


NotePad.PNG Notes:
  • Placing Track Triggers in a Route layer (e.g. in the same layer as the track) means that they will be available in all Sessions created using that particular Route.
  • Placing Track Triggers in a Session layer means that they will only be available in that Session. This can be useful if two or more Sessions are being created and you want to use different Track Triggers in each Session.


LinkWiki.PNG Information on Route and Session layers can be found at:-
Top

[edit] Adding a Track Trigger

TrackTriggerMode.JPG

Steps.PNG Steps:

A Track Trigger is placed on the track by:-

  1. clicking the Track tool,
  2. clicking the Trackmark Mode button,
  3. selecting the Trigger object from the list of installed objects,
  4. clicking the Add Object button,
  5. clicking the track position where the track trigger is to be placed.


Top

[edit] Configuring a Track Trigger

As soon as a new track trigger has been placed, its properties window will open on the screen. It will be given a default name and assigned to the currently active layer.


Steps.PNG

Steps
DotPoint1.JPG Name the Trigger:
TrackTriggerProperties.JPG
  • To change the track trigger name click on the name box, delete the highlighted default name and enter a new name
  • To change the assigned layer click on the layer box and select a new layer
  • Leave the "Bound Layer" at <none>. (See the Trainz Wiki Page WikiLink.PNG Using Layers for information on layers)
  • To confirm the changes click on the Tick.PNG icon on the bottom right of the window

  DotPoint2.JPG (Optional) Set the Trigger Detection Radius:
Track triggers have a "detection radius" that controls how close a train has to approach to trigger the event. The default radius is 20 metres. The smaller the radius the closer the train has to be to the track trigger to be detected. This radius is set in the Advanced Properties section of the Tools window (shown below).
TrackTriggerRadius.JPG
  1. Click the Advanced Tab to open its properties
  2. Enter a new radius value in metres
  3. Click the Set Trigger Radius button
  4. Click on the track trigger to assign its new radius


PencilTips.PNG A small radius should only be used for slower moving trains. Short fast trains may pass over a small radius track trigger without being detected.

Top

[edit] Creating a Track Trigger Event

Track trigger events are handled by the Trigger Check Rule (or a similar rule) which is added to a Session in the WikiLink.PNG Session Editor.

LinkWiki.PNG

More information on the Trigger Check Rule can be found on the Trainz Wiki Rules Page at:-



Steps.PNG

Steps
DotPoint1.JPG Open the Session Editor:

To add the Trigger Check Rule to a session:-

  1. Open the Surveyor Main Menu in TANE (shown below left) or the Surveyor Edit Menu in TRS19 and Trainz Plus (shown below right)
  2. Select the option Edit Session from the drop down menu list
EditSessionMenu.JPG SessionEditMenuSP1.png

  DotPoint2.JPG Add the Trigger Check Rule:
In the Edit Session window (shown below left):-
  • Click the Add button

In the Rule Selection window (shown below right):-

  1. Scroll down the list to select the Trigger Check rule
  2. Click on the Tick.PNG icon
EditSessionWindowX.JPG RuleSelect.JPG

This will add the Trigger Check rule to the session.

  DotPoint3.JPG Open the Trigger Check Rule Properties:
With the Trigger Check rule highlighted (shown below):-
  • Click the Edit button. This will open the rule properties window
TriggerCheck.JPG

  DotPoint4.JPG Configure the Rule:
For this example we will leave all settings unchanged and simply identify the track trigger to be used.

In the Trigger Properties window (shown below):-

  • Click the Add trigger link
TriggerCheckProperties.JPG
LinkWiki.PNG

More information on the settings and options in this rule can be found on the Trainz Wiki Rules Page at:-


  DotPoint5.JPG Select the Trigger:
The Trigger Selection Window will list all the Track Triggers in your layout.
  1. Select the trigger you have just added
  2. Click on the Tick.PNG icon at the bottom of the selection window
TriggerList.JPG
Once the trigger has been added to the rule, click on the Tick.PNG icon in the Trigger Check properties window to accept the change.

Top

[edit] Adding an Instruction to the Trigger Event

To test your trigger event you will need to add at least one rule.

[edit] Adding a Child Rule

Steps.PNG

Steps
DotPoint1.JPG Add A Message Popup Rule:
When you are back in the Session Editor window:-
  1. Make sure that the new Trigger Check Rule is selected (highlighted)
  2. Click the Add button to add another new rule
  3. Scroll down the rule selection window to find and select the Message Popup rule
  4. Click on the Tick.PNG icon
TriggerAddMesPopup.JPG
The Message Popup Rule should now appear directly below the Trigger Check rule. It will display a red cross because it has not yet been configured.

  DotPoint2.JPG Indent the Popup Message Rule:
The Message Popup Rule has to be indented so that it becomes a Child of the Trigger Check Rule and is controlled by that rule.

SessionRuleIndent.JPG
With the Message Popup Rule highlighted:-

  • Click the Indent (right arrow) button.

This should indent the Message Popup rule one level inwards (as shown below).

SessionRuleIndented.JPG

This Message Popup Rule is now a Child Rule of the Trigger Check Rule and will only be executed after the track trigger has been activated by a train.

Top

[edit] Configuring the Message and Testing

Steps.PNG

Steps
DotPoint1.JPG Open the Message Popup Rule for Editing:
With the Message Popup Rule highlighted and indented (as shown above):-
  • Click the Edit button. The Message Popup Rule properties window will appear (as shown below)

  DotPoint2.JPG Configure the Message:
Set the properties as shown:-
  1. Check ON Close previous message popup windows
  2. Select Option Button Custom text
  3. Enter a short text message (you are limited to about 6 lines of text)
MessagePopupText.JPG
LinkWiki.PNG

More information on this rule can be found on the Trainz Wiki Page at:-


  DotPoint3.JPG (Optional) Add a Message Icon:
  • Click the link click here to set (shown left) and either
  • Scroll down the Texture Asset Selection List (shown below) to find a suitable icon, or
  • Simply type "icon stop" in the text box to use one of the builtin icons.
  • Click on the Tick.PNG icon
IconStop.JPG
  • click on the Tick.PNG icon to exit the Message Popup Rule and return to the Session Editor

The completed Message Popup Rule
MessagePopupStop.JPG


  DotPoint4.JPG Test the Trigger:
  • Exit the Session Editor
  • Add a consist to your layout a short distance from the track trigger (but further away than its radius), save the Surveyor Session, and then test in Driver Mode

Another example of using the Trigger Check Rule can be found in the Trainz Wiki Page WikiLink.PNG How to Use Message Popup Rule (Applications).

Top

[edit] Alternatives to the Trigger Check Rule

RulesWiki.PNG There are other rules that can be used in place of the Trigger Check Rule and triggers. A few possibilities are listed below:-
  • Directional Trigger Check Rule - identical to the Trigger Check Rule but adds the ability to test the train direction. Requires the use of a special Directional Trigger. For an example of its use see the Trainz Wiki Page WikiLink.PNG Controlling Signals in Sessions.
  • Trackside Check Rule - very similar to the Trigger Check Rule but provides some different options.
  • Navigation Points (see the How to Guides link below) are more complex but provide more advanced controls and options.
  • Multiple Resource Check Rule - monitors and acts on changes in multiple industry or multiple wagon resource (commodity) levels.
  • Resource Verify Rule - monitors and acts on changes in a single industry or wagon resource (commodity) level.
  • Timecheck Rule - triggers an event at a set time.


CommandsWiki.png There is a driver command that can be used in place of the Trigger Check Rule.
  • Wait For Trigger - forces an AI controlled train to wait until a specified trigger has been activated by another train.


[edit] Related Links

LinkWiki.PNG


Top


[edit] 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.


Personal tools