nearObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Fixed (and slightly clarified) notes)
 
(100 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|NEAROBJECTS]]
{{RV|type=command
[[Category:Scripting Commands ArmA|NEAROBJECTS]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]


{{Command|= Comments
|game1= arma1
____________________________________________________________________________________________
|version1= 1.00


| arma |= Game name
|game2= arma2
|version2= 1.00


|1.00|= Game version
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Find objects in the circle with given radius.<br>
|game4= tkoh
If typeName is given, only objects of given type (or its subtype) are listed.<br>
|version4= 1.00
The returned object is ''not'' necessarily the closest one. |= Description
____________________________________________________________________________________________


| position '''nearObjects''' radius |= Syntax
|game5= arma3
|version5= 0.50


|p1= position: [[Object]] or [[Array]] |= Parameter 1
|gr1= Object Detection


|p2= radius: [[Number]] |= Parameter 2
|descr= Find objects (Units, Vehicles, Dead, Map 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.


| [[Array]] |= Return value
|s1= position [[nearObjects]] radius


____________________________________________________________________________________________
|p1= position: [[Position]], [[Position#Introduction|Position2D]] or [[Object]]


|s2= position '''nearObjects''' [typeName, radius] |= Syntax
|p2= radius: [[Number]]


|p21= position: [[Object]] or [[Array]] |= Parameter 1
|r1= [[Array]]


|p22= [typeName, radius]: [[Array]] |= Parameter 2
|s2= position [[nearObjects]] [typeName, radius]


|r2= [[Array]] |= Return value
|p21= position: [[Array]] format [[Position#PositionAGL|PositionAGL]], [[Position#Introduction|Position2D]] or [[Object]]
____________________________________________________________________________________________
 
|x1= <code>_list <nowiki>=</nowiki> [[position]] [[player]] '''nearObjects''' 50</code> |= Example 1


|x2= <code>_list<nowiki>=</nowiki> [_xpos,_ypos] '''nearObjects''' ["House",20]</code> |= Example 2
|p22= typeName: [[String]]
____________________________________________________________________________________________


| [[nearestObject]], [[nearestObjects]], [[nearestObject type]], [[nearestObject id]] |= See also
|p23= radius: [[Number]]


|r2= [[Array]]


|x1= <sqf>_list = position player nearObjects 50;</sqf>


|x2= <sqf>_list = [_xpos,_ypos] nearObjects ["House", 20];</sqf>
|x3= <sqf>_list = player nearObjects 20;</sqf>
|seealso= [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearestLocation]] [[nearEntities]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[nearestMines]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Kronzky
<!-- Note Section BEGIN -->
|timestamp= 20070630082100
|text= Units in vehicles are not detected via this command.
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Tankbuster
|timestamp= 20111215231700
|text= In the second syntax, 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)
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= Tankbuster
|timestamp= 20130103195900
|text= If you use the first syntax, 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.
}}
 
{{Note
|user= Cheitan
|timestamp= 20170808160800
|text= The syntax 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.
}}

Latest revision as of 20:27, 8 September 2022

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Find objects (Units, Vehicles, Dead, Map 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:
Object Detection

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: Array format PositionAGL, Position2D or Object
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:
findNearestEnemy nearestBuilding nearestObject nearestObjects nearestLocation nearEntities nearTargets nearSupplies nearestLocationWithDubbing nearObjectsReady nearRoads nearestMines

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
Kronzky - c
Posted on Jun 30, 2007 - 08:21 (UTC)
Units in vehicles are not detected via this command.
Tankbuster - c
Posted on Dec 15, 2011 - 23:17 (UTC)
In the second syntax, 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)
Tankbuster - c
Posted on Jan 03, 2013 - 19:59 (UTC)
If you use the first syntax, 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.
Cheitan - c
Posted on Aug 08, 2017 - 16:08 (UTC)
The syntax 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.
Retrieved from "https://community.bistudio.com/wiki?title=nearObjects&oldid=330405"