How to Use Track Triggers
m (→Adding a Trigger) |
m (→Creating a Trigger Event) |
||
| Line 53: | Line 53: | ||
Trigger events are handled by the '''Trigger Check Rule''' which is added to a session in the '''Session Editor'''. | Trigger events are handled by the '''Trigger Check Rule''' which is added to a session in the '''Session Editor'''. | ||
| + | |||
| + | *The Trainz Wiki Link '''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' contains detailed information on this rule. | ||
Start the Session Editor from the '''Surveyor Main Menu'''. | Start the Session Editor from the '''Surveyor Main Menu'''. | ||
Revision as of 00:06, 20 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.
 |
Adding a Trigger
The Track Trigger is placed on the track using the Tracks tool and Trackmark Mode.
 |
The Trigger Object is selected from the list of installed objects then the Add Object button is clicked followed by clicking 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.
 |
- To change the assigned layer click on the layer box and select a new layer.
- To change the trigger name click on the default name and enter a new name.
- To confirm the changes click on the Tick icon on the bottom right of the window.
Triggers have a "radius of influence" that determines how close a train has to approach to trigger their event. The smaller the radius the closer the train has to approach. This radius is set in the Advanced Properties section of the Tools window.
 |
Click the Advanced Tab to open its properties. Enter a new radius value in metres, click the Set Trigger Radius button then click on the trigger.
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.
Start the Session Editor from the Surveyor Main Menu.
Select the option Edit Session from the drop down menu list.
 |
 |
Click the Add button. Scroll down to select the Trigger Check rule then click the Tick icon.
 |
This will add the Trigger Check rule to the session.
 |
With the Trigger Check rule highlighted, 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. Click the Add trigger link and select the trigger you have previously added.
 |
Click the Tick icon on the selection lest and again on the Trigger Check properties window. Then exit the Session Editor screen.
To test your trigger event you will need to add rules to the Trigger Check. See the Message Popup Rule Applications page for an example.
