BIS fnc findSafePos: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=") |
Lou Montana (talk | contribs) m (Text replacement - "</dd> </dl>" to "</dd> </dl>") |
||
Line 79: | Line 79: | ||
To make sure position is not inside a building, increase distance to nearest object param. | To make sure position is not inside a building, increase distance to nearest object param. | ||
</dd> | </dd> | ||
</dl> | </dl> |
Revision as of 16:05, 13 June 2021
Description
- Description:
- Description needed
- Execution:
- call
- Groups:
- Positions
Syntax
- Syntax:
- [center, minDist, maxDist, objDist, waterMode, maxGrad, shoreMode, blacklistPos, defaultPos] call BIS_fnc_findSafePos
- Parameters:
- center (Optional): center position. Could be one of:
- Array - Position2D or Position3D - position
- Object - object which position will be used
- Nothing - when passing empty array [] or nothing, the world's "safePositionAnchor" entry will be used. (Default: []).
- minDist (Optional): Number - minimum distance from the center position. (Default: 0).
- maxDist (Optional): Number - maximum distance from the center position. If -1, the world's "safePositionRadius" entry will be used. (Default: -1).
- objDist (Optional): Number - minimum distance from the resulting position to the center of nearest object. Specifying quite large distance here will slow the function and might often fail to find suitable position. Recommended value: 0 - 10. (Default: 0).
- waterMode (Optional): Number - water mode (Default: 0). Could be one of:
- 0 - cannot be in water
- 1 - can either be in water or not
- 2 - must be in water
- maxGrad (Optional): Number - maximum terrain gradient (hill steepness). A quite small non-zero value could result in failure to find suitable position. Recommended: 0.1+ (Default: 0).
- shoreMode (Optional): Number - shore mode (Default: 0). Could be one of:
- 0 - does not have to be at a shore
- 1 - must be at a shore
- blacklistPos (Optional): Array - List of blacklisted areas in format [area1, area2, area3... areaN] (Default: []). Area could be one of:
- defaultPos (Optional): Array - default position when no position is found (Default: []). Array format is [landPosition, seaPosition], where:
- Return Value:
- Array - in format [x,y] on success. When position cannot be found at all, default map center position is returned, which will be in format [x,y,0]
Examples
- Example 1:
- Find position minimum 1m from from player but not further than 150m, not closer than 3m to any other object, not in the water, maximum gradient of 20, not on the shoreline:
_pos = [player, 1, 150, 3, 0, 20, 0] call BIS_fnc_findSafePos;
- Example 2:
_pos = [getPos player, 2000, 5000, 1, 0, 0.7, 0, [], [getPos player, getPos player]] call BIS_fnc_findSafePos;
- Example 3:
_pos = [[], 0, 1000] call BIS_fnc_findSafePos;
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
- Posted on March 15, 2017 - 19:30 (UTC)
- Killzone Kid
- To make sure position is not inside a building, increase distance to nearest object param.