nearestObjects: Difference between revisions
Jump to navigation
Jump to search
(alternative pos definition doesn't seem to work) |
mNo edit summary |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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: | |||
<nowiki>[[</nowiki>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). | 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 13: | Line 21: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''nearestObjects''' | | '''nearestObjects''' pos |= Syntax | ||
|p1= pos: [[Array]] | |||
Can be a simple array or an array of arrays. | |||
First element can be either an object or an array of type [[Position]]. | |||
Second element is the classname of the object or objects to be searched for, this can be a single classname or an array of classnames. | |||
Third element is the range within which the object is searched for. |= Parameter 1 | |||
| [[Array]] |= Return value | | [[Array]] |= Return value | ||
| Line 24: | Line 38: | ||
|x1= <code>'''nearestObjects''' <nowiki>[</nowiki>[[player]], ["Car","Tank"], 200]</code> |= Example 1 | |x1= <code>'''nearestObjects''' <nowiki>[</nowiki>[[player]], ["Car","Tank"], 200]</code> |= Example 1 | ||
|x2= <code>'''nearestObjects''' <nowiki>[</nowiki>[[player]], ["house"], 200]</code> |= Example 2 | |x2= <code>'''nearestObjects''' <nowiki>[</nowiki>[[player]], ["house"], 200]</code> |= Example 2 | ||
|x3= <code>'''nearestObjects''' <nowiki>[</nowiki>[2716,2949,0], ["Car","Truck"], 100]</code> |= Example 2 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 14:34, 25 February 2007
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 the 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 pos
- Parameters:
- pos: Array Can be a simple array or an array of arrays. First element can be either an object or an array of type Position. Second element is the classname of the object or objects to be searched for, this can be a single classname or an array of classnames. Third element is the range 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
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