Eden Editor: Trigger: Difference between revisions
mNo edit summary |
(→Attributes: removed faulty size2 and updated description of size3) |
||
(21 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{{TOC|side}} | |||
A trigger is a virtual entity which executes an action once a specific condition is met. | A trigger is a virtual entity which executes an action once a specific condition is met. | ||
[[File:3den_triggerArea3D.jpg|center]] | |||
== Trigger Area == | |||
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. | |||
[[File:3den_triggerAreaZ.gif|center]] | |||
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. | |||
[[File:3den_triggerMove2D.gif|center]] | |||
== Activation Condition == | |||
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. | 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. | ||
{{Feature|important|Animals are part of the civillian side. That means they can activate triggers which condition is set to "Civilian".}} | |||
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. | == Trigger Owner == | ||
Use the '''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). | |||
[[File:3den_connectTriggerOwner.gif|center]] | [[File:3den_connectTriggerOwner.gif|center]] | ||
== Timer == | |||
Using the '''Timer''' attribute, you can set 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. | |||
== On Activation == | |||
Once the condition is met, the trigger becomes activated. Its '''On Activation''' expression is executed, and connected waypoints or modules may be activated as well. | |||
== Repeatable == | |||
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. | 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. | ||
Line 20: | Line 42: | ||
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. | 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. | ||
== Attributes == | == Attributes == | ||
<onlyinclude> | <onlyinclude> | ||
<!-- Exported from the game by BIS_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. --> | <!-- Exported from the game by BIS_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. --> | ||
Line 33: | Line 55: | ||
! Category | ! Category | ||
! class="unsortable" | Description | ! class="unsortable" | Description | ||
! | ! Property | ||
! Type | ! Type | ||
|- | |- | ||
Line 39: | Line 61: | ||
| Init | | 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. | | 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. | ||
| <small> | | <small>{{hl|name}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 45: | Line 67: | ||
| Init | | 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. | | 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. | ||
| <small> | | <small>{{hl|text}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
| '''Position''' | | '''Position''' | ||
| Transformation | | Transformation | ||
| World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain. | | World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain. | ||
| <small> | | <small>{{hl|position}}</small> | ||
| [[Position3D]] | | [[Position#Introduction|Position3D]] | ||
|- | |- | ||
| '''Rotation''' | | '''Rotation''' | ||
| Transformation | | Transformation | ||
| Local rotation in degrees. X is pitch, Y is roll and Z is yaw. | | Local rotation in degrees. X is pitch, Y is roll and Z is yaw. | ||
| <small> | | <small>{{hl|rotation}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |||
| '''Size''' | |||
| Transformation | |||
| Area size in meters in format [a, b, c]. | |||
| <small>{{hl|size3}}</small> | |||
| [[Array]] | |||
|- | |||
| '''Shape''' | |||
| Transformation | |||
| Area shape. | |||
Available options: | |||
* '''Ellipse''' | |||
* '''Rectangle''' | |||
| <small>{{hl|IsRectangle}}</small> | |||
| [[Boolean]] | |||
|- | |- | ||
| '''Type''' | | '''Type''' | ||
Line 86: | Line 108: | ||
* '''Lose''' - Fail the scenario. | * '''Lose''' - Fail the scenario. | ||
| <small> | | <small>{{hl|TriggerType}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 94: | Line 116: | ||
Available options: | Available options: | ||
* '''None''' - No default activation, only a custom condition expression can activate the trigger. | * '''None''' - No default activation, only a custom condition expression can activate the trigger. | ||
* '''Any Player''' - Activated when any player of the given side satisfies the 'Activation Condition'. | |||
* '''Anybody''' - Activated when any object satisfies the 'Activation Condition'. | * '''Anybody''' - Activated when any object satisfies the 'Activation Condition'. | ||
* '''BLUFOR, OPFOR, Independent, Civilian, Game Logic''' - Activated when any object of the given side satisfies the 'Activation Condition'. | * '''BLUFOR, OPFOR, Independent, Civilian, Game Logic''' - Activated when any object of the given side satisfies the 'Activation Condition'. | ||
Line 99: | Line 122: | ||
* '''Radio Alpha, Radio Bravo, Radio Charlie, Radio Delta, Radio Echo, Radio Foxtrot, Radio Golf, Radio Hotel, Radio India, Radio Juliet''' - Activated by a player using a radio command (accessible for the player by pressing 0-0 on a standard keyboard). The trigger 'Text' will be used as the command title. | * '''Radio Alpha, Radio Bravo, Radio Charlie, Radio Delta, Radio Echo, Radio Foxtrot, Radio Golf, Radio Hotel, Radio India, Radio Juliet''' - Activated by a player using a radio command (accessible for the player by pressing 0-0 on a standard keyboard). The trigger 'Text' will be used as the command title. | ||
| <small> | | <small>{{hl|ActivationBy}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 111: | Line 134: | ||
* '''Any Group Member''' - Activated when anyone from the owner's group satisfies the 'Activation Condition'. | * '''Any Group Member''' - Activated when anyone from the owner's group satisfies the 'Activation Condition'. | ||
| <small> | | <small>{{hl|activationByOwner}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
| '''Activation | | '''Activation Type''' | ||
| Activation | | Activation | ||
| Condition of the 'Activation' attribute. | | Condition of the 'Activation' attribute. | ||
Line 122: | Line 145: | ||
* '''Detected by BLUFOR, Detected by OPFOR, Detected by Independent, Detected by Civilian''' - Activated when objects are in the area and are discovered by the given side. | * '''Detected by BLUFOR, Detected by OPFOR, Detected by Independent, Detected by Civilian''' - Activated when objects are in the area and are discovered by the given side. | ||
| <small> | | <small>{{hl|activationType}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 128: | Line 151: | ||
| Activation | | Activation | ||
| Repetition rules. When enabled, the trigger can be activated again once deactivated. | | Repetition rules. When enabled, the trigger can be activated again once deactivated. | ||
| <small>< | | <small>{{hl|repeatable}}</small> | ||
| [[ | | [[Boolean]] | ||
|- | |||
| '''Server Only''' | |||
| Activation | |||
| When enabled, the trigger will only be created and evaluated on the server. | |||
| <small>{{hl|isServerOnly}}</small> | |||
| [[Boolean]] | |||
|- | |- | ||
| '''Condition''' | | '''Condition''' | ||
Line 138: | Line 167: | ||
* thisList - list of all objects in trigger area, based on 'Activation' | * thisList - list of all objects in trigger area, based on 'Activation' | ||
* thisTrigger - trigger object | * thisTrigger - trigger object | ||
| <small> | | <small>{{hl|condition}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |||
| '''Interval''' | |||
| Expression | |||
| How frequently the trigger condition is evaluated in seconds. | |||
| <small>{{hl|triggerInterval}}</small> | |||
| [[Number]] | |||
|- | |- | ||
| '''On Activation''' | | '''On Activation''' | ||
Line 147: | Line 182: | ||
* thisList - list of all objects in trigger area, based on 'Activation' | * thisList - list of all objects in trigger area, based on 'Activation' | ||
* thisTrigger - trigger object | * thisTrigger - trigger object | ||
| <small> | | <small>{{hl|onActivation}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 155: | Line 190: | ||
Passed variables are: | Passed variables are: | ||
* thisTrigger - trigger object | * thisTrigger - trigger object | ||
| <small> | | <small>{{hl|onDeactivation}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 165: | Line 200: | ||
* '''Timeout''' - The trigger's conditions must be satisfied for the specified duration for the trigger to be activated. | * '''Timeout''' - The trigger's conditions must be satisfied for the specified duration for the trigger to be activated. | ||
| <small> | | <small>{{hl|interuptable}}</small> | ||
| [[ | | [[Boolean]] | ||
|- | |- | ||
| '''Timer Values''' | | '''Timer Values''' | ||
| Timer | | Timer | ||
| Timer values in seconds, selected randomly in a range from Min to Max, gravitating towards Mid. | | Timer values in seconds, selected randomly in a range from Min to Max, gravitating towards Mid. | ||
| <small> | | <small>{{hl|timeout}}</small> | ||
| [[Array]] in format [min, mid, max] | | [[Array]] in format [min, mid, max] | ||
|- | |- | ||
Line 177: | Line 212: | ||
| Effects | | Effects | ||
| Condition for effects to be played, must return boolean expression. | | Condition for effects to be played, must return boolean expression. | ||
| <small> | | <small>{{hl|effectCondition}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 183: | Line 218: | ||
| Effects | | Effects | ||
| Sound played upon activation. | | Sound played upon activation. | ||
| <small> | | <small>{{hl|sound}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 189: | Line 224: | ||
| Effects | | Effects | ||
| Sound spoken by the first unit which activated the trigger. | | Sound spoken by the first unit which activated the trigger. | ||
| <small> | | <small>{{hl|voice}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 195: | Line 230: | ||
| Effects | | Effects | ||
| Environment sounds played upon activation. | | Environment sounds played upon activation. | ||
| <small> | | <small>{{hl|soundEnvironment}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 201: | Line 236: | ||
| Effects | | Effects | ||
| Sound effect played by the trigger upon activation. Repeats as long as the trigger is active. | | Sound effect played by the trigger upon activation. Repeats as long as the trigger is active. | ||
| <small> | | <small>{{hl|soundTrigger}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 207: | Line 242: | ||
| Effects | | Effects | ||
| Music played upon activation. Replaces previously playing music track. | | Music played upon activation. Replaces previously playing music track. | ||
| <small> | | <small>{{hl|music}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 213: | Line 248: | ||
| Effects | | Effects | ||
| User interface overlay shown upon activation. | | User interface overlay shown upon activation. | ||
| <small> | | <small>{{hl|title}}</small> | ||
| [[String]] | | [[String]] | ||
|} | |} | ||
</onlyinclude> | </onlyinclude> | ||
[[Category:Eden Editor: Asset Types|Triggers]] | [[Category:Eden Editor: Asset Types|Triggers]] |
Revision as of 11:04, 20 December 2023
A trigger is a virtual entity which executes an action once a specific condition is met.
Trigger Area
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.
Activation Condition
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.
Trigger Owner
Use the 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).
Timer
Using the Timer attribute, you can set 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.
On Activation
Once the condition is met, the trigger becomes activated. Its On Activation expression is executed, and connected waypoints or modules may be activated as well.
Repeatable
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.
Attributes
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
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 |
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 |
Size | Transformation | Area size in meters in format [a, b, c]. | size3 | Array |
Shape | Transformation | Area shape.
Available options:
|
IsRectangle | Boolean |
Type | Activation | Trigger type, determines special behavior upon activation.
Available options:
|
TriggerType | String |
Activation | Activation | What or who can activate the trigger. Some options further depend on 'Activation Condition'.
Available options:
|
ActivationBy | String |
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.
Available options:
|
activationByOwner | String |
Activation Type | Activation | Condition of the 'Activation' attribute.
Available options:
|
activationType | String |
Repeatable | Activation | Repetition rules. When enabled, the trigger can be activated again once deactivated. | repeatable | Boolean |
Server Only | Activation | When enabled, the trigger will only be created and evaluated on the server. | isServerOnly | Boolean |
Condition | Expression | Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.
Passed variables are:
|
condition | String |
Interval | Expression | How frequently the trigger condition is evaluated in seconds. | triggerInterval | Number |
On Activation | Expression | Expression executed once the trigger is activated.
Passed variables are:
|
onActivation | String |
On Deactivation | Expression | Expression executed once the trigger is deactivated.
Passed variables are:
|
onDeactivation | String |
Timer Type | Timer | Type of activation timer.
Available options:
|
interuptable | Boolean |
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 |