triggerArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(locality and note added)
(updated with extra param returned)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns trigger area in the form [a, b, angle, rectangle].
| 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.


'''Note:''' 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. |= Description
<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;
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 22: Line 23:
|p3= |= PARAMETER3  
|p3= |= PARAMETER3  


| [[Array]] |= RETURNVALUE
| [[Array]] in format [a, b, angle, isRectangle, c], where:
 
* a - trigger area X size / 2
 
* b - trigger area Y size / 2
|x1= <code>_params <nowiki>=</nowiki> triggerArea sensor1; // result is [200, 120, 45, false]</code>|= EXAMPLE1
* angle
* isRectangle
* c - trigger area Z size / 2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''since Arma 3 v1.59.135137'')|= RETURNVALUE


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


| [[setTriggerArea]] |= SEEALSO  
| [[setTriggerArea]], [[inArea]]|= SEEALSO  


|  |= MPBEHAVIOUR  
|  |= MPBEHAVIOUR  

Revision as of 19:01, 24 March 2016

Hover & click on the images for description

Description

Description:
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.

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;
Groups:
Uncategorised

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.59.135137)

Examples

Example 1:
_area = triggerArea sensor1; // result is [200, 120, 45, false]
Example 2:
Since Arma 3 v1.59.135137:_area = triggerArea sensor1; // result is [200, 120, 45, false, -1];

Additional Information

See also:
setTriggerAreainArea

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

Notes

Bottom Section