How to Use Track Triggers

From TrainzOnline
Jump to: navigation, search

Contents

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.

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


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.


Configuring a Track Trigger

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

TrackTriggerProperties.JPG

Steps.PNG Steps:
  • 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.

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

Steps.PNG Steps:
  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.


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 Session Editor.

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

EditSessionMenu.JPG

Steps.PNG Steps:

To add the Trigger Check Rule to a session:-

  1. Open the Surveyor Main Menu.
  2. Select the option Edit Session from the drop down menu list.

EditSessionWindowX.JPG

Steps.PNG Steps:

In the Edit Session window (shown left):-

  • Click the Add button

In the Rule Selection window (shown below):-

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

RuleSelect.JPG


This will add the Trigger Check rule to the session.

TriggerCheck.JPG

Steps.PNG Steps:

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 track trigger to be used.

TriggerCheckProperties.JPG


Once the trigger has been identified, click on the Tick.PNG icon in the Trigger Check properties window (shown above) to accept the change.


Steps.PNG Steps:

In the Trigger Properties window (shown left):-

  • Click the Add trigger link

In the Trigger Selection window (shown below):-

  1. Select the trigger you have just added
  2. Click on the Tick.PNG 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.

Adding a Child Rule

TriggerAddMesPopup.JPG

Steps.PNG Steps:

When you are back in the Session Editor window:-

  1. Click the Add button to add a new rule
  2. Scroll down the rule selection window to find and select the Message Popup rule
  3. Click on the Tick.PNG icon

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.

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


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.

Steps.PNG Steps:

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

  • Click the Indent (right arrow) button.
This should indent the Message Popup rule one level inwards (shown below).

SessionRuleIndented.JPG


Configuring the Message

Steps.PNG Steps:

With the Message Popup Rule highlighted and indented (as shown above):-

  • Click the Edit button. The Message Popup Rule properties window will appear (shown below).

MessagePopupText.JPG

The finished Message Popup.
MessagePopupStop.JPG


Steps.PNG Steps:

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)

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

IconStop.JPG


See the Trainz Wiki page WikiLink.PNG How to Use Message Popup Rule for more information on this rule.


Steps.PNG Steps:
  • Again, click on the Tick.PNG icon to exit the Message Popup Rule then 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).

Alternatives to the Trigger Check Rule

RulesWiki.PNG There are alternative 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 Link 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.



Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

Personal tools