nearestObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 9: Line 9:
| Returns a list of nearest objects of the given types to the given position or object, within the specified distance.
| Returns a list of nearest objects of the given types to the given position or object, within the specified distance.


Pos may be using the format:
Pos can use the format:


<nowiki>[[</nowiki>x,y,z], ["type",...], limit]
<nowiki>[[</nowiki>x,y,z], ["ClassName",...], radius]


or
or


[object, ["type",...], limit].
[object, ["ClassName",...], radius].
 
A list of ClassName types (Tanks eg) can be found in [[CfgVehicles]]


If more than one object is found they will be ordered according to their distance (i.e. the closest one will be first in the array).
If more than one object is found they will be ordered according to their distance (i.e. the closest one will be first in the array).
Line 21: Line 23:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''nearestObjects''' pos |= Syntax
|  
 
*[[Array]] <nowiki>=</nowiki> '''nearestObjects''' [ [[Position]], ["ClassName",...], radius].
|p1= pos: [[Array]]
*[[Array]] <nowiki>=</nowiki> '''nearestObjects''' [ [[Object]],  ["ClassName",...], radius].


Can be a simple array or an array of arrays.
Source array can be a simple array or an array of arrays.


First element can be either an object or an array of type [[Position]].
|p1= '''Classname''': [[String]]  


Second element is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames or an empty array to return all the objects within its radius.
This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames or an empty array to return all the objects within its radius.|=Parameter 1


Third element is the range within which the object is searched for. |= Parameter 1
|p2= '''radius''': [[Number]] Max radius in meters within which the object is searched for. |= Parameter 1


| [[Array]] |= Return value
| [[Array]] |= Return value

Revision as of 10:37, 28 August 2007

-wrong parameter ("Arma") defined!-1.00
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. Pos can use the format: [[x,y,z], ["ClassName",...], radius] or [object, ["ClassName",...], radius]. A list of ClassName types (Tanks eg) can be found in CfgVehicles If more than one object is found they will be ordered according to their distance (i.e. the closest one will be first in the array).
Groups:
Uncategorised

Syntax

Syntax:
  • Array = nearestObjects [ Position, ["ClassName",...], radius].
  • Array = nearestObjects [ Object, ["ClassName",...], radius].
Source array can be a simple array or an array of arrays.
Parameters:
Classname: String This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames or an empty array to return all the objects within its radius.
radius: Number Max radius in meters within which the object is searched for.
Return Value:
Array

Examples

Example 1:
nearestObjects [player, ["Car","Tank"], 200]
Example 2:
nearestObjects [player, ["house"], 200]
Example 3:
nearestObjects [[2716,2949,0], ["Car","Truck"], 100]

Additional Information

See also:
nearestObjectnearestObject typenearObjectsnearestObject id

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=nearestObjects&oldid=36926"