setCompassOscillation

Description

This command sets random heading on the player's compass (both in map and in 3D view) with given frequency, which is also randomised.

Syntax

setCompassOscillation [angle, frequencyMin, frequencyMax]

Parameters:

• angle: Number - heading deviation angle in radians; the random angle will be picked up from [-angle...+angle] range
• frequencyMin: Number - lower bound of heading change in seconds
• frequencyMax: Number - higher bound of heading change in seconds

Returns: Nothing

Examples

Example 1

Set compass to oscillate every second within -90/+90 degrees:

setCompassOscillation [rad 90, 1, 1];

Example 2

Change heading every 60 to 90 seconds:

setCompassOscillation [rad 180, 60, 90];

Example 3

Make compass go crazy:

setCompassOscillation [rad 360, 0.1, 0.2];

Example 4

Reset to default behaviour:

setCompassOscillation [-1, 0, 0];

See also

visibleCompass · shownCompass · shownCuratorCompass · showCompass · showCuratorCompass · setCompassDeclination