BIS_fnc_findSafePos

Description

This function generates position on a map according to several given parameters (see diagram).

The position pos will be generated inside an area which resides between minDist and maxDist from the given center. If objDist is also specified, the position will be selected objDist away from nearest terrain object. If maxGrad > 0 then the position will be also checked for how flat the area around is within objDist radius. The function can additionally be instructed to generate position specifically on water or land (waterMode) or on a shoreline (shoreMode). The shoreLine param will be ignored if position is not requested specifically on land.

Additionally, generated position could be checked against the list of blacklisted positions blacklistPos. If search for suitable position failed, defaultPos position will be used. The format for defaultPos is array with 2 positions: [posOnLand, posOnWater].

Syntax

[center, minDist, maxDist, objDist, waterMode, maxGrad, shoreMode, blacklistPos, defaultPos] call BIS_fnc_findSafePos

Parameters:

• center: Array, Object or Nothing - (Optional, default []) center position. Can be one of:

  • Array - position in format Position2D or Position3D
  • Object - object which position will be used
  • Nothing - when passing empty array [] or nothing, the world's "safePositionAnchor" entry will be used

• minDist: Number - (Optional, default 0) minimum distance from the center position

• maxDist: Number - (Optional, default -1) maximum distance from the center position. If -1, the world's "safePositionRadius" entry will be used

• objDist: Number - (Optional, default 0) 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

• waterMode: Number - (Optional, default 0) water mode. Can be one of:

  • 0 - cannot be in water
  • 1 - can either be in water or not
  • 2 - must be in water

• maxGrad: Number - (Optional, default 0) maximum terrain gradient (hill steepness). A quite small non-zero value could result in failure to find suitable position. Recommended: 0.1+

• shoreMode: Number - (Optional, default 0) shore mode. Can be one of:

  • 0 - does not have to be at a shore
  • 1 - must be at a shore

• blacklistPos: Array - (Optional, default []) list of blacklisted areas in format [area1, area2, area3... areaN]. Can be one of:

  • Array - in format [topLeftCorner, bottomRightCorner] - top and bottom coordinates of blacklisted area
  • Object - trigger area
  • String - marker area
  • Location - location
  • Array - array in format [center, distance] or [center, a, b, angle, rect] or [center, a, b, angle, rect, height]

• defaultPos: Array - (Optional, default []) default position when no position is found. Array format is [landPosition, seaPosition], where:

  • landPosition: Array - in format [x,y] or [x,y,z] - default position on land
  • seaPosition: Array - in format [x,y] or [x,y,z] - default position on water

Returns: 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:

private _pos = [player, 1, 150, 3, 0, 20, 0] call BIS_fnc_findSafePos;

Example 2

private _pos = [getPos player, 2000, 5000, 1, 0, 0.7, 0, [], [getPos player, getPos player]] call BIS_fnc_findSafePos;

Example 3

private _pos = [[], 0, 1000] call BIS_fnc_findSafePos;

See also

BIS_fnc_randomPosTrigger · BIS_fnc_randomPos