Freeroam Drift Spots

Reference for gameplay_drift_freeroam_driftSpots, which manages freeroam drift zones - detecting when the player drifts through a start line, running the challenge, tracking scores/highscores, and integrating with the POI/big-map system.

Dependencies

gameplay_drift_general, gameplay_drift_drift, gameplay_drift_scoring, gameplay_drift_saveLoad

Exports

| Function | Signature | Description | |------ | M.dependencies | table | { |----|-----------|-------------| | detectStart | (lineId) | Check if player entered a start line while drifting | | onUpdate | (dtReal, dtSim, dtRaw) | Main loop - check end conditions | | onVehicleResetted | (id) | Improper end on vehicle reset | | onGetRawPoiListForLevel | (levelId, elements) | Inject drift spot POIs and big-map markers | | onDriftCompletedScored | () | Check objective completion, new highscore | | onSerialize / onDeserialized | (data) | Handle hot-reload during challenge | | getIsInTheConcludingPhase | () → bool | Post-challenge animation phase | | getIsInFreeroamChallenge | () → bool | Currently in a drift spot challenge | | getDriftDebugInfo | () → table | Debug toggle state | | getGC | () → number | Profiler garbage |

Internals

How It Works

Challenge Start

-- A start line is a rectangle in the world
-- Player must be inside rectangle AND drifting AND moving in startDir
gameplay_drift_freeroam_driftSpots.detectStart("spotName_lineOne")
-- If conditions met:
-- 1. Set context to "inFreeroamChallenge"
-- 2. Load bounds and race path
-- 3. Show tasklist with highscore and objectives

Challenge End - Proper

-- Cross the corresponding finish line (e.g., lineOne → lineTwo)
-- 1. Wrap up remaining score
-- 2. Show completion message with score
-- 3. Save score to leaderboard
-- 4. Reset to "inFreeroam" context

Challenge End - Improper

Score & Objectives

-- Scores are saved per spot with license plate and timestamp
addNewScore(spotName, score)
-- Keeps top 10 scores, sorted descending

-- Objectives are defined in spot info:
-- {id = "bronze", score = 500, rewards = {bmra = 10}}
-- Career rewards are granted on first completion

POI Integration

-- Each line becomes a POI with:
-- 1. driftLineMarker - invisible trigger at line position
-- 2. bigmapMarker (lineOne only) - icon, name, preview, highscore
--    Uses "mission_drift_triangle" icon
--    Shows quickTravelPosRotFunction for teleporting

Key Behaviors

• Each drift spot has two lines (lineOne, lineTwo) - either can be start or finish depending on direction
• Line crossing uses isPointInsideRectangle() with local-space OBB test + velocity dot product for direction
• correspondingLineName maps lineOne ↔ lineTwo for finish detection
• Marker objects (cones, etc.) are hidden on load via scenetree.findObject
• Score saving uses gameplay_drift_saveLoad.saveDriftSpotsScoresForSpotById()
• New highscore flash only triggers once per challenge (hasAlreadyShownNewRecord)

Module Variables

See Also

• drift/freeroam/cruising - Freeroam Drift Cruising UI Toggle - Related reference
• Gameplay Systems Guide - Guide