gps_location_objective
A GPS location(s) objective with arrows and distance tracking — misc entry.
Entry Information
| Property | Value |
|---|---|
| Entry ID | gps_location_objective |
| Type | Misc |
| Color | Blue |
| Icon | mdi:navigation |
Fields
| Field | Type | Description |
|---|---|---|
fact | Ref<CachableFactEntry> | The fact that is used to track the player's progress. |
targetLocations | List<Var<Position>> | List of target locations to reach in order |
reachDistance | Var<Double> | Distance threshold to consider location reached (in blocks) |
followClosest | Var<Boolean> | Whether to follow closest location or in order |
onLocationReached | Ref<TriggerableEntry> | Trigger to execute when reaching each location |
onAllLocationsComplete | Ref<TriggerableEntry> | Trigger to execute when all locations are completed |
enableParticles | Var<Boolean> | Enable particle effects at target locations |
particleConfig | Optional<GPSParticleConfig> | Particle configuration for target locations |
enableBeaconBeam | Var<Boolean> | Enable beacon-style beams at the target locations |
beaconBeamConfig | Optional<GPSBeaconConfig> | Beacon configuration for target locations |
enableIndicator | Var<Boolean> | Enable a floating indicator rendered in front of the player |
indicatorConfig | Optional<GPSIndicatorConfig> | Configuration of the floating indicator |
placeholderConfig | Optional<GPSPlaceholderConfig> | Customization for GPS placeholders (directional arrows and elevation icons) |
enableTimer | Var<Boolean> | Enable timer that resets the objective if not completed in time |
timerDuration | Var<Duration> | Duration before the objective times out and resets (only if enableTimer is true) |
timerStartLocation | Var<Int> | Minimum location index to reach before the timer starts (0-based, -1 to start immediately) |
onTimerExpired | Ref<TriggerableEntry> | Trigger to execute when the timer expires and the objective resets |
enableCompanion | Var<Boolean> | Enable a 3D companion that points to the target |
companionConfig | Optional<GPSCompanionConfig> | Configuration for the 3D companion |
codexLore | Var<String> | Lore to display in the Quest Codex menu when this quest is active |
onCodexShiftClick | Ref<TriggerableEntry> | Trigger to execute when Shift + Left Clicked in the Quest Codex menu |
hideObjective | Var<Boolean> | Whether to hide this objective from the tracking menu (scoreboard/placeholders) unless the quest is tracked. |
Usage Example
- entry: gps_location_objective
name: "A GPS location(s) objective with arrows and distance tracking"
fact: ""
targetLocations: []
reachDistance: 0
followClosest: false
onLocationReached: ""
onAllLocationsComplete: ""
enableParticles: false
particleConfig: ""
enableBeaconBeam: false
beaconBeamConfig: ""
enableIndicator: false
indicatorConfig: ""
placeholderConfig: ""
enableTimer: false
timerDuration: ""
timerStartLocation: 0
onTimerExpired: ""
enableCompanion: false
companionConfig: ""
codexLore: ""
onCodexShiftClick: ""
hideObjective: false