inAreaArray: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Merge syntaxes) |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game= | | arma3 |Game= | ||
| Line 19: | Line 18: | ||
|gr4= Positions |GROUP4= | |gr4= Positions |GROUP4= | ||
| Returns given list of [[Object]]s and/or [[Position]]s that are in the given area, area defined by a trigger, marker, location or array. |DESCRIPTION= | | Returns given list of [[Object]]s and/or [[Position]]s that are in the given area, area defined by a trigger, marker, location or array. |DESCRIPTION= | ||
| positions '''inAreaArray''' area |SYNTAX= | | positions '''inAreaArray''' area |SYNTAX= | ||
| Line 52: | Line 49: | ||
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area |RETURNVALUE2= | |r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area |RETURNVALUE2= | ||
|x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code> |EXAMPLE1= | |x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code> |EXAMPLE1= | ||
| Line 61: | Line 57: | ||
|x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>|EXAMPLE4= | |x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>|EXAMPLE4= | ||
| [[inArea]], [[triggerArea]] |SEEALSO= | | [[inArea]], [[triggerArea]] |SEEALSO= | ||
Revision as of 01:40, 17 January 2021
Description
- Description:
- Returns given list of Objects and/or Positions that are in the given area, area defined by a trigger, marker, location or array.
- Groups:
- TriggersMarkersLocationsPositions
Syntax
- Syntax:
- positions inAreaArray area
- Parameters:
- positions: Array of Objects and/or Positions
- area: Object, Location or String - the defined area:
- Return Value:
- Array: Objects and/or Positions inside the trigger area
Alternative Syntax
- Syntax:
- positions inAreaArray [center, a, b, angle, isRectangle, c]
- Parameters:
- positions: Array - Objects and/or Positions to check
- center: Array - center of the area in format Position3D, Position2D
- a: Number - x axis (x / 2)
- b: Number - y axis (y / 2)
- angle: Number - (Optional, default 0) rotation angle
- isRectangle: Boolean - (Optional, default false) true if rectangle, false if ellipse
- c: Number - (Optional, default -1: unlimited) z axis (z / 2)
- Return Value:
- Array: Objects and/or Positions inside the area
Examples
- Example 1:
vehicles inAreaArray myTrigger;- Example 2:
allUnits inAreaArray "myMarker";- Example 3:
allPlayers inAreaArray myLocation;- Example 4:
allDead inAreaArray [[100, 100, 0], 20, 30, 45, false, 10];
Additional Information
- See also:
- inAreatriggerArea
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
Bottom Section
- Posted on June 11, 2017 - 21:33 (UTC)
- Tankbuster
-
The array you send the command can be filtered. For example:
vehicles select { _x isKindOf "StaticWeapon" } inAreaArray "myMarker"Will return only the statics inside the given marker