inAreaArray: Difference between revisions
BrettMayson (talk | contribs) mNo edit summary |
Lou Montana (talk | contribs) (Fix result to keep version introduction - Brett è_é) |
||
| Line 31: | Line 31: | ||
|p21= positions: [[Array]] of [[Object]]s and/or [[Position]]s - Places to check. [[Position]]s must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D (see note in description) | |p21= positions: [[Array]] of [[Object]]s and/or [[Position]]s - Places to check. [[Position]]s must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D (see note in description) | ||
|p22= centre: {{GVI|arma3|2.14|size= 0.75}} [[Object]] | |p22= centre: [[Position#Introduction|Position2D]], [[Position#PositionAGL|PositionAGL]], {{GVI|arma3|2.14|size= 0.75}} [[Object]] or [[Group]] | ||
|p23= a: [[Number]] - x axis (x / 2) | |p23= a: [[Number]] - x axis (x / 2) | ||
| Line 49: | Line 49: | ||
|s3= positions [[inAreaArray]] [pos1, pos2, pos3,...] | |s3= positions [[inAreaArray]] [pos1, pos2, pos3,...] | ||
|s3since= | |s3since= arma3 2.20 | ||
|p41= positions: [[Array]] of [[Object]]s and/or [[Position]]s - | |||
|p41= positions: [[Array]] of [[Object]]s and/or [[Position]]s - places to check. | |||
|p42 = posN: [[Position]] - polygon vertices in 2d or 3d format (see [[inPolygon]]) | |p42 = posN: [[Position]] - polygon vertices in 2d or 3d format (see [[inPolygon]]) | ||
|r3= [[Array]] of [[Object]]s and/or [[Position]]s | |r3= [[Array]] of [[Object]]s and/or [[Position]]s | ||
Latest revision as of 14:05, 27 January 2026
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.
⚠By default all positions given as Array or as objects are treated as PositionAGL. Since
2.20 there is an option to force them to PositionWorld format. - Groups:
- TriggersMarkersLocationsPositions
Syntax 1
- Syntax:
- positions inAreaArray area
- Parameters:
- positions: Array of Objects and/or Positions
- area: Object, Location or String - the defined area:
- Return Value:
- Array of Objects and/or Positions
Syntax 2
- Syntax:
- positions inAreaArray [centre, a, b, angle, isRectangle, c, usePosWorld]
- Parameters:
- positions: Array of Objects and/or Positions - Places to check. Positions must be PositionAGL if area is checked in 3D (see note in description)
- centre: Position2D, PositionAGL, 2.14 Object or Group
- 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)
- since
2.20 - usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld
- Return Value:
- Array of Objects and/or Positions
Syntax 3
- Syntax:
- positions inAreaArray [pos1, pos2, pos3,...]
- Parameters:
- positions: Array of Objects and/or Positions - places to check.
- posN: Position - polygon vertices in 2d or 3d format (see inPolygon)
- Return Value:
- Array of Objects and/or Positions
Examples
- Example 1:
- Example 2:
- Example 3:
- Example 4:
Additional Information
- See also:
- inAreaArrayIndexes inArea triggerArea
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
- Posted on Jun 11, 2017 - 21:33 (UTC)
- The array you send the command can be filtered. For example: Will return only the statics inside the given marker.