A trigger is a virtual entity which executes an action once a specific condition is met.
A trigger has an area. It can be scaled in all axes and it can be rotated around Z (up) axis. Some areas have unlimited height by default, but that can be changed by manually adjusting their vertical scale. Setting it to negative value will make them unlimited vertically again.
You can see it visualized both in the scene and in the map, but by default you cannot interact with it. However, when the trigger is selected, you can drag it by its area in the map.
The activation condition can be based on the trigger area (e.g. no OFPOR present within a 500 m radius), but a scripted condition or combination of both can be applied as well.
Use Set Trigger Owner connection to assign the trigger to a specific group. It will change the available activation options from the general ones (e.g., any BLUFOR character) to the group specific ones (e.g., any member of the group).
Using the Timer attribute, you can allow the trigger to be activated either after a certain period of time since the condition has been met, or while the condition is met for the specified duration.
Once the condition is met, the trigger becomes activated. Its On Activation expression is executed, and the connected waypoints or modules may be activated as well.
If the trigger is set as repeatable, it will be deactivated once the condition is not met anymore. Afterwards, the trigger can be activated again, and this can continue until the scenario ends.
Triggers are the primary way to design the scenario flow without use of external scripts. Find out more about their configuration in the tooltips of their attributes.
|Variable Name||Init||Unique system name. Can contain only letters, numbers and underscore. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables.||name||String|
|Text||Init||Trigger description. Players can see it in the radio menu when its activation is set to 'Radio'. Also visible in tooltip when hovering over the trigger in the editor.||text||String|
|Shape||Transformation|| Area shape.
|Size||Transformation||Area size in meters.||size2||Array|
|Position||Transformation||World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain.||position||Position3D|
|Rotation||Transformation||Local rotation in degrees. X is pitch, Y is roll and Z is yaw.||rotation||Number|
|Type||Activation|| Trigger type, determines special behavior upon activation.
|Activation||Activation|| What or who can activate the trigger. Some options further depend on 'Activation Condition'.
|Activation||Activation|| What or who can activate the trigger. Some options further depend on 'Activation Type'. The available options are specific to the connected trigger owner.
|Activation Condition||Activation|| Condition of the 'Activation' attribute.
|Repeatable||Activation||Repetition rules. When enabled, the trigger can be activated again once deactivated.||repeatable||Bool|
|Condition||Expression|| Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.
Passed variables are:
|On Activation||Expression|| Expression executed once the trigger is activated.
Passed variables are:
|On Deactivation||Expression|| Expression executed once the trigger is deactivated.
Passed variables are:
|Timer Type||Timer|| Type of activation timer.
|Timer Values||Timer||Timer values in seconds, selected randomly in a range from Min to Max, gravitating towards Mid.||timeout||Array in format [min, mid, max]|
|Effect Condition||Effects||Condition for effects to be played, must return boolean expression.||effectCondition||String|
|Sound||Effects||Sound played upon activation.||sound||String|
|Voice||Effects||Sound spoken by the first unit which activated the trigger.||voice||String|
|Environment||Effects||Environment sounds played upon activation.||soundEnvironment||String|
|SFX||Effects||Sound effect played by the trigger upon activation. Repeats as long as the trigger is active.||soundTrigger||String|
|Music||Effects||Music played upon activation. Replaces previously playing music track.||music||String|
|UI Overlay||Effects||User interface overlay shown upon activation.||title||String|