setTriggerStatements: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
m (Some wiki formatting)
 
(38 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00
 
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|1.00
|arg= global
|arg= global
|eff= local
|eff= local
Line 9: Line 21:
|gr1= Triggers
|gr1= Triggers


| Defines trigger condition, activation and deactivation statements. Trigger condition has to return [[Boolean]]. [[true]] will activate the trigger, [[false]] will deactivate it (only if activation is set to repeat). [[thisList]] returns the same result as [[list]] command, which includes all entities in the trigger area that are capable of activating the trigger. Dead entities are excluded as well as crew in vehicles, vehicles themselves are included.
|descr= Defines trigger condition, activation and deactivation statements. Trigger condition has to return [[Boolean]]. [[true]] will activate the trigger, [[false]] will deactivate it (only if activation is set to repeat). [[thisList]] returns the same result as [[list]] command, which includes all entities in the trigger area that are capable of activating the trigger. Dead entities are excluded as well as crew in vehicles, vehicles themselves are included.


| trigger '''setTriggerStatements''' [condition, activation, deactivation]
|s1= trigger [[setTriggerStatements]] [condition, activation, deactivation]


|p1= trigger: [[Object]] - Trigger object
|p1= trigger: [[Object]] - trigger object
|p2= [condition, activation, deactivation]: [[Array]]


|p3= condition: [[String]] - Code containing trigger condition. Special variables available here:
|p2= condition: [[String]] - code containing trigger condition. Special variables available here:
* [[this]] ([[Boolean]]) - detection event
* [[Magic Variables#this_2|this]] ([[Boolean]]) - detection event
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisList]] ([[Array]]) - array of all detected entities
* [[thisList]] ([[Array]]) - array of all detected entities
|p4= activation: [[String]] - Code that is executed when the trigger is activated. Special variables available here:
 
|p3= activation: [[String]] - code that is executed when the trigger is activated. Special variables available here:
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisList]] ([[Array]]) - array of all detected entities
* [[thisList]] ([[Array]]) - array of all detected entities
|p5= deactivation: [[String]] - Code that is executed when the trigger is deactivated. Special variable available here:
 
|p4= deactivation: [[String]] - code that is executed when the trigger is deactivated. Special variable available here:
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisTrigger]] ([[Object]]) - trigger instance


| [[Nothing]]
|r1= [[Nothing]]
 
 
|x1= <code>_trg [[setTriggerStatements]] ["this", "[[hint]] 'trigger on'", "[[hint]] 'trigger off'"]</code>
|x1= <sqf>_trg setTriggerStatements ["this", "hint 'trigger on'", "hint 'trigger off'"];</sqf>


|seealso= [[triggerStatements]], [[createTrigger]], [[setTriggerActivation]], [[setTriggerArea]], [[setTriggerText]], [[setTriggerTimeout]], [[setTriggerType]], [[this]], [[thisList]], [[thisTrigger]], [[triggerInterval]], [[setTriggerInterval]], [[enableSimulation]], [[simulationEnabled]]
|seealso= [[triggerStatements]] [[createTrigger]] [[setTriggerActivation]] [[setTriggerArea]] [[setTriggerText]] [[setTriggerTimeout]] [[setTriggerType]] [[Magic Variables#this_2|this]] [[thisList]] [[thisTrigger]] [[triggerInterval]] [[setTriggerInterval]] [[enableSimulation]] [[simulationEnabled]]
}}
}}


<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Scifer
<dd class="notedate">Posted on Mar 14, 2011 - 20:52</dd>
|timestamp= 20110314205200
<dt class="note">[[User:Scifer|Scifer]]<dd class="note">
|text= An array with three arguments is mandatory for this function.
An array with three arguments is mandatory for this function.
}}
<!-- Note Section END -->
</dl>


 
{{Note
{{GameCategory|ofpe|Scripting Commands}}
|user= Heeeere's Johnny!
{{GameCategory|arma1|Scripting Commands}}
|timestamp= 20140916174100
 
|text= Magic variable ''thisList'' does not contain dead units.
{{GameCategory|arma2|Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 16, 2014 - 17:41 (UTC)</dd>
<dt class="note">[[User:Heeeere's Johnny!|Heeeere's Johnny!]]</dt>
<dd class="note">
Magic variable ''thisList'' does not contain dead units.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:14, 15 August 2022

Hover & click on the images for description

Description

Description:
Defines trigger condition, activation and deactivation statements. Trigger condition has to return Boolean. true will activate the trigger, false will deactivate it (only if activation is set to repeat). thisList returns the same result as list command, which includes all entities in the trigger area that are capable of activating the trigger. Dead entities are excluded as well as crew in vehicles, vehicles themselves are included.
Groups:
Triggers

Syntax

Syntax:
trigger setTriggerStatements [condition, activation, deactivation]
Parameters:
trigger: Object - trigger object
condition: String - code containing trigger condition. Special variables available here:
activation: String - code that is executed when the trigger is activated. Special variables available here:
deactivation: String - code that is executed when the trigger is deactivated. Special variable available here:
Return Value:
Nothing

Examples

Example 1:
_trg setTriggerStatements ["this", "hint 'trigger on'", "hint 'trigger off'"];

Additional Information

See also:
triggerStatements createTrigger setTriggerActivation setTriggerArea setTriggerText setTriggerTimeout setTriggerType this thisList thisTrigger triggerInterval setTriggerInterval enableSimulation simulationEnabled

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Scifer - c
Posted on Mar 14, 2011 - 20:52 (UTC)
An array with three arguments is mandatory for this function.
Heeeere's Johnny! - c
Posted on Sep 16, 2014 - 17:41 (UTC)
Magic variable thisList does not contain dead units.