nearObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|PARAMETER2= |p23=" to "|PARAMETER22= |p23=")
m (Text replacement - "|SYNTAX= |p21=" to "|SYNTAX2= |p21=")
Line 20: Line 20:
| [[Array]]  |RETURNVALUE=
| [[Array]]  |RETURNVALUE=


|s2= position '''nearObjects''' [typeName, radius]  |SYNTAX=
|s2= position '''nearObjects''' [typeName, radius]  |SYNTAX2=
 
|p21= position: [[PositionAGL]], [[Position2D]] or [[Object]]  |PARAMETER1=
|p21= position: [[PositionAGL]], [[Position2D]] or [[Object]]  |PARAMETER1=
|p22= [typeName, radius]: [[Array]] |PARAMETER22=
|p22= [typeName, radius]: [[Array]] |PARAMETER22=

Revision as of 02:31, 3 September 2019


-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Find objects in a sphere with given radius. The first object in the returned array is not necessarily the closest one. If you need returned objects to be sorted by distance, use nearestObjects. If typeName is given, only objects of given type (or its subtype) are listed.
Groups:
Uncategorised

Syntax

Syntax:
position nearObjects radius
Parameters:
position: Position, Position2D or Object
radius: Number
Return Value:
Array

Alternative Syntax

Syntax:
position nearObjects [typeName, radius]
Parameters:
position: PositionAGL, Position2D or Object
[typeName, radius]: Array
typeName: String
radius: Number
Return Value:
Array

Examples

Example 1:
_list = position player nearObjects 50;
Example 2:
_list = [_xpos,_ypos] nearObjects ["House", 20];
Example 3:
_list = player nearObjects 20;

Additional Information

See also:
findNearestEnemynearestBuildingnearestObjectnearestObjectsnearestLocationnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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

Notes

Posted on June 30, 2007 - 08:21
Kronzky
Units in vehicles are not detected via this command.
Posted on December 15, 2011 - 23:17
Tankbuster
In the second example, you can't omit the typeName parameter. It's required and you'll get an error if you don't supply it. Use "All" as an alternative to leaving it out. (CO 1.59)
Posted on January 3, 2013 - 19:59
Tankbuster
If you use the first example, it will return objects many more objects such as pollen, honeybees and crucially, triggers. Triggers will show in the returned array as "no shape" but you can use typeOf to get the classname, which will give "EmptyDetector". This will not return objects that don't have classnames such as plants, stones and some map objects like vehicle wrecks. nearestObjects will find objects without classnames.

Bottom Section

Posted on August 8, 2017 - 16:08 (UTC)
Cheitan
The example 2 means that the command will include all types which inherit from the given type. As an example, when using "Helipad_Base_F", the command will detect all types of helipads (Land_HelipadSquare_F, Land_HelipadCircle_F, Land_HelipadEmpty_F, etc) in the given radius.