inAreaArray: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (Undo revision 103967 by Tankbuster (talk) Removed last note, because makes no sense) |
m (template:command argument fix) |
||
| Line 13: | Line 13: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Filters given list of [[Object]]s and/or [[Position]]s in relation to the given area, defined by a trigger, marker, location or array. Returns array of [[Object]]s and/or [[Position]]s from the list that are inside the area |= | | Filters given list of [[Object]]s and/or [[Position]]s in relation to the given area, defined by a trigger, marker, location or array. Returns array of [[Object]]s and/or [[Position]]s from the list that are inside the area |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|positions '''inAreaArray''' trigger |= | |positions '''inAreaArray''' trigger |SYNTAX= | ||
|p1= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= | |p1= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|PARAMETER1= | ||
|p2= trigger: [[Object]] - trigger with given area |= | |p2= trigger: [[Object]] - trigger with given area |PARAMETER2= | ||
| [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area|= | | [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area|RETURNVALUE= | ||
|s2=positions '''inAreaArray''' marker |= | |s2=positions '''inAreaArray''' marker |SYNTAX= | ||
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= | |p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|PARAMETER1= | ||
|p22= marker: [[String]] - marker with given area |= | |p22= marker: [[String]] - marker with given area |PARAMETER2= | ||
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the marker area|= | |r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the marker area|RETURNVALUE= | ||
|s3=positions '''inAreaArray''' location |= | |s3=positions '''inAreaArray''' location |SYNTAX= | ||
|p41= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= | |p41= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|PARAMETER1= | ||
|p42= location: [[Location]] - location with given area |= | |p42= location: [[Location]] - location with given area |PARAMETER2= | ||
|r3= [[Array]]: [[Object]]s and/or [[Position]]s inside the location area|= | |r3= [[Array]]: [[Object]]s and/or [[Position]]s inside the location area|RETURNVALUE= | ||
|s4= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c]|= | |s4= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c]|SYNTAX= | ||
|p61= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= | |p61= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|PARAMETER1= | ||
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= | |p62= [center, a, b, angle, isRectangle, c]: [[Array]]|PARAMETER2= | ||
|p63= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]] |= | |p63= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]] |PARAMETER2= | ||
|p64= a: [[Number]] - x axis (x / 2) |= | |p64= a: [[Number]] - x axis (x / 2) |PARAMETER2= | ||
|p65= b: [[Number]] - y axis (y / 2) |= | |p65= b: [[Number]] - y axis (y / 2) |PARAMETER2= | ||
|p66= angle (Optional): [[Number]] - rotation angle. Default: 0 |= | |p66= angle (Optional): [[Number]] - rotation angle. Default: 0 |PARAMETER2= | ||
|p67= isRectangle (Optional): [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse. Default: [[false]]|= | |p67= isRectangle (Optional): [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse. Default: [[false]]|PARAMETER2= | ||
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited)|= | |p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited)|PARAMETER2= | ||
|r4= [[Array]]: [[Object]]s and/or [[Position]]s inside the area |= | |r4= [[Array]]: [[Object]]s and/or [[Position]]s inside the area |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[[vehicles]] [[inAreaArray]] trigger_1;</code> |= | |x1= <code>[[vehicles]] [[inAreaArray]] trigger_1;</code> |EXAMPLE1= | ||
|x2= <code>[[allUnits]] [[inAreaArray]] marker_1;</code> |= | |x2= <code>[[allUnits]] [[inAreaArray]] marker_1;</code> |EXAMPLE2= | ||
|x3= <code>[[allPlayers]] [[inAreaArray]] location_1;</code> |= | |x3= <code>[[allPlayers]] [[inAreaArray]] location_1;</code> |EXAMPLE3= | ||
|x4= <code>[[allDead]] [[inAreaArray]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>|= | |x4= <code>[[allDead]] [[inAreaArray]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>|= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 60: | Line 60: | ||
|mp= - |= Multiplayer Behaviour | |mp= - |= Multiplayer Behaviour | ||
| [[inArea]], [[triggerArea]] |= | | [[inArea]], [[triggerArea]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:41, 7 April 2019
Description
- Description:
- Filters given list of Objects and/or Positions in relation to the given area, defined by a trigger, marker, location or array. Returns array of Objects and/or Positions from the list that are inside the area
- Multiplayer:
- -
- Groups:
- Uncategorised
Syntax 1
- Syntax:
- positions inAreaArray trigger
- Parameters:
- positions: Array - Objects and/or Positions to check
- trigger: Object - trigger with given area
- Return Value:
- Array: Objects and/or Positions inside the trigger area
Syntax 2
- Syntax:
- positions inAreaArray marker
- Parameters:
- positions: Array - Objects and/or Positions to check
- marker: String - marker with given area
- Return Value:
- Array: Objects and/or Positions inside the marker area
Syntax 3
- Syntax:
- positions inAreaArray location
- Parameters:
- positions: Array - Objects and/or Positions to check
- location: Location - location with given area
- Return Value:
- Array: Objects and/or Positions inside the location area
Syntax 4
- Syntax:
- positions inAreaArray [center, a, b, angle, isRectangle, c]
- Parameters:
- positions: Array - Objects and/or Positions to check
- [center, a, b, angle, isRectangle, c]: Array
- center: Array - center of the area in format Position3D, Position2D
- a: Number - x axis (x / 2)
- b: Number - y axis (y / 2)
- angle (Optional): Number - rotation angle. Default: 0
- isRectangle (Optional): Boolean - true if rectangle, false if ellipse. Default: false
- c (Optional): Number - z axis (z / 2). Default: -1 (unlimited)
- Return Value:
- Array: Objects and/or Positions inside the area
Examples
- Example 1:
vehicles inAreaArray trigger_1;- Example 2:
allUnits inAreaArray marker_1;- Example 3:
allPlayers inAreaArray location_1;- 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 inAreaArray "mymarker" select {_x isKindOf "StaticWeapon"}Will return only the statics inside the given marker