VN_ms_fnc_tracker_getSpiralPositions

From Savage Game Design Wiki
Jump to navigation Jump to search
← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Wyqer, veteran29
Argument(s): n/a
Effect(s): unknown

Description

Get positions in spiral with given radius. Useful for patrols.

params [

   ["_center", getPos player, [[], objNull], 3],
   ["_radius", 500, [0]],
   ["_steps", 8, [0]],
   ["_precision", [0.3, 0.8, 1], [[]], 3],
   ["_clockwise", selectRandom [true, false], [false]]

];

Syntax

Syntax
[centre, radius, steps, precision, clockwise] call VN_ms_fnc_tracker_getSpiralPositions
Parameters
centre: Object or Position - (Optional, default getPos player) spiral centre
radius: Number - (Optional, default 500) spiral radius
steps: Number - (Optional, default 8) steps per spiral (360° ÷ steps)
precision: Array - (Optional, default [0.3, 0.8, 1]) radius precision, 3-elements number array
clockwise: Boolean - (Optional, default selectRandom [true, false]) spiral direction, true for clockwise, false for counter-clockwise
Return value
Array - positions

Examples

Example 1
private _spiralPositions = [nil, 100, 36, [0,0.25, 0.5], true] call VN_ms_fnc_tracker_getSpiralPositions;