Gameplay Raw POIs

Extension that manages raw Point of Interest (POI) lists used by the bigmap/minimap. Aggregates POIs from all gameplay systems (missions, facilities, gas stations) with special handling for career tutorial flow.

Public API

Hooks

Internals

• rawPoiListByLevel: Cache of POI arrays keyed by level identifier
• rawPoiGeneration: Increments on each cache clear, used by consumers to detect stale data

How It Works

1. getRawPoiListByLevel checks if a cached list exists for the level
2. If not cached, calls extensions.hook("onGetRawPoiListForLevel") to collect POIs from all extensions
3. Each POI element is validated and defaults bigmapMarker.cluster = true
4. Test drive POIs are filtered out unless it's the test drive end marker

Career Tutorial Flow (west_coast_usa)

During the linear tutorial, POIs are restricted to guide the player:

-- Get POIs for current level
local pois, gen = gameplay_rawPois.getRawPoiListByLevel("west_coast_usa")
for _, poi in ipairs(pois) do
  -- poi.data.id or poi.data.missionId
  -- poi.markerInfo.bigmapMarker
  -- poi.clusterType
end

-- Force refresh
gameplay_rawPois.clear()

Dependencies

• career_career - check career active state
• career_modules_linearTutorial - tutorial flag checks
• freeroam_facilities - facility/dealership/gas station data
• freeroam_gasStations - gas station POI formatting
• gameplay_missions_missions - mission POI formatting
• career_modules_inspectVehicle - vehicle inspection POI
• career_modules_testDrive - test drive filtering

Notes

• POI elements must have data (with id or missionId) and clusterType fields
• Invalid elements are logged and discarded via validateRawPoiElement
• Generation counter allows consumers to efficiently detect when to refresh

See Also

• Gameplay Achievement - Related reference
• Gameplay City - Related reference
• discover - Discover / Experience System - Related reference
• Gameplay Systems Guide - Guide