Finish Race Goal

A scenario goal that tracks whether a vehicle finishes a race. Supports both "must finish" and "must win" modes.

Public API

Goal JSON Schema

{
  "goal": {
    "finishRace": {
      "mustWin": true,
      "passed": "scenarios.race.youWon",
      "failed": "scenarios.race.youLost"
    }
  }
}

How It Works

1. init collects all goals with id == "finishRace"
2. On onRaceWaypointReached: when next == nil (final waypoint):
   • mustWin mode: First vehicle to reach end passes; all others fail
   • Normal mode: Each vehicle is marked pass/fail based on whether it finishes
3. On onRaceResult: Finishes the scenario with pass/fail messages
4. A vehicle that never reaches the final waypoint defaults to "failed"

State Events

| M.instances | varies | Assigned as {} |

Usage Examples

-- Simple finish goal: just cross the finish line
{
  "vehicles": {
    "scenario_player0": {
      "goal": {
        "finishRace": {}
      }
    }
  }
}

-- Must beat AI to win
{
  "finishRace": {
    "mustWin": true,
    "failed": "scenarios.race.aiWon"
  }
}

Key Notes

• Uses statistics_statistics.setGoalProgress to report results
• In mustWin mode, once any vehicle finishes, the player's result is locked
• Without mustWin, each vehicle independently passes or fails
• Both passedGoal and failedGoal call scenario_scenarios.finish() to end the scenario

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