Skip to content

@pumpkin-plugins/waypoints API / rendering/layout / placeWaypointHud

Function: placeWaypointHud() ​

placeWaypointHud(eyePosition, worldAnchor, waypointDistance, previousElevation, stackIndex?): WaypointHudPlacement

Defined in: packages/waypoints/src/rendering/layout.ts:26

Places a distant marker on a viewer-centered sphere along the waypoint's world bearing. Only elevation is filtered; the eye origin and horizontal bearing follow the current position directly. Nearby markers blend continuously into their real world anchor, independently of camera rotation.

Parameters ​

eyePosition ​

WaypointPosition

worldAnchor ​

WaypointPosition

waypointDistance ​

number

previousElevation ​

number | undefined

stackIndex? ​

number = 0

Returns ​

WaypointHudPlacement

Pumpkin Plugins documentation