inAreaArray: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.66 | |1.66 | ||
|arg= |Multiplayer Arguments("local" or "global")= | |arg= |Multiplayer Arguments("local" or "global")= | ||
|eff | |eff= | ||
|serverExec | |serverExec= | ||
|gr1= Triggers | |gr1= Triggers | ||
|gr2= Markers | |gr2= Markers | ||
|gr3= Locations | |gr3= Locations | ||
|gr4= Positions | |gr4= Positions | ||
| 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. | | 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. | ||
| positions '''inAreaArray''' area | | positions '''inAreaArray''' area | ||
|p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s | |p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s | ||
|p2= area: [[Object]], [[Location]] or [[String]] - the defined area: | |p2= area: [[Object]], [[Location]] or [[String]] - the defined area: | ||
* [[Object]] - trigger | * [[Object]] - trigger | ||
* [[Location]] - location | * [[Location]] - location | ||
* [[String]] - marker name | * [[String]] - marker name | ||
| [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area | | [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area | ||
|s2= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c] | |s2= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c] | ||
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check |PARAMETER21= | |p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check |PARAMETER21= | ||
| Line 48: | Line 48: | ||
|p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2) |PARAMETER27= | |p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2) |PARAMETER27= | ||
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area | |r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area | ||
|x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code> | |x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code> | ||
|x2= <code>[[allUnits]] [[inAreaArray]] "myMarker";</code> | |x2= <code>[[allUnits]] [[inAreaArray]] "myMarker";</code> | ||
|x3= <code>[[allPlayers]] [[inAreaArray]] myLocation;</code> | |x3= <code>[[allPlayers]] [[inAreaArray]] myLocation;</code> | ||
|x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code> | |x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code> | ||
| [[inArea]], [[triggerArea]] | | [[inArea]], [[triggerArea]] | ||
}} | }} | ||
Revision as of 00:41, 18 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