Multiple Compass Instances

advanced tasks

Compass Navigator Pro 3 · Common Tasks

Compass Navigator Pro supports up to 4 simultaneous compass instances in the same scene. Each instance can display different POIs and occupy its own screen region — ideal for split-screen multiplayer, multiple camera views or layered UI systems.

Setup

Compass Instance Configuration

ParameterDescription
Compass GroupGroup ID (1–4). POIs with matching group masks register with this instance.
Viewport RectNormalized screen coordinates (0–1) defining the screen area. For split-screen: (0,0,0.5,1) for the left half, (0.5,0,0.5,1) for the right half.

POI Group Assignment

ParameterDescription
Compass Group MaskBitmask selecting which compass groups display this POI. Default 0xF (all groups). Use 0x1 for group 1, 0x2 for group 2, 0x3 for groups 1+2, etc.

Scripting Multiple Instances

// Register a POI to compass group 1 only
poi.compassGroupMask = 0x1; // Binary: 0001
poi.RegisterPOI();

// Register a POI to compass groups 1 and 2
poi.compassGroupMask = 0x3; // Binary: 0011
poi.RegisterPOI();

// Register to all compass groups (default)
poi.compassGroupMask = 0xF; // Binary: 1111
poi.RegisterPOI();

The RegisterPOI() method on CompassProPOI automatically finds all active compass instances whose group matches the POI's mask. You can also call CompassPro.instance.POIRegister(poi) directly. To unregister, call poi.UnRegisterPOI().

Was this page helpful?