skip to Main Content

Customizing Points of Interest (POI)

Select the game object with the CompassProPOI script attached and you can customize its public fields from the inspector (you can also edit them in code):

  • Id: automatically assigned number to each POI. Used internally.

  • Priority: POIs with higher priority render their icons on top of others in the compass bar and mini-map.

  • Visibility: use this property to determine when the POI icon should appear in the Compass Bar. By default, POIs appear when they’re in “Visible Range” but you can specify a POI will always be visible (ie. active quest) or always hidden until you determine it can appear in the compass.

  • Visible Distance Override: a value of 0 assumes the general visible distance. Optionally assign a custom visible distance.

  • IsVisible: this property is automatically set by the asset based on Distance property and determines if the icon is visible in the compass bar.

  • Title: this is the name of the POI to be shown over the compass bar if IsVisited is true.

  • HideWhenVisited: when enabled, the POI will automatically be hidden in the compass bar when visited.

  • canBeVisited: this property specifies if the POI can be marked as visited when reached. Defaults to true.

  • IsVisited: this property is also automatically set to true by the asset as the player moves over the scene and determines if the POI is explored or not (based on the VisitedDistance property). You can also set this property to true to ignore the visited/non-visited feature.

  • Visited Text: this is the text shown in animated way when the POI is visited for the first time.

  • Visited Audio Clip: optional audio clip to be played when this POI is visited for the first time. Note that a global default audio clip can be also specified in the Compass Navigator Pro script.

  • Radius: this is a radius for the POI. Useful for areas or cities where it really has no an exact center.

  • Icon Non Visited: the icon to be shown in the compass bar when IsVisited = false.

  • Icon Visited: the icon shown in the compass bar when IsVisited = true.

  • Show Play Mode Gizmo: mark this toggle to show the visited icon in the scene during playmode to mark exactly the location of this POI in the scene.

  • Clamp Position: forces this POI icon to stay visible in the bar, even if it’s behind the player (then it will show on the edges of the bar).

  • Beacon Audio Clip: custom sound for this POI when the light beacon is shown.

  • Don’t Destroy On Load: enabling this option will preserve this POI between scene changes (also its visited state). Note that the POI will only be visible in the scene where it was first created.

  • Heartbeat Enabled: enables heartbeat sound when camera is approaching this POI. The heartbeat sound will play at a variable rate based on distance.

  • Heartbeat Audio Clip: optional audio clip for the heartbeat sound. If none set, it will use the clip specified in the Compass Bar property.

  • Heartbeat Distance: distance from which the heartbeat starts playing.

  • Heartbeat Interval: a curve defining the heartbeat interval rate. The X-axis specifies the distance to the POI from 0 to 1 (1 = heartbeat distance). The Y-axis specifies the interval in seconds between heartbeats.

Mini-Map Settings per POI:

  • Visibility: defines when this POI is visible in the mini-map.

  • IsVisible: is set to true when the POI is visible in the mini-map.

  • Clamp Position: when set to true, the POI will always be visible in the mini-map even if it’s out of range.

Methods of Compass Pro POI component:

  • GetCompassIconScreenRect: returns the screen rectangle of the icon in the compass bar (if visible).

  • GetMiniMapIconScreenRect: returns the screen rectangle of the mini-map icon if visible.

Back To Top