setTriggerStatements: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Some wiki formatting)
 
(80 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Defines a trigger's condition, and executable code for its activation and deactivation events. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| trigger '''setTriggerStatements''' [condition, activation, deactivation] |= Syntax
|game4= tkoh
|version4= 1.00


|p1= trigger: [[Object]] - Trigger object |= Parameter 1
|game5= arma3
|p2= condition: [[String]] - Code containing the trigger's condition, which has to return a [[boolean]] value. If ''this'' is used, the result of the trigger's [[setTriggerActivation|activation condition]] is interpreted.|= Parameter 2
|version5= 0.50
|p3= activation: [[String]] - Code that is executed when the trigger is activated (The variable [[this|thislist]] contains an array with the units that activated the trigger.)|= Parameter 3
|p4= deactivation: [[String]] - Code that is executed when the trigger is deactivated. |= Parameter 4


| [[Nothing]] |= Return value
|arg= global
____________________________________________________________________________________________
|eff= local
 
|x1= <code>_trg setTriggerStatements ["this", "hint 'trigger on'", "hint 'trigger off'"]</code> |= Example 1
____________________________________________________________________________________________


| [[createTrigger]], [[setTriggerActivation]], [[setTriggerArea]], [[setTriggerText]], [[setTriggerTimeout]], [[setTriggerType]], [[this]] |= See also
|gr1= Triggers


|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.
|s1= trigger [[setTriggerStatements]] [condition, activation, deactivation]
|p1= trigger: [[Object]] - trigger object
|p2= condition: [[String]] - code containing trigger condition. Special variables available here:
* [[Magic Variables#this_2|this]] ([[Boolean]]) - detection event
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisList]] ([[Array]]) - array of all detected entities
|p3= activation: [[String]] - code that is executed when the trigger is activated. Special variables available here:
* [[thisTrigger]] ([[Object]]) - trigger instance
* [[thisList]] ([[Array]]) - array of all detected entities
|p4= deactivation: [[String]] - code that is executed when the trigger is deactivated. Special variable available here:
* [[thisTrigger]] ([[Object]]) - trigger instance
|r1= [[Nothing]]
|x1= <sqf>_trg setTriggerStatements ["this", "hint 'trigger on'", "hint 'trigger off'"];</sqf>
|seealso= [[triggerStatements]] [[createTrigger]] [[setTriggerActivation]] [[setTriggerArea]] [[setTriggerText]] [[setTriggerTimeout]] [[setTriggerType]] [[Magic Variables#this_2|this]] [[thisList]] [[thisTrigger]] [[triggerInterval]] [[setTriggerInterval]] [[enableSimulation]] [[simulationEnabled]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Scifer
<!-- Note Section BEGIN -->
|timestamp= 20110314205200
An array with three arguments is mandatory for this function.
|text= An array with three arguments is mandatory for this function.
<!-- Note Section END -->
}}
</dl>


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|SETTRIGGERSTATEMENTS]]
|user= Heeeere's Johnny!
[[Category:Scripting Commands OFP Elite |SETTRIGGERSTATEMENTS]]
|timestamp= 20140916174100
[[Category:Scripting Commands ArmA|SETTRIGGERSTATEMENTS]]
|text= Magic variable ''thisList'' does not contain dead units.
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:14, 15 August 2022

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
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.
Retrieved from "https://community.bistudio.com/wiki?title=setTriggerStatements&oldid=330079"