nearestObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "<tt>([a-zA-Z0-9\. _"']+)<\/tt>" to "{{hl|$1}}")
(9 intermediate revisions by the same user not shown)
Line 20: Line 20:
|descr= Returns a list of nearest objects of the given types to the given position or object, within the specified distance. If more than one object is found they will be ordered by proximity, the closest one will be first in the array. Alternatively, you can use [[nearObjects]] command, which doesn't sort results.
|descr= Returns a list of nearest objects of the given types to the given position or object, within the specified distance. If more than one object is found they will be ordered by proximity, the closest one will be first in the array. Alternatively, you can use [[nearObjects]] command, which doesn't sort results.
<br><br>
<br><br>
A list of ClassName types (e.g <tt>Tank</tt>) can be found in [[:Category:CfgVehicles|CfgVehicles]].
A list of ClassName types (e.g {{hl|Tank}}) can be found in [[:Category:CfgVehicles|CfgVehicles]].
{{Feature | important | This command matches objects using [[isKindOf]] comparison instead of direct class name [[==]] comparison. As a result, if a class type is a parent, the search will return all objects that inherit from the parent as well as parent itself. This command also only finds objects that are '''[[entities]]'''. If you are looking for non-entity objects, see [[nearObjects]], [[nearestObject]].}}
{{Feature | important | This command matches objects using [[isKindOf]] comparison instead of direct class name [[==]] comparison. As a result, if a class type is a parent, the search will return all objects that inherit from the parent as well as parent itself. This command also only finds objects that are '''[[entities]]'''. If you are looking for non-entity objects, see [[nearObjects]], [[nearestObject]].}}


Line 31: Line 31:
|p3= radius: [[Number]] - Range from center position to search for objects.
|p3= radius: [[Number]] - Range from center position to search for objects.


|p5= 2Dmode (Optional, default [[false]]): [[Boolean]] - [[true|True]] for 2D distance, [[false]] for 3D distance {{Since|arma3|1.66|y}}
|p5= 2Dmode: [[Boolean]] - (Optional, default [[false]]) [[true]] for 2D distance, [[false]] for 3D distance
|p5since= arma3 1.66


|r1= [[Array]] - Array of objects
|r1= [[Array]] - array of objects


|x1= <code>[[nearestObjects]] [<nowiki/>[[player]], ["Car", "Tank"], 200];</code>
|x1= <code>[[nearestObjects]] [<nowiki/>[[player]], ["Car", "Tank"], 200];</code>
Line 41: Line 42:
|x3= <code>[[nearestObjects]] [<nowiki/>[2716,2949,0], ["Car", "Truck"], 100];</code>
|x3= <code>[[nearestObjects]] [<nowiki/>[2716,2949,0], ["Car", "Truck"], 100];</code>


|x4= Return every object in 50 metres radius around player:<code>[[nearestObjects]] [<nowiki/>[[player]], [], 50]</code>
|x4= Return every object in 50 metres radius around player:<code>[[nearestObjects]] [<nowiki/>[[player]], [], 50];</code>


|seealso= [[nearestTerrainObjects]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearObjects]], [[nearestLocation]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
|seealso= [[nearestTerrainObjects]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearObjects]], [[nearestLocation]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
}}
}}


<dl class="command_description">
{{Note
<dt><dt>
|user= PhilippRauch
<dd class="notedate">Posted on unknown</dd>
|timestamp= 20100403162100
<dt class="note">[[User:Vigilante|Vigilante]]</dt>
|text= To get a list with alive targets for various situations use this construct:
<dd class="note">
<code>_nearestTargets = [[nearestObjects]] [_submunScanPos, ["VBS2_TANK", "TANK"], _scanArea];
To get a list with alive targets for various situations use this construct:
<code>_nearestTargets = [[nearestObjects]] [_submunScanPos, ["VBS2_TANK","TANK"], _scanArea];
_validNearestTargets = [];
_validNearestTargets = [];
{ [[if]] ([[alive]] _x ) [[then]] { _validNearestTargets [[set]] [([[count]] _validNearestTargets), _x]; }; } [[forEach]] _nearestTargets;</code>
{ [[if]] ([[alive]] _x ) [[then]] { _validNearestTargets [[set]] [([[count]] _validNearestTargets), _x]; }; } [[forEach]] _nearestTargets;</code>
results in _validNearestTargets being filled with targets == alive .. (you could use other conditions there, of course!)
results in _validNearestTargets being filled with targets == alive .. (you could use other conditions there, of course!)
<dt><dt>
}}
<dd class="notedate">Posted on 10. Aug. 2010</dd>
 
