escort_objective
Escort an NPC along a route — misc entry.
Entry Information
| Property | Value |
|---|---|
| Entry ID | escort_objective |
| Type | Misc |
| Color | Green |
| Icon | mdi:human |
Fields
| Field | Type | Description |
|---|---|---|
maxHealth | Var<Double> | Maximum health of the escort mob |
regenPerSec | Var<Double> | Health regenerated per second. 0 = no regeneration |
damageReductionPct | Var<Double> | Percent of incoming damage to negate (0-100) |
mobHitDamage | Var<Double> | Amount of health lost each time the escort mob is hit by another mob |
invulnerable | Var<Boolean> | If true the escort mob is completely invulnerable |
hurtSound | Var<Sound> | Custom sound to play when the escort mob takes damage |
guardRadius | Var<Double> | Radius the player must stay within to keep the escort active |
loseToleranceSec | Var<Int> | Seconds the player is allowed to exceed the guard radius before failing |
globalTimeLimitSec | Var<Int> | Time limit in seconds for the whole escort. 0 = unlimited |
nodeReachRadius | Var<Double> | Distance considered as reaching a waypoint |
spawnRadius | Var<Double> | Radius around the spawn node to spawn the NPC |
startRadius | Var<Double> | Distance from the NPC required to start the escort |
npc | Ref<out SimpleEntityInstance> | Existing NPC instance used for the escort visual |
ambushes | List<AmbushSpec> | Optional ambush triggers executed at checkpoints |
enableScoreboard | Var<Boolean> | If true, display a scoreboard tracking progress |
enableBossBar | Var<Boolean> | If true, display a bossbar showing escort health |
onEscortStart | Ref<TriggerableEntry> | Trigger executed when the escort starts |
onCheckpoint | Ref<TriggerableEntry> | Trigger executed when the escort reaches a waypoint |
onEscortLost | Ref<TriggerableEntry> | Trigger executed when the player leaves the guard radius |
onEscortRecovered | Ref<TriggerableEntry> | Trigger executed when the player returns within the guard radius |
onEscortReset | Ref<TriggerableEntry> | Trigger executed when the escort resets after being too far or the player dying |
onEscortComplete | Ref<TriggerableEntry> | Trigger executed when the escort completes successfully |
onEscortFail | Ref<TriggerableEntry> | Trigger executed when the escort fails |
hideObjective | Var<Boolean> | Whether to hide this objective from the tracking menu (scoreboard/placeholders) unless the quest is tracked. |
Usage Example
- entry: escort_objective
name: "Escort an NPC along a route"
maxHealth: 0
regenPerSec: 0
damageReductionPct: 0
mobHitDamage: 0
invulnerable: false
hurtSound: ""
guardRadius: 0
loseToleranceSec: 0
globalTimeLimitSec: 0
nodeReachRadius: 0
spawnRadius: 0
startRadius: 0
npc: ""
ambushes: []
enableScoreboard: false
enableBossBar: false
onEscortStart: ""
onCheckpoint: ""
onEscortLost: ""
onEscortRecovered: ""
onEscortReset: ""
onEscortComplete: ""
onEscortFail: ""
hideObjective: false