nearestObjects: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(expanded) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns a list of nearest objects of the given types to the given position or object, within the specified distance. Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit]. |= Description | | Returns a list of nearest objects of the given types to the given position or object, within the specified distance. Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit]. | ||
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). | |||
|= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''nearestObjects''' | | '''nearestObjects''' [unit, class, range] |= Syntax | ||
|p1= | |p1= unit: [[Object]] from which is searched |= Parameter 1 | ||
|p2= class: [[Array]] of [[String]]s (which class of objects to search for)|= Parameter 2 | |||
|p3= range: [[Number]] (distance to search)|= Parameter 3 | |||
| [[Array]] |= Return value | | [[Array]] |= Return value | ||
Revision as of 09:49, 16 December 2006
Description
- Description:
- Returns a list of nearest objects of the given types to the given position or object, within the specified distance. Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit]. 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:
- nearestObjects [unit, class, range]
- Parameters:
- unit: Object from which is searched
- class: Array of Strings (which class of objects to search for)
- range: Number (distance to search)
- Return Value:
- Array
Examples
- Example 1:
nearestObjects [player, ["Car","Tank"], 200]- Example 2:
nearestObjects [player, ["house"], 200]
Additional Information
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