nearestObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(see also)
(30 intermediate revisions by 11 users not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Nearest object of given type to given position.
| Returns the nearest object of given type 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.<br><br>
If object class type is used, any object derived from the type is found as well (In OFP however, only objects with exactly the type given are found). If object ID passed as an argument (as in example 2) the search range is unlimited.|= Description
____________________________________________________________________________________________
 
| '''nearestObject''' [position, type] |= Syntax


For nearestObject pos, pos may be [x, y ,z, "type"] or [object, "type"] or even [x, y, z].
|p1= [position, type]: [[Array]] |=
|p2= position:  [[Position3D]] or [[Position2D]] or [[Object]] - position to start search at|=
|p3= type: [[String]] - type of object (see [[typeOf]], [[CfgVehicles|class type]])|=


Before ArmA the funcion matched only objects with exactly the type given.
| [[Object]] - Nearest object, [[objNull]] otherwise |= Return value


Since ArmA, any object derived from the type is found as well.|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''nearestObject''' pos |= Syntax
|s2= '''nearestObject''' position |= Syntax


|p1= pos: [[Array]] |= Parameter 1
|p21= position: [[Position3D]] or [[Position2D]] or [[Object]] - position to start search at|=


| [[Object]] |= Return value
|r2= [[Object]] - Nearest object, [[objNull]] otherwise |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
|s3= position '''nearestObject''' type |=
|p41= position: [[Position3D]] or [[Position2D]] - position to start search at|=
|p42= type: [[String]] - type of object (see [[typeOf]], [[CfgVehicles|class type]])|=
|r3= [[Object]] - Nearest object, [[objNull]] otherwise |=
____________________________________________________________________________________________
|s4= position '''nearestObject''' id |=
|p61= position: [[Position3D]] or [[Position2D]] - position to start search at|=
|p62= id: [[Number]] - object Visitor id|=
|r4= [[Object]] - Nearest object, [[objNull]] otherwise |=
____________________________________________________________________________________________
   
   
|x1= <code>_nObject <nowiki>=</nowiki> nearestObject <nowiki>[</nowiki>[[player]], "StreetLamp"] </code> |= Example 1
|x1= <code>_nObject = [[nearestObject]] [2345,6789];
|x2= <code>_nObject <nowiki>=</nowiki> nearestObject <nowiki>[</nowiki>[[player]], "Tank"] </code> |= Example 2 (ArmA)
_nObject = [[nearestObject]] <nowiki>[</nowiki>[[player]], "StreetLamp"];
</code> |= Example 1
|x2= Return the object with ID 123456:<code>_nObject = [0,0,0] [[nearestObject]] 123456; </code> |= Example 2
|x3= <code>_nObject = [[getPos]] [[player]] [[nearestObject]] "StreetLamp"; </code> |= Example 3
|x4= Return the nearest object with ([[typeOf]] _nObject == "#XXXX") -> #mark, #slop, etc. Unlimited search range:<code>_nObject = _position [[nearestObject]] -1; </code>
Return the nearest object with ([[typeOf]] _nObject != ""). Search range is 50m:
<code>_nObject = [[nearestObject]] _position; </code>
|= Example 4
|x5= (See also [[allMissionObjects]]): <code>_blood = [[nearestObject]] <nowiki>[</nowiki>[[player]], "#slop"];
_step = [[nearestObject]] <nowiki>[</nowiki>[[player]], "#mark"];
_track = [[nearestObject]] <nowiki>[</nowiki>[[player]], "#track"];
_crater = [[nearestObject]] <nowiki>[</nowiki>[[player]], "#crater"];</code> |= Example 5
____________________________________________________________________________________________
____________________________________________________________________________________________


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


}}
}}
Line 35: Line 69:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
This command can only find objects up to 50 meters away.
 
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
Line 42: Line 76:


[[Category:Scripting Commands|NEARESTOBJECT]]
[[Category:Scripting Commands|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.96|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.46|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.46|NEARESTOBJECT]]
[[Category:Scripting Commands ArmA|NEARESTOBJECT]]
[[Category:Scripting Commands ArmA|NEARESTOBJECT]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 20:32, 11 March 2017

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

Description

Description:
Returns the nearest object of given type 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.

If object class type is used, any object derived from the type is found as well (In OFP however, only objects with exactly the type given are found). If object ID passed as an argument (as in example 2) the search range is unlimited.
Groups:
Uncategorised

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 or Object - 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

Retrieved from "https://community.bistudio.com/wiki?title=nearestObject&oldid=99116"