nearestObject: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <dd class="notedate">" to " <dt><dt> <dd class="notedate">") |
Lou Montana (talk | contribs) m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "") |
||
Line 77: | Line 77: | ||
{{GameCategory|tkoh|Scripting Commands}} | {{GameCategory|tkoh|Scripting Commands}} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<dt></dt> | <dt></dt> | ||
Line 110: | Line 109: | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Revision as of 00:53, 6 April 2021
Description
- Description:
- Description needed
- Groups:
- Object Detection
Syntax 1
- Syntax:
- Syntax needed
- 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:
- Return value needed
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
- 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 };
- Posted on February 12, 2020 - 08:55 (UTC)
- blackfisch
-
Note, that if you want to check for the nearest Unit you have to check for
CAManBase
instead ofMan
, sinceMan
will also return any wildlife population in that Area:nearestObject [player, "Man"]; // could possibly return rabbits or other wildlife nearestObject [player, "CAManBase"]; // only returns units