Skip to content

@pumpkin-plugins/waypoints API / rendering/renderer / WaypointHudRenderer

Class: WaypointHudRenderer ​

Defined in: packages/waypoints/src/rendering/renderer.ts:70

Renders access-filtered waypoints as client-only Java TextDisplays with directional HUD placement. Each viewer gets an independent entity ledger, so restricted waypoint labels and personalized distances never enter another player's packet stream.

Methods ​

clear() ​

clear(): void

Defined in: packages/waypoints/src/rendering/renderer.ts:166

Drops all renderer state after unload cleanup has been attempted.

Returns ​

void


forgetViewer() ​

forgetViewer(viewerId): void

Defined in: packages/waypoints/src/rendering/renderer.ts:154

Drops transient state when a client is no longer reachable.

Parameters ​

viewerId ​

string

Returns ​

void


removeViewer() ​

removeViewer(viewerId, sendPacket): void

Defined in: packages/waypoints/src/rendering/renderer.ts:140

Removes every client-only display for a player who is leaving or unloading the plugin.

Parameters ​

viewerId ​

string

sendPacket ​

(packet) => void

Returns ​

void


renderViewer() ​

renderViewer(viewer, waypoints): void

Defined in: packages/waypoints/src/rendering/renderer.ts:79

Renders one viewer's current authorized waypoints and diffs its display packets.

Parameters ​

viewer ​

WaypointHudViewer

waypoints ​

readonly Waypoint[]

Returns ​

void


retainViewers() ​

retainViewers(onlineViewerIds): void

Defined in: packages/waypoints/src/rendering/renderer.ts:159

Forgets disconnected viewers after a tick without sending packets to a closed connection.

Parameters ​

onlineViewerIds ​

ReadonlySet<string>

Returns ​

void

Pumpkin Plugins documentation