Race Markers

Central manager for all race checkpoint markers. Creates, pools, positions, and updates marker objects. Supports swappable marker types and delegates rendering to individual marker instances.

Public API (Exports)

Internals

How It Works

1. Marker type selection: setupMarkers accepts an optional marker name string (e.g., "ringMarker"). If provided, loads scenario/raceMarkers/<name>. Falls back to sideColumnMarker.
2. Marker creation: For each waypoint, creates a marker via the factory, calls createMarkers() then setToCheckpoint(wp).
3. Mode management: setModes(wpModes) takes a table {waypointName = mode}. Markers not listed get 'hidden'.
4. Rendering: render(dt, dtSim) iterates all idToMarker entries and calls m:update(dt, dtSim).
5. Detached markers: createRaceMarker(true) creates a marker not tracked in idToMarker - useful for custom one-off markers.
6. Cleanup: onClientEndMission deletes all markers and resets createMarker to prevent stale module references.

Usage Example

-- Setup markers for a race (called by waypoints system):
local wps = {
  {name = "wp1", pos = vec3(100,200,50), radius = 8},
  {name = "wp2", pos = vec3(150,250,50), radius = 8},
}
race_marker.setupMarkers(wps, "ringMarker")  -- or nil for default

-- Set which markers are visible and in what mode:
race_marker.setModes({wp1 = 'default', wp2 = 'next'})

-- Per-frame rendering:
race_marker.render(dt, dtSim)

-- Create a standalone marker (not in pool):
local custom = race_marker.createRaceMarker(true, "overhead")
custom:createMarkers()
custom:setToCheckpoint(myWaypoint)

Key Notes

• Default marker type is sideColumnMarker (the most visually complex)
• Markers are stored in ScenarioObjectsGroup for automatic level cleanup
• The idToMarker table is also exposed as M.idToMarker (mutable reference)
• Custom marker types are specified in scenario JSON via track.customMarker

See Also

• Scenario Bus Driver - Bus Route Scenario Logic - Related reference
• Scenario Damage Goal - Damage-Based Win/Fail Condition - Related reference
• Scenario Demolition Derby - Last Vehicle Moving Wins - Related reference
• Scenario System Guide - Guide