Position Goal

A scenario goal that checks if a vehicle is within range of a target scene object at race end. Used for parking/braking scenarios.

Internal State

Public API

Goal JSON Schema

{
  "goal": {
    "position": {
      "endPoint": "brake_zone_marker",
      "purpose": "fail",
      "msg": "scenarios.braking.notInZone"
    }
  }
}

How It Works

1. init collects all goals with id == "position", validates and defaults purpose
2. On onRaceResult:
   • Finds the endPoint object in the scene tree
   • Calculates distance between vehicle and endpoint
   • If distance > endobj.scale.x (uses X scale as radius):
     • Triggers win or fail based on purpose
   • Otherwise: sets result = "passed"

Usage Examples

-- Braking scenario: must stop within the marked zone
{
  "vehicles": {
    "scenario_player0": {
      "goal": {
        "position": {
          "endPoint": "brake_target",
          "purpose": "fail",
          "msg": "scenarios.braking.missedTarget"
        }
      }
    }
  }
}

Key Notes

• Distance threshold uses the endpoint object's scale.x as the acceptance radius
• Only checked at onRaceResult - not continuous monitoring
• The endpoint must exist in the scene tree (scenetree.findObject)
• For continuous position monitoring, use distance goal instead
• Time string is appended to win messages but not fail messages

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