nearestObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Undo revision 123909 by killzone_kid (talk))
Tag: Undo
(42 intermediate revisions by 15 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|NEARESTOBJECT]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|NEARESTOBJECT]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|NEARESTOBJECT]]
 
[[Category:Scripting Commands ArmA|NEARESTOBJECT]]
| ofp |= Game name
 
|1.00|= Game version
____________________________________________________________________________________________
 
| 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=
 
|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]])|=
 
| [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE=


____________________________________________________________________________________________


<h2 style="color:#000066">'''nearestObject ''pos'''''</h2>
|s2= '''nearestObject''' position |SYNTAX=
<h2 style="color:#000066">'''''type'' nearestObject ''pos'''''</h2>
<h2 style="color:#000066">'''''id'' nearestObject ''pos'''''</h2>


|p21= position:  [[Position3D]] or [[Position2D]] - position to start search at|=


'''Operand types:'''
|r2= [[Object]] - Nearest object, [[objNull]] otherwise |RETURNVALUE=
____________________________________________________________________________________________


'''pos:''' [[Array]]
|s3= position '''nearestObject''' type |=


'''type:''' [[String]]
|p41= position: [[Position3D]] or [[Position2D]] - position to start search at|=
|p42= type: [[String]] - type of object (see [[typeOf]], [[CfgVehicles|class type]])|=


'''id:''' [[Number]]
|r3= [[Object]] - Nearest object, [[objNull]] otherwise |=


'''Type of returned value:'''
____________________________________________________________________________________________


[[Object]]
|s4= position '''nearestObject''' id |=


'''Compatibility:'''
|p61= position: [[Position3D]] or [[Position2D]] - position to start search at|=
|p62= id: [[Number]] - object Visitor id|=


Binary variants added in '''Armed Assault'''
|r4= [[Object]] - Nearest object, [[objNull]] otherwise |=
____________________________________________________________________________________________


'''Description:'''
 
|x1= <code>_nObject = [[nearestObject]] [2345,6789];
_nObject = [[nearestObject]] <nowiki>[</nowiki>[[player]], "StreetLamp"];
</code>  |EXAMPLE1=
|x2= Return the object with ID 123456:<code>_nObject = [0,0,0] [[nearestObject]] 123456; </code> |EXAMPLE2=
|x3= <code>_nObject = [[getPos]] [[player]] [[nearestObject]] "StreetLamp"; </code> |EXAMPLE3=
|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>
|EXAMPLE4=
|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> |EXAMPLE5=
____________________________________________________________________________________________


Nearest object of given type to given '''position''' or '''object'''.
|  [[nearestObjects]], [[nearObjectsReady]], [[nearObjects]], [[objectFromNetId]], [[nearEntities]], [[entities]], [[object]], [[nearestBuilding]], [[nearestTerrainObjects]] |SEEALSO=


For '''nearestObject ''pos''''', '''pos''' may be '''''[x, y ,z, "type"]''''' or '''''[object, "type"]''''' or even '''''[x, y, z]'''''.
}}


For '''''type'' nearestObject ''pos''''' or '''''id'' nearestObject ''pos''''', '''pos''' may be '''''[x, y ,z]'''''.
<h3 style="display:none">Notes</h3>


<dl class="command_description">
<!-- Note Section BEGIN -->


'''Example:'''
<!-- Note Section END -->
</dl>


_nObject = '''nearestObject''' [ [[player]], "StreetLamp"]
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|NEARESTOBJECT]]
[[Category:Scripting Commands OFP 1.46|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}}}}]]


'''Comments'''
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on January 29, 2019 - 15:31 (UTC)</dd>
<dt class="note">[[User:Gnashes|Gnashes]]</dt>
<dd class="note">
The ID for Alternative Syntax 3 may be dynamically obtained via the following (as of Arma 3 v1.88):


This command can only find objects up to 50 meters away.
<code>//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
};</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 11:45, 5 May 2019

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 - 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 };
Retrieved from "https://community.bistudio.com/wiki?title=nearestObject&oldid=123911"