Compass

const Compass: object

Defined in: client/api.d.ts:1879

The compass strip along the top of the HUD, which is what this game has instead of a minimap. Marks go on it through Blip; this is the strip itself.

Type Declaration

markCount

readonly markCount: number

How many marks the compass carried at the last tick, the game’s own included. Sampled rather than read live: the vector it comes from is reallocated by the thread that adds to it.

visible

visible: boolean

Whether the compass is showing. Assignment pushes the game’s own suppression, the one a cutscene uses, so it takes the whole strip rather than emptying it. It reads the mod’s own view – a suppression the game pushed is invisible here – and the mod’s is released when the session ends.