<dt class="note">[[User:Rübe|Rübe]]</dt>
{{Note
<dd class="note">Passing an empty array to define the types will also return objects with no class at all (such as trees, bushes, stones, ...).  
|user= Rübe
|timestamp= 20100810022800
|text= Passing an empty array to define the types will also return objects with no class at all (such as trees, bushes, stones, ...).  
Example:
Example:
<code>_objects = [[nearestObjects]] [_position, [], _radius];</code>
<code>_objects = [[nearestObjects]] [_position, [], _radius];</code>
Passing the array ["All"] is not the same and will only return objects that have some sort of class.
Passing the array ["All"] is not the same and will only return objects that have some sort of class.
<dt><dt>
}}
<dd class="notedate">Posted on 11.09.2013</dd>
 
<dt class="note">[[User:Katulobotomia|Katulobotomia]]</dt>
{{Note
<dd class="note">If you want to detect nearby grenades for the position of a unit, for example, using 'nearestObjects' won't work. You have to use
|user= Katulobotomia
|timestamp= 20130911145400
|text= If you want to detect nearby grenades for the position of a unit, for example, using 'nearestObjects' won't work. You have to use
'nearObjects' instead.
'nearObjects' instead.
<code>[[count]] ([[nearestObjects]] [_unit, ["GrenadeHand"], 30]) {{cc|WON'T WORK}}</code>
<code>[[count]] ([[nearestObjects]] [_unit, ["GrenadeHand"], 30]) {{cc|WON'T WORK}}</code>
Line 72: Line 75:
<code>[[count]] (_unit [[nearObjects]] ["GrenadeHand", 30]) {{cc|WORKS!}}</code>
<code>[[count]] (_unit [[nearObjects]] ["GrenadeHand", 30]) {{cc|WORKS!}}</code>
Will work.
Will work.
<dt><dt>
}}
<dd class="notedate">Posted on March 22, 2014</dd>
 
<dt class="note">[[User:AgentRev01|AgentRev]]</dt>
{{Note
<dd class="note">The distance from which an object is determined to be inside the radius is calculated from its model center (object modelToWorld [0,0,0]), and not the position returned by getPos/ATL/ASL. If an object is used as the origin from which to scan, distance is calculated from its model center as well.
|user= AgentRev
</dl>
|timestamp= 20140322023800
|text= The distance from which an object is determined to be inside the radius is calculated from its model center (object modelToWorld [0,0,0]), and not the position returned by getPos/ATL/ASL. If an object is used as the origin from which to scan, distance is calculated from its model center as well.
}}


<dl class="command_description">
{{Note
<dt></dt>
|user= Killzone Kid
<dd class="notedate">Posted on October 26, 2014 - 15:15 (UTC)</dd>
|timestamp= 20141026151500
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|text= Return all trees in 100m radius around player:
<dd class="note">
<code>[[private]] _trees {{=}} [];
Return all trees in 100m radius around player:
<code>[[private]] _trees {{=}} [];  
{
{
    [[if]] ([[str]] _x [[find]] ": t_" > -1) [[then]] {
[[if]] ([[str]] _x [[find]] ": t_" > -1) [[then]] {
        _trees [[pushBack]] _x;
_trees [[pushBack]] _x;
    };
};
} [[forEach]] [[nearestObjects]] [<nowiki/>[[player]], [], 100];</code>  
} [[forEach]] [[nearestObjects]] [<nowiki/>[[player]], [], 100];</code>  
</dd>
}}
<dt><dt>
 
<dd class="notedate">Posted on August 27, 2015 - 16:45 (UTC)</dd>
{{Note
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
|user= Tankbuster
<dd class="note">
|timestamp= 20150827164500
If you use "Man" as the class to look for, it will only find dismounted men. IE, men in vehicles will NOT be found.
|text= If you use "Man" as the class to look for, it will only find dismounted men. IE, men in vehicles will NOT be found.
</dd>
}}
<dt><dt>
 
<dd class="notedate">Posted on January 8, 2016 - 12:14 (UTC)</dd>
{{Note
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|user= Killzone Kid
<dd class="note">
|timestamp= 20160108121400
The first call to this command can take significantly longer then consecutive calls. But even after the objects in given radius were cached, the sorting this command performs could be quite expensive. For example to sort ~7000 object it might take up to 100ms. For performance reasons you can use [[nearObjects]] instead, which is basically the same command but without added sorting.
|text= The first call to this command can take significantly longer then consecutive calls. But even after the objects in given radius were cached, the sorting this command performs could be quite expensive. For example to sort ~7000 object it might take up to 100ms. For performance reasons you can use [[nearObjects]] instead, which is basically the same command but without added sorting.
</dd>
}}
<dt><dt>
 
<dd class="notedate">Posted on March 2, 2016 - 23:09 (UTC)</dd>
{{Note
<dt class="note">[[User:Ceeeb|Ceeeb]]</dt>
|user= Ceeeb
<dd class="note">
|timestamp= 20160302230900
In Arma 3, nearestObjects is partially broken and is unable to return nearby placed explosive charges or mines when searching by classnames. Use [[nearObjects]], [[nearestObject]] or [[allMines]] instead.<br>
|text= In {{arma3}}, nearestObjects is partially broken and is unable to return nearby placed explosive charges or mines when searching by classnames. Use [[nearObjects]], [[nearestObject]] or [[allMines]] instead.<br>
Example of non-functional code:
Example of non-functional code:
<code>{{cc|always returns nothing, even if there are objects that should be returned}}
<code>{{cc|always returns nothing, even if there are objects that should be returned}}
nearestObjects [position player, ["APERSMine_Range_Ammo", "SatchelCharge_Remote_Ammo"], 10]</code>
[[nearestObjects]] [<nowiki/>[[position]] [[player]], ["APERSMine_Range_Ammo", "SatchelCharge_Remote_Ammo"], 10];</code>
</dd>
}}
<dt><dt>
 
<dd class="notedate">Posted on October 31, 2016 - 00:32 (UTC)</dd>
{{Note
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|user= Killzone Kid
<dd class="note">
|timestamp= 20161031003200
Since Arma 3 v1.66 the default sorting is done according to 3D distance not [[distance2D]] as before. This is an attempt to correct some very old bug in implementation.  
|text= Since {{arma3}} v1.66 the default sorting is done according to 3D distance not [[distance2D]] as before. This is an attempt to correct some very old bug in implementation.
</dd>
}}
</dl>

Revision as of 00:45, 16 November 2021

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:
Returns a list of nearest objects of the given types to the given position or object, within the specified distance. If more than one object is found they will be ordered by proximity, the closest one will be first in the array. Alternatively, you can use nearObjects command, which doesn't sort results.

A list of ClassName types (e.g Tank) can be found in CfgVehicles.
⚠
This command matches objects using isKindOf comparison instead of direct class name == comparison. As a result, if a class type is a parent, the search will return all objects that inherit from the parent as well as parent itself. This command also only finds objects that are entities. If you are looking for non-entity objects, see nearObjects, nearestObject.
Groups:
Object Detection

Syntax

Syntax:
nearestObjects [position, types, radius, 2Dmode]
Parameters:
position: Object or Array in format PositionAGL or Position2D - Where to find objects, center position.
types: Array - List of class name of the objects to search for. Use an empty array [] to search for all classes.
radius: Number - Range from center position to search for objects.
since Arma 3 logo black.png1.66
2Dmode: Boolean - (Optional, default false) true for 2D distance, false for 3D distance
Return Value:
Array - array of objects

Examples

Example 1:
nearestObjects [player, ["Car", "Tank"], 200];
Example 2:
nearestObjects [player, ["house"], 200];
Example 3:
nearestObjects [[2716,2949,0], ["Car", "Truck"], 100];
Example 4:
Return every object in 50 metres radius around player:nearestObjects [player, [], 50];

Additional Information

See also:
nearestTerrainObjectsfindNearestEnemynearestBuildingnearestObjectnearObjectsnearestLocationnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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
PhilippRauch - c
Posted on Apr 03, 2010 - 16:21 (UTC)
To get a list with alive targets for various situations use this construct: _nearestTargets = nearestObjects [_submunScanPos, ["VBS2_TANK", "TANK"], _scanArea]; _validNearestTargets = []; { if (alive _x ) then { _validNearestTargets set [(count _validNearestTargets), _x]; }; } forEach _nearestTargets; results in _validNearestTargets being filled with targets == alive .. (you could use other conditions there, of course!)
Rübe - c
Posted on Aug 10, 2010 - 02:28 (UTC)
Passing an empty array to define the types will also return objects with no class at all (such as trees, bushes, stones, ...). Example: _objects = nearestObjects [_position, [], _radius]; Passing the array ["All"] is not the same and will only return objects that have some sort of class.
Katulobotomia - c
Posted on Sep 11, 2013 - 14:54 (UTC)
If you want to detect nearby grenades for the position of a unit, for example, using 'nearestObjects' won't work. You have to use 'nearObjects' instead. count (nearestObjects [_unit, ["GrenadeHand"], 30]) // WON'T WORK Won't ever return anything but 0. count (_unit nearObjects ["GrenadeHand", 30]) // WORKS! Will work.
AgentRev - c
Posted on Mar 22, 2014 - 02:38 (UTC)
The distance from which an object is determined to be inside the radius is calculated from its model center (object modelToWorld [0,0,0]), and not the position returned by getPos/ATL/ASL. If an object is used as the origin from which to scan, distance is calculated from its model center as well.
Killzone Kid - c
Posted on Oct 26, 2014 - 15:15 (UTC)
Return all trees in 100m radius around player: private _trees = []; { if (str _x find ": t_" > -1) then { _trees pushBack _x; }; } forEach nearestObjects [player, [], 100];
Tankbuster - c
Posted on Aug 27, 2015 - 16:45 (UTC)
If you use "Man" as the class to look for, it will only find dismounted men. IE, men in vehicles will NOT be found.
Killzone Kid - c
Posted on Jan 08, 2016 - 12:14 (UTC)
The first call to this command can take significantly longer then consecutive calls. But even after the objects in given radius were cached, the sorting this command performs could be quite expensive. For example to sort ~7000 object it might take up to 100ms. For performance reasons you can use nearObjects instead, which is basically the same command but without added sorting.
Ceeeb - c
Posted on Mar 02, 2016 - 23:09 (UTC)
In Arma 3, nearestObjects is partially broken and is unable to return nearby placed explosive charges or mines when searching by classnames. Use nearObjects, nearestObject or allMines instead.
Example of non-functional code: // always returns nothing, even if there are objects that should be returned nearestObjects [position player, ["APERSMine_Range_Ammo", "SatchelCharge_Remote_Ammo"], 10];
Killzone Kid - c
Posted on Oct 31, 2016 - 00:32 (UTC)
Since Arma 3 v1.66 the default sorting is done according to 3D distance not distance2D as before. This is an attempt to correct some very old bug in implementation.
Retrieved from "https://community.bistudio.com/wiki?title=nearestObjects&oldid=295314"