Minimap Additional Info

Streams supplementary info (distance to target, location name, police status) alongside the minimap.

Overview

ui_apps_minimap_additionalInfo runs per-frame checks for route distance, current location name, and police pursuit status, then queues changes to the "minimap" UI stream.

Extension path: lua/ge/extensions/ui/apps/minimap/additionalInfo.lua

Exports (M)

Internals

Streamed Fields

The additionalInfo table is queued to the "minimap" stream with these optional fields:

Change Detection

Each check compares against the previous value and only sets hasNewAdditionalInfo = true when something changes:

local function checkRoute()
  local rp = core_groundMarkers.routePlanner
  if not rp or not rp.path or not rp.path[1] then
    if oldDistToTarget then resetDistToTarget() end
    return
  end
  local distToTarget, unit = translateDistance(rp.path[1].distToTarget, "auto")
  if distToTarget ~= oldDistToTarget then
    oldDistToTarget = distToTarget
    additionalInfo.distToTarget = string.format("%.1f %s", distToTarget, unit)
    hasNewAdditionalInfo = true
  end
end

Location Name Resolution

Falls back from gameplay_city zone names to level title:

local location = gameplay_city.getHighestPrioZone(camPos)
if location then
  locationName = location.name
else
  -- Fallback to level title from core_levels
end

How It Works

1. onUpdate runs every frame, calling checkRoute(), checkLocationName(), checkPolice()
2. Each check compares current state against cached previous value
3. If any field changed, hasNewAdditionalInfo flag is set
4. At end of frame, changed info is queued via guihooks.queueStream("minimap", additionalInfo)
5. UI minimap widget reads the stream and displays distance, location, and police indicators

Additional Exports

The following exports are available but not yet documented in detail:

• M.onClientEndMission
• M.onReachedTargetPos
• M.onSetBigmapNavFocus
• M.onUpdate
• M.requestAdditionalInfo