Escort Objective
Type:escort_objective
An objective where the player must protect an NPC as it travels along a defined path.
Configuration
| Field | Type | Default | Description |
|---|---|---|---|
id | String | "" | Unique identifier. |
npc | Ref<Entity> | Empty | The visual entity to escort. |
maxHealth | Var<Double> | 20.0 | Max health of the escort. |
regenPerSec | Var<Double> | 0.0 | Health regen per second. |
damageReductionPct | Var<Double> | 0.0 | Damage reduction (0-100). |
guardRadius | Var<Double> | 10.0 | Max distance player can be from NPC. |
spawnRadius | Var<Double> | 40.0 | Radius around start node to spawn NPC. |
startRadius | Var<Double> | 5.0 | Distance to approach to start moving. |
globalTimeLimitSec | Var<Int> | 0 | Time limit (0 = unlimited). |
Triggers
| Field | Description |
|---|---|
onEscortStart | Triggered when the escort begins moving. |
onCheckpoint | Triggered when reaching a path node. |
onEscortLost | Triggered when player leaves guard radius. |
onEscortRecovered | Triggered when returning to radius. |
onEscortComplete | Triggered when reaching the end. |
onEscortFail | Triggered if NPC dies or time runs out. |
Visuals & UI
| Field | Type | Default | Description |
|---|---|---|---|
enableScoreboard | Var<Boolean> | false | Show tracking scoreboard. |
enableBossBar | Var<Boolean> | false | Show health bossbar. |