triggerArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma2 *\| *(New )?Scripting Commands\}\}" to "")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 17: Line 17:
|gr1= Triggers
|gr1= Triggers


| 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.
|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 [[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.}}
{{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.}}


|s1= '''triggerArea''' trigger
|s1= [[triggerArea]] trigger


|p1= trigger: [[Object]]
|p1= trigger: [[Object]]


| [[Array]] in format [a, b, angle, isRectangle, c], where:
|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 {{Since|arma3|1.59.135137|y}}
* c - trigger area Z size / 2 (since {{arma3}} v1.60)


|x1= <code>_area = [[triggerArea]] sensor1; {{cc|result is [200, 120, 45, false, -1];}}</code>
|x1= <sqf>_area = triggerArea sensor1; // result is [200, 120, 45, false, -1];</sqf>


|seealso= [[setTriggerArea]], [[inArea]], [[inAreaArray]]
|seealso= [[setTriggerArea]] [[inArea]] [[inAreaArray]]
}}
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 11:25, 13 May 2022

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