Quest Codex Waypoint

Quest Codex Waypoint

AudienceProvided by Quest Codex

Fields

Field	Type	Default	Description
target	WaypointTarget	—	Target resolved from a position, active objective or entity.Variants:entity_waypoint_targetfixed_waypoint_targetobjective_waypoint_targettracked_objective_waypoint_target entity_waypoint_target (1) Field Type Default Description entity Ref<out EntityInstanceEntry> — Entity instance whose current per-player position is used as the target. fixed_waypoint_target (1) Field Type Default Description position Var<Position> ORIGIN Fixed target position. objective_waypoint_target (1) Field Type Default Description objective Ref<out LocatableObjective> — Locatable objective used as the target. It is shown only while the objective is active and tracked. tracked_objective_waypoint_target (1) Field Type Default Description selection TrackedObjectiveSelection HIGHEST_PRIORITY How the active locatable objective is selected from the tracked quest.Values:HIGHEST_PRIORITYFIRSTCLOSEST
icon	Var<String>	—	Optional text or resource-pack glyph inserted by the {icon} placeholder in text layers.PlaceholdersColors
layers	List<WaypointLayer>	—	Display layers rendered for the target.Variants:waypoint_beacon_layerwaypoint_block_layerwaypoint_text_layer waypoint_beacon_layer (10) Field Type Default Description enabled Var<Boolean> true Whether this layer is rendered for the current player. mode BeaconMode TARGET Controls where the beacon appears: HUD, at the target, or both.Values:HUDTARGETBOTH material Var<Material> BEACON Block used for the vertical beacon beam. height Var<Int> 64 Beam height in blocks. Set to zero to reach the world's maximum height. thickness Var<Float> 0.35 Beam thickness. rotationSpeed Var<Float> 0.0 Rotation speed in degrees per refresh. offsetY Var<Double> 1.0 Vertical offset from the target position. viewDistance Var<Double> 200.0 Maximum distance at which the beacon is sent to the player. blockLight Var<Int> 15 Block light level used by the client. skyLight Var<Int> 15 Sky light level used by the client. waypoint_block_layer (6) Field Type Default Description enabled Var<Boolean> true Whether this layer is rendered for the current player. material Var<Material> BEACON Block displayed by the block display. offset Vector — Position relative to the selected anchor. placement WaypointLayerPlacement TARGET HUD or target placement. Only used when the resolved display mode is HUD_LOCKED.Values:HUDTARGET mode WaypointLayerMode INHERIT Overrides the entry's display mode for this layer.Values:INHERITHUD_LOCKEDWORLD_DIRECTIONALTARGET_ANCHOREDADAPTIVE scale Float 1.0 Display scale. waypoint_text_layer (13) Field Type Default Description enabled Var<Boolean> true Whether this layer is rendered for the current player. text Var<String> <white>{distance}</white> Multi-line text displayed. Use \ for newlines. Placeholders: {icon}, {distance}, {distance_m}, {distance_km}, {elevation}, {direction}, {vertical_direction}, {target}, {world_name}, {height_diff}, {eta}.PlaceholdersColors offset Vector — Position relative to the selected anchor. placement WaypointLayerPlacement HUD HUD or target placement. Only used when the resolved display mode is HUD_LOCKED.Values:HUDTARGET mode WaypointLayerMode INHERIT Overrides the entry's display mode for this layer.Values:INHERITHUD_LOCKEDWORLD_DIRECTIONALTARGET_ANCHOREDADAPTIVE scale Float 1.0 Display scale. lineWidth Int 200 Maximum text line width. shadow Boolean true Show a text shadow. seeThrough Boolean true Render the text through blocks. breathing Boolean false Enable gentle vertical oscillation (breathing animation). breathingAmplitude Double 0.3 Breathing amplitude in blocks. breathingPeriod Double 2.0 Breathing period in seconds. backgroundOpacity Byte 0 Opacity (0.0-1.0). Requires a shadow for the text background.
displayMode	WaypointDisplayMode	HUD_LOCKED	How waypoints are placed in the world. Layers may override this individually.
maxTargets	Int	5	Maximum number of simultaneous targets rendered. Only selections that yield several targets are affected.
projectionRadius	Double	12.0	Sphere radius, in blocks, used by WORLD_DIRECTIONAL and ADAPTIVE placement.
constantApparentSize	Boolean	true	Keep a constant apparent size when a projected marker sits closer than the projection radius.
adaptiveTransitionBand	Double	4.0	Blend distance above nearTargetDistance over which ADAPTIVE moves from the target to the projection sphere.
declutterAngle	Double	4.0	Minimum angular gap, in degrees, kept between two projected markers. Set to zero to disable decluttering.
declutterSpacing	Double	0.6	Vertical spacing, in blocks, applied to projected markers that would otherwise overlap.
refreshTicks	Int	1	Refresh interval in ticks. One tick gives the smoothest HUD tracking.
interpolationTicks	Int	2	Client-side interpolation of marker movement, in ticks. Raise it if markers stutter while running or flying; lower it for a more immediate response.
hideWithinDistance	Double	0.0	Optional hard-hide distance. Set to zero to keep the text visible above the target when close.
nearTargetDistance	Double	10.0	Distance within which text layers move above the target instead of staying in front of the player.
nearTargetVerticalOffset	Double	2.25	Vertical offset of near-target text above the target position.
targetViewDistance	Double	200.0	Distance at which target-anchored layers are hidden.
hudVisibilityAngle	Double	180.0	Horizontal visibility angle for the waypoint. 180 degrees means the front hemisphere; near-target text ignores this filter.
hudForwardDistance	Double	5.5	Distance in front of the player's eyes for HUD layers.
hudVerticalOffset	Double	1.0	Vertical offset for HUD layers.

How to use it

This is an audience entry: connect it to an audience filter, such as a quest or fact audience, so that only the right players see the marker.

1. Choose a target: a fixed position, a locatable objective, the tracked objective (selection HIGHEST_PRIORITY, FIRST, CLOSEST, ALL for every tracked objective or ONE_PER_QUEST) or an entity.
2. Add layers. A text layer shows {icon}, {distance}, {distance_m}, {distance_km}, {elevation}, {direction}, {vertical_direction}, {target}, {world_name}, {height_diff} and {eta}. A block layer shows a block, and a beacon layer a vertical beam. Set icon to text or a resource-pack glyph such as <font:my_pack:waypoint>◆</font> and insert it with {icon}.
3. Pick displayMode: HUD_LOCKED pins the marker in front of the camera within hudVisibilityAngle; WORLD_DIRECTIONAL projects it on a sphere of projectionRadius blocks in the true direction of the target; TARGET_ANCHORED places it on the target within targetViewDistance; ADAPTIVE blends the two. A layer's mode overrides it.
4. With several targets, maxTargets caps them and declutterAngle and declutterSpacing stack overlapping markers.

refreshTicks 1 gives the smoothest tracking; raise interpolationTicks if markers stutter. Within nearTargetDistance text layers move above the target. A layer can be switched per player with its enabled variable.