Waypoint Action

A scenario goal that displays flash messages when the player reaches specific waypoints. Unlike other goals, this is purely informational - it doesn't trigger win or fail conditions.

Internal State

Public API (Exports)

Goal JSON Schema

{
  "goal": {
    "wayPointAction": {
      "wayPointNum": [2, 5, 8],
      "wayPointMsg": ["Turn left!", "Speed up!", "Almost there!"]
    }
  }
}

How It Works

1. init filters goals for id == "wayPointAction", validates wayPointNum is a table
2. On onRaceWaypointReached event (only while running + racing):
   • Gets current waypoint index from scenario_waypoints.getVehicleWaypointData()
   • Iterates wayPointNum array - each entry must be a number
   • If vehWpData.cur matches a waypoint number, shows the corresponding wayPointMsg
3. Messages displayed via helper.flashUiMessage with 2-second duration
4. updateFinalStatus is empty - this goal has no scoring impact

Usage Example

-- In scenario JSON: show messages at waypoints 3 and 7
{
  "vehicles": {
    "scenario_player0": {
      "goal": {
        "wayPointAction": {
          "wayPointNum": [3, 7],
          "wayPointMsg": [
            "Watch out for the sharp turn!",
            "Final stretch - give it everything!"
          ]
        }
      }
    }
  }
}

Key Notes

• Only triggers during onRaceWaypointReached when state is running + racing
• wayPointNum and wayPointMsg are parallel arrays (index 1 matches index 1)
• Validates both scenario lapConfig and wayPointNum are non-empty
• Non-number entries in wayPointNum are logged as errors and skipped
• If wayPointMsg is not provided, defaults to a space string " "
• This is an informational goal - it never causes pass/fail

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