nearestObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 7: Line 6:


|gr1= Object Detection |GROUP1=
|gr1= Object Detection |GROUP1=
____________________________________________________________________________________________


| Returns the nearest object of given type (or inherited classes) to given position within a sphere. Hardcoded radius is 50 meters. Unlike with [[nearestObjects]], where distance is measured in 2D space, [[nearestObject]] will be closest object in 3D space.
| Returns the nearest object of given type (or inherited classes) to given position within a sphere. Hardcoded radius is 50 meters. Unlike with [[nearestObjects]], where distance is measured in 2D space, [[nearestObject]] will be closest object in 3D space.
Line 14: Line 12:
* in OFP, only objects of the exact provided class are found.
* in OFP, only objects of the exact provided class are found.
* if an object ID is used (Alternative Syntax 3, see '''Example 2''') the search range is unlimited}} |DESCRIPTION=
* if an object ID is used (Alternative Syntax 3, see '''Example 2''') the search range is unlimited}} |DESCRIPTION=
____________________________________________________________________________________________


| [[nearestObject]] [position, type] |SYNTAX=
| [[nearestObject]] [position, type] |SYNTAX=
Line 24: Line 21:


| [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE=
| [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE=
____________________________________________________________________________________________


|s2= [[nearestObject]] position |SYNTAX2=
|s2= [[nearestObject]] position |SYNTAX2=
Line 31: Line 27:


|r2= [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE2=
|r2= [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE2=
____________________________________________________________________________________________


|s3= position [[nearestObject]] type |SYNTAX3=  
|s3= position [[nearestObject]] type |SYNTAX3=  
Line 40: Line 35:


|r3= [[Object]] - nearest object, [[objNull]] otherwise |RETURNVALUE3=
|r3= [[Object]] - nearest object, [[objNull]] otherwise |RETURNVALUE3=
____________________________________________________________________________________________


|s4= position [[nearestObject]] id |SYNTAX4=
|s4= position [[nearestObject]] id |SYNTAX4=
Line 49: Line 43:


|r4= [[Object]] - nearest object, [[objNull]] otherwise |RETURNVALUE4=
|r4= [[Object]] - nearest object, [[objNull]] otherwise |RETURNVALUE4=
____________________________________________________________________________________________


   
   
Line 71: Line 64:
_track  = [[nearestObject]] [<nowiki/>[[player]], "#track"];
_track  = [[nearestObject]] [<nowiki/>[[player]], "#track"];
_crater = [[nearestObject]] [<nowiki/>[[player]], "#crater"];</code> |EXAMPLE5=
_crater = [[nearestObject]] [<nowiki/>[[player]], "#crater"];</code> |EXAMPLE5=
____________________________________________________________________________________________


| [[nearestObjects]], [[nearObjectsReady]], [[nearObjects]], [[objectFromNetId]], [[nearEntities]], [[entities]], [[object]], [[nearestBuilding]], [[nearestTerrainObjects]] |SEEALSO=
| [[nearestObjects]], [[nearObjectsReady]], [[nearObjects]], [[objectFromNetId]], [[nearEntities]], [[entities]], [[object]], [[nearestBuilding]], [[nearestTerrainObjects]] |SEEALSO=

Revision as of 01:57, 17 January 2021

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Returns the nearest object of given type (or inherited classes) to given position within a sphere. Hardcoded radius is 50 meters. Unlike with nearestObjects, where distance is measured in 2D space, nearestObject will be closest object in 3D space.
ⓘ
  • in OFP, only objects of the exact provided class are found.
  • if an object ID is used (Alternative Syntax 3, see Example 2) the search range is unlimited
Groups:
Object Detection

Syntax 1

Syntax:
nearestObject [position, type]
Parameters:
[position, type]: Array
position: Position3D or Position2D or Object - position to start search at
type: String - type of object (see typeOf, class type)
Return Value:
Object - Nearest object, objNull otherwise

Syntax 2

Syntax:
nearestObject position
Parameters:
position: Position3D or Position2D - position to start search at
Return Value:
Object - Nearest object, objNull otherwise

Syntax 3

Syntax:
position nearestObject type
Parameters:
position: Position3D or Position2D - position to start search at
type: String - type of object (see typeOf, class type)
Return Value:
Object - nearest object, objNull otherwise

Syntax 4

Syntax:
position nearestObject id
Parameters:
position: Position3D or Position2D - position to start search at
id: Number - object Visitor id
Return Value:
Object - nearest object, objNull otherwise

Examples

Example 1:
_nObject = nearestObject [2345, 6789]; _nObject = nearestObject [player, "StreetLamp"];
Example 2:
Return the object with ID 123456: _nObject = [0,0,0] nearestObject 123456;
Example 3:
_nObject = getPos player nearestObject "StreetLamp";
Example 4:
Return the nearest object with (typeOf _nObject == "#XXXX") -> #mark, #slop, etc. Unlimited search range: _nObject = _position nearestObject -1; Return the nearest object with (typeOf _nObject != ""). Search range is 50m: _nObject = nearestObject _position;
Example 5:
(See also allMissionObjects): _blood = nearestObject [player, "#slop"]; _step = nearestObject [player, "#mark"]; _track = nearestObject [player, "#track"]; _crater = nearestObject [player, "#crater"];

Additional Information

See also:
nearestObjectsnearObjectsReadynearObjectsobjectFromNetIdnearEntitiesentitiesobjectnearestBuildingnearestTerrainObjects

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

Bottom Section

Posted on January 29, 2019 - 15:31 (UTC)
Gnashes
The ID for Alternative Syntax 3 may be dynamically obtained via the following (as of Arma 3 v1.88): // returns Object Terrain/Visitor ID, or -1 if no ID found (invalid/null object) cursorObject call { private _obj = str (param [0, objNull]); private _id = -1; private _find = ((_obj find "#") + 2); if (_find > 1) then { private _len = ((_obj find ":") - _find); _id = _obj select [_find, _len]; parseNumber _id; }; _id };
Posted on February 12, 2020 - 08:55 (UTC)
blackfisch
Note, that if you want to check for the nearest Unit you have to check for CAManBase instead of Man, since Man will also return any wildlife population in that Area: nearestObject [player, "Man"]; // could possibly return rabbits or other wildlife nearestObject [player, "CAManBase"]; // only returns units
Retrieved from "https://community.bistudio.com/wiki?title=nearestObject&oldid=197806"