Eden Editor: Trigger: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Add trigger's SFX note)
 
(31 intermediate revisions by 8 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.
[[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 visualised 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.
{{Feature|important|Animals are part of the civillian side. That means they can activate triggers which condition is set to "Civilian".}}
== 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]]
== 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 ==
== Attributes ==
<!-- Exported from the game by bis_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. -->
 
<onlyinclude>
<onlyinclude>
<!-- Exported from the game by BIS_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. -->
{| class="wikitable sortable"
{| class="wikitable sortable"
! colspan="3" | <big>Info</big>
! colspan="3" | <big>Info</big>
Line 9: Line 55:
! Category
! Category
! class="unsortable" | Description
! class="unsortable" | Description
! Class
! Property
! Type
! Type
|-
|-
| '''Variable Name'''
| '''Variable Name'''
| Trigger 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><tt>name</tt></small>
| <small>{{hl|name}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Text'''
| '''Text'''
| Trigger Init
| Init
| Trigger description. Players can see it in the radio menu when 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><tt>text</tt></small>
| <small>{{hl|text}}</small>
| [[String]]
| [[String]]
|-
| '''Position'''
| Transformation
| World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain.
| <small>{{hl|position}}</small>
| [[Position#Introduction|Position3D]]
|-
| '''Rotation'''
| Transformation
| Local rotation in degrees. X is pitch, Y is roll and Z is yaw.
| <small>{{hl|rotation}}</small>
| [[Number]]
|-
| '''Size'''
| Transformation
| Area size in meters in format [a, b, c].
| <small>{{hl|size3}}</small>
| [[Array]]
|-
|-
| '''Shape'''
| '''Shape'''
| Trigger Transformation
| Transformation
| Trigger area shape.
| Area shape.
Available options:
Available options:
* '''Ellipse'''
* '''Ellipse'''
* '''Rectangle'''
* '''Rectangle'''


| <small><tt>IsRectangle</tt></small>
| <small>{{hl|IsRectangle}}</small>
| [[Bool]]
| [[Boolean]]
|-
| '''Size'''
| Trigger Transformation
| Trigger area size in meters.
| <small><tt>size2</tt></small>
| [[Array]]
|-
| '''Position'''
| Trigger Transformation
| World coordinates in meters. X goes from East to West, Y from South to North and Z is height above terrain.
| <small><tt>position</tt></small>
| [[Position3D]]
|-
| '''Rotation'''
| Trigger Transformation
| Rotation in degrees. 0 points to North.
| <small><tt>rotation</tt></small>
| [[Number]]
|-
|-
| '''Type'''
| '''Type'''
| Trigger Activation
| Activation
| Trigger type, determines special behaviour upon activation.
| Trigger type, determines special behavior upon activation.
Available options:
Available options:
* '''None'''
* '''None''' - No other effects except of those defined by 'On Activation' expression.
* '''Guarded by BLUFOR'''
* '''Guarded by BLUFOR'''/'''OPFOR'''/'''Independent''' - The trigger position becomes a point to be guarded by the given side. Groups with a 'Guard' waypoint will protect all guard points in the scenario, prioritizing them by the distance and order in which they were placed (the first placed is the most important).
* '''Guarded by OPFOR'''
* '''Skip Waypoint''' - Meant to work with a waypoint linked to the trigger using the 'Set Waypoint Activation' connection. Once activated, the trigger will force the waypoint to skip. Particularly useful for 'Hold' or 'Guard' waypoint types, which do not complete automatically.
* '''Guarded by Independent'''
* '''End #1'''/'''#2'''/'''#3'''/'''#4'''/'''#5'''/'''#6''' - Complete the scenario successfully.
* '''Switch'''
* '''Lose''' - Fail the scenario.
* '''End #1'''
* '''End #2'''
* '''End #3'''
* '''End #4'''
* '''End #5'''
* '''End #6'''
* '''Lose'''


| <small><tt>TriggerType</tt></small>
| <small>{{hl|TriggerType}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Activation'''
| '''Activation'''
| Trigger Activation
| Activation
| Activation determines objects of which side will activate the trigger area (unless it's a Radio activation, in which case the area is irrelevant).
| What or who can activate the trigger. Some options further depend on 'Activation Condition'.
Available options:
Available options:
* '''None'''
* '''None''' - No default activation, only a custom condition expression can activate the trigger.
* '''BLUFOR'''
* '''Any Player''' - Activated when any player of the given side satisfies the 'Activation Condition'.
* '''OPFOR'''
* '''Anybody''' - Activated when any object satisfies the 'Activation Condition'.
* '''Independent'''
* '''BLUFOR'''/'''OPFOR'''/'''Independent'''/'''Civilian Game Logic''' - Activated when any object of the given side satisfies the 'Activation Condition'.
* '''Civilian'''
* '''Seized by BLUFOR'''/'''OPFOR'''/'''Independent''' - Activated when the given side is in control of the area. Strength matters, which means one tank can be in control of an area while ten enemy infantrymen are still present.
* '''Game Logic'''
* '''Radio Alpha'''/'''Bravo'''/'''Charlie'''/'''Delta'''/'''Echo'''/'''Foxtrot'''/'''Golf'''/'''Hotel'''/'''India'''/'''Juliet''' - Activated by a player using a radio command (accessible for the player by pressing 0-0 on a standard keyboard). The trigger's 'Text' will be used as the command title.
* '''Anybody'''
* '''Radio Alpha'''
* '''Radio Bravo'''
* '''Radio Charlie'''
* '''Radio Delta'''
* '''Radio Echo'''
* '''Radio Foxtrot'''
* '''Radio Golf'''
* '''Radio Hotel'''
* '''Radio India'''
* '''Radio Juliet'''
* '''Seized by BLUFOR'''
* '''Seized by OPFOR'''
* '''Seized by Independent'''


| <small><tt>ActivationBy</tt></small>
| <small>{{hl|ActivationBy}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Activation'''
| '''Activation'''
| Trigger Activation
| Activation
| Activation determines which group members will activate the trigger area (unless it's a Radio activation, in which case the area is irrelevant).
| 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:
Available options:
* '''Vehicle'''
* '''Owner Only''' - Activated when the connected trigger owner (or its vehicle, if the owner is a crew member) satisfies the 'Activation Condition'.
* '''Whole Group'''
* '''Whole Group''' - Activated when all the owner's group members satisfy the 'Activation Condition'.
* '''Group Leader'''
* '''Group Leader''' - Activated when leader of the owner's group satisfies the 'Activation Condition'.
* '''Any Group Member'''
* '''Any Group Member''' - Activated when anyone from the owner's group satisfies the 'Activation Condition'.


| <small><tt>activationByOwner</tt></small>
| <small>{{hl|activationByOwner}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Activation Type'''
| '''Activation Type'''
| Trigger Activation
| Activation
| Defines how can objects influence trigger activation.
| Condition of the 'Activation' attribute.
Available options:
Available options:
* '''Present'''
* '''Present''' - Activated when objects are in the area.
* '''Not Present'''
* '''Not Present''' - Activated when objects are not in the area.
* '''Detected by BLUFOR'''
* '''Detected by BLUFOR'''/'''OPFOR'''/'''Independent'''/'''Civilian''' - Activated when objects are in the area and are discovered by the given side.
* '''Detected by OPFOR'''
* '''Detected by Independent'''
* '''Detected by Civilian'''


| <small><tt>activationType</tt></small>
| <small>{{hl|activationType}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Repeatable'''
| '''Repeatable'''
| Trigger Activation
| Activation
| Repetition rules. When enabled, the trigger can be activated again once deativated.
| Repetition rules. When enabled, the trigger can be activated again once deactivated.
| <small><tt>repeatable</tt></small>
| <small>{{hl|repeatable}}</small>
| [[Bool]]
| [[Boolean]]
|-
| '''Server Only'''
| Activation
| When enabled, the trigger will only be created and evaluated on the server.
| <small>{{hl|isServerOnly}}</small>
| [[Boolean]]
|-
|-
| '''Condition'''
| '''Condition'''
| Trigger Expression
| Expression
| Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.
| Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.
Passed variables are:
Passed variables are:
* this - boolean value of trigger conditions
* this - boolean value of activation condition
* thisList - list of all objects in trigger area
* thisList - list of all objects in trigger area, based on 'Activation'
* thisTrigger - the trigger object
* thisTrigger - trigger object
| <small><tt>condition</tt></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'''
| Trigger Expression
| Expression
| Expression executed once the trigger is activated.
| Expression executed once the trigger is activated.
| <small><tt>onActivation</tt></small>
Passed variables are:
* thisList - list of all objects in trigger area, based on 'Activation'
* thisTrigger - trigger object
| <small>{{hl|onActivation}}</small>
| [[String]]
| [[String]]
|-
|-
| '''On Deactivation'''
| '''On Deactivation'''
| Trigger Expression
| Expression
| Expression executed once the trigger is deactivated.
| Expression executed once the trigger is deactivated. {{Feature|informative|This only concerns '''Repeatable''' triggers.}}
| <small><tt>onDeactivation</tt></small>
Passed variables are:
* thisTrigger - trigger object
| <small>{{hl|onDeactivation}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Timer Type'''
| '''Timer Type'''
| Trigger Timer
| Timer
| Type of activation timer.
| Type of activation timer.
Available options:
Available options:
* '''Countdown''' - Once the conditions are met, the trigger will activate after the specified amount of time has elapsed.
* '''Countdown''' - Once the conditions are met, the trigger will activate after the specified amount of time has elapsed.
* '''Timeout''' - The trigger's conditions must be satisfied for the entirety of specified amount of time for the trigger to activate.
* '''Timeout''' - The trigger's conditions must be satisfied for the specified duration for the trigger to be activated.


| <small><tt>interuptable</tt></small>
| <small>{{hl|interuptable}}</small>
| [[Bool]]
| [[Boolean]]
|-
|-
| '''Timer Values'''
| '''Timer Values'''
| Trigger Timer
| Timer
| Timer values in seconds, selected randomly in 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><tt>timeout</tt></small>
| <small>{{hl|timeout}}</small>
| [[Array]] in format [min, mid, max]
| [[Array]] in format [min, mid, max]
|-
|-
| '''Effect Condition'''
| '''Effect Condition'''
| Trigger Effects
| Effects
| Condition for effects to be played, must return boolean expression.
| Condition for effects to be played, must return boolean expression.
| <small><tt>effectCondition</tt></small>
| <small>{{hl|effectCondition}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Sound'''
| '''Sound'''
| Trigger Effects
| Effects
| Sound player upon activation.
| Sound played upon activation.
| <small><tt>sound</tt></small>
| <small>{{hl|sound}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Voice'''
| '''Voice'''
| Trigger Effects
| Effects
| Sound spoken by the first unit which activated the trigger.
| Sound spoken by the first unit which activated the trigger.
| <small><tt>voice</tt></small>
| <small>{{hl|voice}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Environment'''
| '''Environment'''
| Trigger Effects
| Effects
| Environment sounds played upon activation.
| Environment sounds played upon activation.
| <small><tt>soundEnvironment</tt></small>
| <small>{{hl|soundEnvironment}}</small>
| [[String]]
| [[String]]
|-
|-
| '''SFX'''
| '''SFX'''
| Trigger 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 repeatable trigger is active or forever for non-repeatable triggers.
| <small><tt>soundTrigger</tt></small>
| <small>{{hl|soundTrigger}}</small>
| [[String]]
| [[String]]
|-
|-
| '''Music'''
| '''Music'''
| Trigger Effects
| Effects
| Music played upon activation. Replaces previously playing music track.
| Music played upon activation. Replaces previously playing music track.
| <small><tt>music</tt></small>
| <small>{{hl|music}}</small>
| [[String]]
| [[String]]
|-
|-
| '''UI Overlay'''
| '''UI Overlay'''
| Trigger Effects
| Effects
| User interface overlay shown upon activation.
| User interface overlay shown upon activation.
| <small><tt>title</tt></small>
| <small>{{hl|title}}</small>
| [[String]]
| [[String]]
|}
|}
</onlyinclude>
</onlyinclude>


[[Category:Eden Editor|Triggers]]
 
[[Category:Eden Editor: Asset Types|Triggers]]
[[Category:Eden Editor: Asset Types|Triggers]]

Latest revision as of 16:37, 15 October 2024

A trigger is a virtual entity which executes an action once a specific condition is met.

3den triggerArea3D.jpg


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.

3den triggerAreaZ.gif


You can see it visualised 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.

3den triggerMove2D.gif


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.

⚠
Animals are part of the civillian side. That means they can activate triggers which condition is set to "Civilian".


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).

3den connectTriggerOwner.gif


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:

  • Ellipse
  • Rectangle
 IsRectangle Boolean
Type Activation Trigger type, determines special behavior upon activation.

Available options:

  • None - No other effects except of those defined by 'On Activation' expression.
  • Guarded by BLUFOR/OPFOR/Independent - The trigger position becomes a point to be guarded by the given side. Groups with a 'Guard' waypoint will protect all guard points in the scenario, prioritizing them by the distance and order in which they were placed (the first placed is the most important).
  • Skip Waypoint - Meant to work with a waypoint linked to the trigger using the 'Set Waypoint Activation' connection. Once activated, the trigger will force the waypoint to skip. Particularly useful for 'Hold' or 'Guard' waypoint types, which do not complete automatically.
  • End #1/#2/#3/#4/#5/#6 - Complete the scenario successfully.
  • Lose - Fail the scenario.
 TriggerType String
Activation Activation What or who can activate the trigger. Some options further depend on 'Activation Condition'.

Available options:

  • 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'.
  • BLUFOR/OPFOR/Independent/Civilian Game Logic - Activated when any object of the given side satisfies the 'Activation Condition'.
  • Seized by BLUFOR/OPFOR/Independent - Activated when the given side is in control of the area. Strength matters, which means one tank can be in control of an area while ten enemy infantrymen are still present.
  • Radio Alpha/Bravo/Charlie/Delta/Echo/Foxtrot/Golf/Hotel/India/Juliet - Activated by a player using a radio command (accessible for the player by pressing 0-0 on a standard keyboard). The trigger's 'Text' will be used as the command title.
 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:

  • Owner Only - Activated when the connected trigger owner (or its vehicle, if the owner is a crew member) satisfies the 'Activation Condition'.
  • Whole Group - Activated when all the owner's group members satisfy the 'Activation Condition'.
  • Group Leader - Activated when leader of the owner's group satisfies the 'Activation Condition'.
  • Any Group Member - Activated when anyone from the owner's group satisfies the 'Activation Condition'.
 activationByOwner String
Activation Type Activation Condition of the 'Activation' attribute.

Available options:

  • Present - Activated when objects are in the area.
  • Not Present - Activated when objects are not in the area.
  • Detected by BLUFOR/OPFOR/Independent/Civilian - Activated when objects are in the area and are discovered by the given side.
 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:

  • this - boolean value of activation condition
  • thisList - list of all objects in trigger area, based on 'Activation'
  • thisTrigger - trigger object
 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:

  • thisList - list of all objects in trigger area, based on 'Activation'
  • thisTrigger - trigger object
 onActivation String
On Deactivation Expression Expression executed once the trigger is deactivated.
ⓘ
This only concerns Repeatable triggers.

Passed variables are:

  • thisTrigger - trigger object
 onDeactivation String
Timer Type Timer Type of activation timer.

Available options:

  • Countdown - Once the conditions are met, the trigger will activate after the specified amount of time has elapsed.
  • Timeout - The trigger's conditions must be satisfied for the specified duration for the trigger to be activated.
 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 repeatable trigger is active or forever for non-repeatable triggers. 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
Retrieved from "https://community.bistudio.com/wiki?title=Eden_Editor:_Trigger&oldid=369831"