triggerArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|arg= global|Multiplayer Arguments=
|arg= global


|gr1= Triggers |GROUP1=
|gr1= Triggers


| Returns currently monitored trigger area. Since Arma 3 v1.59.135137, the command returns 3rd dimension for the monitored area. If height is not set, the value for it would be -1.
| Returns currently monitored trigger area. Since Arma 3 v1.59.135137, the command returns 3rd dimension for the monitored area. If height is not set, the value for it would be -1.
{{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.}} |DESCRIPTION=
{{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.}}


| '''triggerArea''' trigger |SYNTAX=
| '''triggerArea''' trigger


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


| [[Array]] in format [a, b, angle, isRectangle, c], where:
| [[Array]] in format [a, b, angle, isRectangle, c], where:
Line 21: Line 21:
* angle
* angle
* isRectangle
* isRectangle
* c - trigger area Z size / 2 {{Since|arma3|1.59.135137|y}} |RETURNVALUE=
* c - trigger area Z size / 2 {{Since|arma3|1.59.135137|y}}


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


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



Revision as of 12:26, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns currently monitored trigger area. Since Arma 3 v1.59.135137, 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 Template:Since

Examples

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

Additional Information

See also:
setTriggerAreainAreainAreaArray

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