Eden Editor: Trigger: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
== Attributes ==
== Attributes ==
<!-- Exported from the game by bis_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. -->
<onlyinclude>
<onlyinclude>
{| class="wikitable sortable"
{| class="wikitable sortable"
! colspan="3" | Info
! colspan="3" | <big>Info</big>
! colspan="2" | [[Eden Editor: Setting Attributes|Development]]
! colspan="2" | <big>[[Eden Editor: Setting Attributes|Development]]</big>
|-
|-
! Name
! Name
Line 13: Line 14:
| '''Variable Name'''
| '''Variable Name'''
| Trigger Init
| Trigger 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.
| <tt>name</tt>
| <small><tt>name</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Text'''
| '''Text'''
| Trigger Init
| Trigger 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.
| <tt>text</tt>
| <small><tt>text</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Shape'''
| '''Shape'''
| Trigger Transformation
| Trigger Transformation
|  
| Trigger area shape.
| <tt>IsRectangle</tt>
Available options:
* '''Ellipse'''
* '''Rectangle'''
 
| <small><tt>IsRectangle</tt></small>
| [[Bool]]
| [[Bool]]
|-
|-
| '''Size'''
| '''Size'''
| Trigger Transformation
| Trigger Transformation
|  
| Trigger area size in meters.
| <tt>size2</tt>
| <small><tt>size2</tt></small>
| [[Array]]
| [[Array]]
|-
|-
| '''Position'''
| '''Position'''
| Trigger Transformation
| Trigger Transformation
|  
| World coordinates in meters. X goes from East to West, Y from South to North and Z is height above terrain.
| <tt>position</tt>
| <small><tt>position</tt></small>
| [[Position3D]]
| [[Position3D]]
|-
|-
| '''Rotation'''
| '''Rotation'''
| Trigger Transformation
| Trigger Transformation
|  
| Rotation in degrees. 0 points to North.
| <tt>rotation</tt>
| <small><tt>rotation</tt></small>
| [[Number]]
| [[Number]]
|-
|-
| '''Type'''
| '''Type'''
| Trigger Activation
| Trigger Activation
|  
| Trigger type, determines special behaviour upon activation.
| <tt>TriggerType</tt>
Available options:
* '''None'''
* '''Guarded by BLUFOR'''
* '''Guarded by OPFOR'''
* '''Guarded by Independent'''
* '''Switch'''
* '''End #1'''
* '''End #2'''
* '''End #3'''
* '''End #4'''
* '''End #5'''
* '''End #6'''
* '''Lose'''
 
| <small><tt>TriggerType</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Activation'''
| '''Activation'''
| Trigger Activation
| Trigger 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).
| <tt>ActivationBy</tt>
Available options:
* '''None'''
* '''BLUFOR'''
* '''OPFOR'''
* '''Independent'''
* '''Civilian'''
* '''Game Logic'''
* '''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>
| [[String]]
| [[String]]
|-
|-
| '''Activation'''
| '''Activation'''
| Trigger Activation
| Trigger Activation
|  
| Activation determines which group members will activate the trigger area (unless it's a Radio activation, in which case the area is irrelevant).
| <tt>activationByOwner</tt>
Available options:
* '''Vehicle'''
* '''Whole Group'''
* '''Group Leader'''
* '''Any Group Member'''
 
| <small><tt>activationByOwner</tt></small>
| [[String]]
| [[String]]
|-
| '''Activation'''
| Trigger Activation
|
| <tt>activationByOwnerStatic</tt>
|
|-
|-
| '''Activation Type'''
| '''Activation Type'''
| Trigger Activation
| Trigger Activation
|  
| Defines how can objects influence trigger activation.
| <tt>activationType</tt>
Available options:
* '''Present'''
* '''Not Present'''
* '''Detected by BLUFOR'''
* '''Detected by OPFOR'''
* '''Detected by Independent'''
* '''Detected by Civilian'''
 
| <small><tt>activationType</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Repeatable'''
| '''Repeatable'''
| Trigger Activation
| Trigger Activation
|  
| Repetition rules. When enabled, the trigger can be activated again once deativated.
| <tt>repeatable</tt>
| <small><tt>repeatable</tt></small>
| [[Bool]]
| [[Bool]]
|-
|-
| '''Condition'''
| '''Condition'''
| Trigger Expression
| Trigger Expression
|  
| Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.
| <tt>condition</tt>
Passed variables are:
* this - boolean value of trigger conditions
* thisList - list of all objects in trigger area
* thisTrigger - the trigger object
| <small><tt>condition</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''On Activation'''
| '''On Activation'''
| Trigger Expression
| Trigger Expression
|  
| Expression executed once the trigger is activated.
| <tt>onActivation</tt>
| <small><tt>onActivation</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''On Deactivation'''
| '''On Deactivation'''
| Trigger Expression
| Trigger Expression
|  
| Expression executed once the trigger is deactivated.
| <tt>onDeactivation</tt>
| <small><tt>onDeactivation</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Timer Type'''
| '''Timer Type'''
| Trigger Timer
| Trigger Timer
|  
| Type of activation timer.
| <tt>interuptable</tt>
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 entirety of specified amount of time for the trigger to activate.
 
| <small><tt>interuptable</tt></small>
| [[Bool]]
| [[Bool]]
|-
|-
| '''Timer Values'''
| '''Timer Values'''
| Trigger Timer
| Trigger Timer
|  
| Timer values in seconds, selected randomly in range from Min to Max, gravitating towards Mid.
| <tt>timeout</tt>
| <small><tt>timeout</tt></small>
| [[Array]] in format [min, mid, max]
| [[Array]] in format [min, mid, max]
|-
|-
| '''Effect Condition'''
| '''Effect Condition'''
| Trigger Effects
| Trigger Effects
|  
| Condition for effects to be played, must return boolean expression.
| <tt>effectCondition</tt>
| <small><tt>effectCondition</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Sound'''
| '''Sound'''
| Trigger Effects
| Trigger Effects
|  
| Sound player upon activation.
| <tt>sound</tt>
| <small><tt>sound</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Voice'''
| '''Voice'''
| Trigger Effects
| Trigger Effects
|  
| Sound spoken by the first unit which activated the trigger.
| <tt>voice</tt>
| <small><tt>voice</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Environment'''
| '''Environment'''
| Trigger Effects
| Trigger Effects
|  
| Environment sounds played upon activation.
| <tt>soundEnvironment</tt>
| <small><tt>soundEnvironment</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''SFX'''
| '''SFX'''
| Trigger Effects
| Trigger Effects
|  
| Sound effect played by the trigger upon activation. Repeats as long as the trigger is active.
| <tt>soundTrigger</tt>
| <small><tt>soundTrigger</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''Music'''
| '''Music'''
| Trigger Effects
| Trigger Effects
|  
| Music played upon activation. Replaces previously playing music track.
| <tt>music</tt>
| <small><tt>music</tt></small>
| [[String]]
| [[String]]
|-
|-
| '''UI Overlay'''
| '''UI Overlay'''
| Trigger Effects
| Trigger Effects
|  
| User interface overlay shown upon activation.
| <tt>title</tt>
| <small><tt>title</tt></small>
| [[String]]
| [[String]]
|}
|}

Revision as of 18:11, 8 December 2015

Attributes

Info Development
Name Category Description Class Type
Variable Name Trigger 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 Trigger 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. text String
Shape Trigger Transformation Trigger area shape.

Available options:

  • Ellipse
  • Rectangle
IsRectangle Bool
Size Trigger Transformation Trigger area size in meters. size2 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. position Position3D
Rotation Trigger Transformation Rotation in degrees. 0 points to North. rotation Number
Type Trigger Activation Trigger type, determines special behaviour upon activation.

Available options:

  • None
  • Guarded by BLUFOR
  • Guarded by OPFOR
  • Guarded by Independent
  • Switch
  • End #1
  • End #2
  • End #3
  • End #4
  • End #5
  • End #6
  • Lose
TriggerType String
Activation Trigger 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).

Available options:

  • None
  • BLUFOR
  • OPFOR
  • Independent
  • Civilian
  • Game Logic
  • 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
ActivationBy String
Activation Trigger Activation Activation determines which group members will activate the trigger area (unless it's a Radio activation, in which case the area is irrelevant).

Available options:

  • Vehicle
  • Whole Group
  • Group Leader
  • Any Group Member
activationByOwner String
Activation Type Trigger Activation Defines how can objects influence trigger activation.

Available options:

  • Present
  • Not Present
  • Detected by BLUFOR
  • Detected by OPFOR
  • Detected by Independent
  • Detected by Civilian
activationType String
Repeatable Trigger Activation Repetition rules. When enabled, the trigger can be activated again once deativated. repeatable Bool
Condition Trigger Expression Repeatedly calculated condition, must return boolean expression. When true, the trigger will be activated.

Passed variables are:

  • this - boolean value of trigger conditions
  • thisList - list of all objects in trigger area
  • thisTrigger - the trigger object
condition String
On Activation Trigger Expression Expression executed once the trigger is activated. onActivation String
On Deactivation Trigger Expression Expression executed once the trigger is deactivated. onDeactivation String
Timer Type Trigger 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 entirety of specified amount of time for the trigger to activate.
interuptable Bool
Timer Values Trigger Timer Timer values in seconds, selected randomly in range from Min to Max, gravitating towards Mid. timeout Array in format [min, mid, max]
Effect Condition Trigger Effects Condition for effects to be played, must return boolean expression. effectCondition String
Sound Trigger Effects Sound player upon activation. sound String
Voice Trigger Effects Sound spoken by the first unit which activated the trigger. voice String
Environment Trigger Effects Environment sounds played upon activation. soundEnvironment String
SFX Trigger Effects Sound effect played by the trigger upon activation. Repeats as long as the trigger is active. soundTrigger String
Music Trigger Effects Music played upon activation. Replaces previously playing music track. music String
UI Overlay Trigger Effects User interface overlay shown upon activation. title String