inAreaArray: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Text replacement - "<dl class="command_description"> <dd class="notedate">" to "<dl class="command_description"> <dt></dt> <dd class="notedate">") |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 | | arma3 | ||
|1.66 | |1.66 | ||
|arg= | |arg= | ||
|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. | ||
|positions '''inAreaArray''' | | positions '''inAreaArray''' area | ||
|p1= positions: [[Array]] | |p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s | ||
|p2= | |p2= area: [[Object]], [[Location]] or [[String]] - the defined area: | ||
* [[Object]] - trigger | |||
* [[Location]] - location | |||
* [[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''' | |s2= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c] | ||
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check | |p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check | ||
|p22= | |p22= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]] | ||
| | |p23= a: [[Number]] - x axis (x / 2) | ||
| | |p24= b: [[Number]] - y axis (y / 2) | ||
| | |p25= angle: [[Number]] - (Optional, default 0) rotation angle | ||
| | |p26= isRectangle: [[Boolean]] - (Optional, default [[false]]) [[true]] if rectangle, [[false]] if ellipse | ||
| | |p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2) | ||
| | |r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area | ||
|x1= <code>[[vehicles]] [[inAreaArray]] | |x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code> | ||
| [[ | |x2= <code>[[allUnits]] [[inAreaArray]] "myMarker";</code> | ||
|x3= <code>[[allPlayers]] [[inAreaArray]] myLocation;</code> | |||
|x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code> | |||
< | |||
< | |||
</ | |||
|seealso= [[inArea]], [[triggerArea]] | |||
}} | |||
<dl class="command_description"> | <dl class="command_description"> | ||
<dt></dt> | |||
<dd class="notedate">Posted on June 11, 2017 - 21:33 (UTC)</dd> | <dd class="notedate">Posted on June 11, 2017 - 21:33 (UTC)</dd> | ||
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt> | <dt class="note">[[User:Tankbuster|Tankbuster]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
The array you send the command can be filtered. For example: | The array you send the command can be filtered. For example: | ||
<code>[[vehicles]] | <code>[[vehicles]] [[select]] { _x [[isKindOf]] "StaticWeapon" } [[inAreaArray]] "myMarker"</code> | ||
Will return only the statics inside the given marker | Will return only the statics inside the given marker | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Revision as of 14:26, 5 April 2021
Description
- Description:
- Description needed
- Groups:
- TriggersMarkersLocationsPositions
Syntax
- Syntax:
- Syntax needed
- Parameters:
- positions: Array of Objects and/or Positions
- area: Object, Location or String - the defined area:
- Return Value:
- Return value needed
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
- 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