Damage Goal

A scenario goal that monitors vehicle damage and triggers win or fail when damage exceeds a configurable limit. Supports threshold-based progress notifications.

Internal State

Public API

Goal JSON Schema

{
  "goal": {
    "damage": {
      "damageLimit": 1000,
      "damageThreshold": 100,
      "purpose": "fail",
      "msg": "scenarios.myScenario.damageFail"
    }
  }
}

How It Works

1. init filters scenario goals for id == "damage", validates types, defaults purpose to "fail"
2. Each onRaceTick, reads fobjData.damage from the map object tracker
3. If damage exceeds damageLimit, calls showMsg which:
   • Sets result to "failed" or "passed" based on purpose
   • Calls scenario_scenarios.finish() with appropriate message
4. If damageThreshold is set, shows progress flash messages at each threshold increment
5. Tracks lastProgress to avoid duplicate notifications

Usage Examples

-- In scenario JSON: fail if damage exceeds 500
{
  "vehicles": {
    "scenario_player0": {
      "goal": {
        "damage": {
          "damageLimit": 500,
          "purpose": "fail"
        }
      }
    }
  }
}

-- With progress notifications every 20% of limit
{
  "damage": {
    "damageLimit": 1000,
    "damageThreshold": 200,
    "purpose": "fail"
  }
}

Key Notes

• Uses map.objects[map.objectNames[vehicleName]] for damage tracking
• If the map object is missing, re-tracks the vehicle via helper.trackVehicle
• The damageThreshold shows flash messages like "50% damaged" at each increment
• purpose: "win" is useful for demolition-style scenarios where taking damage is the objective

See Also

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