Eden Editor: Trigger: Difference between revisions
(important note about civilian triggers and animals) |
Lou Montana (talk | contribs) (Fix "Server Only" description) |
||
Line 2: | Line 2: | ||
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]] | [[File:3den_triggerArea3D.jpg|center]] | ||
== Trigger Area == | == 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. | 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]] | [[File:3den_triggerAreaZ.gif|center]] | ||
Line 10: | Line 12: | ||
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. | 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]] | [[File:3den_triggerMove2D.gif|center]] | ||
== Activation Condition == | == 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".}} | {{Feature|important|Animals are part of the civillian side. That means they can activate triggers which condition is set to "Civilian".}} | ||
== Trigger Owner == | == 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). | 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 == | == 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. | 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 == | == 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. | 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 == | == 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. | ||
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 148: | Line 162: | ||
| '''Server Only''' | | '''Server Only''' | ||
| Activation | | Activation | ||
| When enabled, the trigger will be evaluated | | When enabled, the trigger will only be created and evaluated on the server. | ||
| <small>{{hl|isServerOnly}}</small> | | <small>{{hl|isServerOnly}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
Line 243: | Line 257: | ||
| [[String]] | | [[String]] | ||
|} | |} | ||
</onlyinclude> | |||
[[Category:Eden Editor: Asset Types|Triggers]] | [[Category:Eden Editor: Asset Types|Triggers]] |
Revision as of 14:21, 19 August 2022
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. | size2 | Array |
Size | Transformation | Area size in meters. | 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 |