triggerArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|arg= global|= Arguments in MP
|version2= 1.50
|eff= local |= Effects in MP
____________________________________________________________________________________________


| Returns currently monitored trigger area. The trigger could be local or remote but the result returned by this command will be for the trigger condition set up locally on the client that executed the command. See [[createTrigger]] for more info.
|game3= tkoh
|version3= 1.00


<br><br>'''NOTE''': Since Arma 3 v1.59.135137, [[triggerArea]] returns 3rd dimension for the monitored area. If height is not set, the value for it would be -1;
|game4= arma3
|= Description
|version4= 0.50
____________________________________________________________________________________________


| '''triggerArea''' trigger |= Syntax
|arg= global


|p1= trigger: [[Object]] |PARAMETER1=  
|gr1= Triggers


|p2= |PARAMETER2=
|descr= Returns currently monitored trigger area. Since Arma 3 v1.60, the command returns 3rd dimension for the monitored area. If height is not set, the value for it would be -1.
{{Feature | important | The trigger could be [[Multiplayer Scripting#Locality|local]] or remote but the result returned by this command will be for the trigger area set up locally on the client that executed the command. See [[createTrigger]] for more info.}}


|p3= |PARAMETER3=  
|s1= [[triggerArea]] trigger


| [[Array]] in format [a, b, angle, isRectangle, c], where:
|p1= trigger: [[Object]]
 
|r1= [[Array]] in format [a, b, angle, isRectangle, c], where:
* a - trigger area X size / 2
* a - trigger area X size / 2
* b - trigger area Y size / 2
* b - trigger area Y size / 2
* angle
* angle
* isRectangle
* isRectangle
* c - trigger area Z size / 2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''since Arma 3 v1.59.135137'')|RETURNVALUE=
* c - trigger area Z size / 2 (since {{arma3}} v1.60)


|x1= <code>_area = [[triggerArea]] sensor1; // result is [200, 120, 45, false]</code>|EXAMPLE1=
|x1= <sqf>_area = triggerArea sensor1; // result is [200, 120, 45, false, -1];</sqf>
|x2= Since Arma 3 v1.59.135137:<code>_area = [[triggerArea]] sensor1; // result is [200, 120, 45, false, -1];</code>|EXAMPLE2=
____________________________________________________________________________________________


| [[setTriggerArea]], [[inArea]], [[inAreaArray]]|SEEALSO=
|seealso= [[setTriggerArea]] [[inArea]] [[inAreaArray]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:25, 13 May 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns currently monitored trigger area. Since Arma 3 v1.60, the command returns 3rd dimension for the monitored area. If height is not set, the value for it would be -1.
⚠
The trigger could be local or remote but the result returned by this command will be for the trigger area set up locally on the client that executed the command. See createTrigger for more info.
Groups:
Triggers

Syntax

Syntax:
triggerArea trigger
Parameters:
trigger: Object
Return Value:
Array in format [a, b, angle, isRectangle, c], where:
  • a - trigger area X size / 2
  • b - trigger area Y size / 2
  • angle
  • isRectangle
  • c - trigger area Z size / 2 (since Arma 3 v1.60)

Examples

Example 1:
_area = triggerArea sensor1; // result is [200, 120, 45, false, -1];

Additional Information

See also:
setTriggerArea inArea inAreaArray

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
Retrieved from "https://community.bistudio.com/wiki?title=triggerArea&oldid=319808"