How to Use Track Triggers

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎Giving the Trigger Event a Purpose)
m (→‎Adding an Instruction to the Trigger Event)
Line 155: Line 155:
 
<td rowspan="2">[[file:SessionRuleIndent.JPG]]</td>
 
<td rowspan="2">[[file:SessionRuleIndent.JPG]]</td>
 
<td><br>
 
<td><br>
−
*(left) With the '''Message Popup Rule''' highlighted, click the '''''Indent''''' (''right arrow'') button.
+
With the '''Message Popup Rule''' highlighted (shown left):-
−
This should indent the '''Message Popup''' rule one level in (below).<br>
+
*Click the '''''Indent''''' (''right arrow'') button.
 +
This should indent the '''Message Popup''' rule one level in (shown below).<br>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 167: Line 168:
 
<br>The '''Message Popup Rule''' is now controlled by the '''Trigger Check Rule''' but it still has to be configured to show a message.
 
<br>The '''Message Popup Rule''' is now controlled by the '''Trigger Check Rule''' but it still has to be configured to show a message.
  
−
*With the '''Message Popup Rule''' highlighted, click the '''Edit''' button.
+
With the '''Message Popup Rule''' highlighted (shown below):-
 +
*Click the '''Edit''' button.
  
 
<table>
 
<table>
Line 175: Line 177:
 
[[file:MessagePopupStop.JPG]]
 
[[file:MessagePopupStop.JPG]]
 
</td>
 
</td>
−
<td><br>(left) Set the properties as shown:-
+
<td><br>In the Message Popup properties window, set the properties as shown:-
 
*Check '''ON''' ''Close previous message popup windows''
 
*Check '''ON''' ''Close previous message popup windows''
 
*Select '''Option Button''' ''Custom text''
 
*Select '''Option Button''' ''Custom text''
Line 181: Line 183:
 
<br>
 
<br>
 
To add an icon to the message:-
 
To add an icon to the message:-
−
*(left) Click the link ''click here to set'' and either  
+
*Click the link ''click here to set'' (shown left) and either  
−
**(below) scroll down the list to find a suitable icon (some will not be suitable), or
+
**Scroll down the Texture Asset Selection List (shown below) to find a suitable icon, or
−
**(below) simply type "icon stop" in the text box
+
**Simply type "icon stop" in the text box to use one of the builtin icons.
−
*(below) Click the '''Tick''' icon.<br>
+
*Click the '''Tick''' icon.<br>
 
[[file:IconStop.JPG]]
 
[[file:IconStop.JPG]]
 
</td>
 
</td>

Revision as of 12:12, 21 May 2018

Contents

What are Triggers?

Triggers are invisible markers (invisible in Driver Mode but visible in Surveyor Mode) that are placed on a track. They can be programmed to "trigger an event" when a train (any train or a specific train) passes over them in Driver Mode.

The "event" is a message that is transmitted by the trigger to certain Session Rules that have been programmed to "listen" for the message. When one of those listening rules detects the message, it can be forced into action by executing preset instructions.

TrackTrigger.JPG

(left) A Track Trigger in place on a track visible in Surveyor Mode. The "5.00m" is the trigger detection radius

Adding a Trigger

TrackTriggerMode.JPG

The Track Trigger is placed on the track using:-

  • the Tracks tool, and
  • the Trackmark Mode button.
  • Select the Trigger object from the list of installed objects
  • Click the Add Object button
  • Click the track position where the trigger is to be placed.

Configuring a Trigger

As soon as a new 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.

TrackTriggerProperties.JPG
  • To change the 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.
  • To confirm the changes click on the Tick icon on the bottom right of the window.

Triggers have a "detection radius" that controls how close a train has to approach to trigger the event. The smaller the radius the closer the train. This radius is set in the Advanced Properties section of the Tools window.

TrackTriggerRadius.JPG
  • Click the Advanced Tab to open its properties.
  • Enter a new radius value in metres.
  • Click the Set Trigger Radius button
  • Click on the trigger that has been placed on the track to assign its new radius.


Note:
A small radius should only be used for slower moving trains. Fast trains may pass over a small radius trigger without being detected.

Creating a Trigger Event

Trigger events are handled by the Trigger Check Rule which is added to a session in the Session Editor.

The Trainz Wiki Link Trigger Check Rule contains detailed information on this rule.

EditSessionMenu.JPG

To add the Trigger Check Rule to a session:-

  • Open the Surveyor Main Menu.
  • Select the option Edit Session from the drop down menu list.
EditSessionWindowX.JPG

In the Edit Session window (shown left):-

  • Click the Add button

In Rule Selection window (shown below):-

  • Scroll down the list to select the Trigger Check rule
  • Click the Tick icon.
RuleSelect.JPG


This will add the Trigger Check rule to the session.

TriggerCheck.JPG

With the Trigger Check rule highlighted (shown left):-

  • Click the Edit button. This will open its properties window.


For this example we will leave all settings unchanged and simply identify the trigger to be used.

TriggerCheckProperties.JPG


Click the Tick icon Trigger Check properties window (shown above) to accept the changes.

In the Trigger Properties window (shown left):-

  • Click the Add trigger link

In the Trigger Selection window (shown below):-

  • Select the trigger you have just added
  • Click the Tick icon on the selection list
TriggerList.JPG


Adding an Instruction to the Trigger Event

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

TriggerAddMesPopup.JPG

When you are back in the Session Editor window:-

  • Click the Add button to add a new rule.
  • Scroll down the rule selection window to select the Message Popup rule
  • Click the Tick icon.

The Message Popup rule should now appear directly below the Trigger Check rule.
MessagePopupAdded.JPG
The new rule will show a red cross because it has not yet been configured.

The Message Popup Rule has to be indented so that it becomes a Child of the Trigger Check Rule.

SessionRuleIndent.JPG

With the Message Popup Rule highlighted (shown left):-

  • Click the Indent (right arrow) button.

This should indent the Message Popup rule one level in (shown below).
SessionRuleIndented.JPG


The Message Popup Rule is now controlled by the Trigger Check Rule but it still has to be configured to show a message.

With the Message Popup Rule highlighted (shown below):-

  • Click the Edit button.
MessagePopupText.JPG

The finished Message Popup.
MessagePopupStop.JPG


In the Message Popup properties window, set the properties as shown:-
  • Check ON Close previous message popup windows
  • Select Option Button Custom text
  • Enter a short text message (you are limited to about 6 lines of text)


To add an icon to the message:-

  • 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 the Tick icon.

IconStop.JPG


Again, click the Tick icon to exit the Message Popup Rule then exit the Session Editor.

Add a consist to your layout a short distance from the 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 Message Popup Rule Applications link below.

Related Trainz Wiki Links:

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