Package privbot.ui.overlay


@PublicApi package privbot.ui.overlay
The in-game overlay kit: HUD panels and scene drawing that work the same on every server.

The rule: render reads the snapshot and nothing else. Copy what an overlay needs into an immutable value on the game tick and publish it; the composers given to PrivBotOverlays.panel(java.lang.String) (rows(...)) and PrivBotOverlays.scene(net.runelite.api.Client) (draw(...)) receive that value only. On Impact the render thread cannot call client hooks, so an overlay that reads the client in render stalls or draws nothing. visibleWhen conditions run on the render thread too and must read published flags.

HUD rows come from Rows, colours only from OverlayTheme and ColorRamp (user-chosen colours enter through OverlayPalette). Scene drawing goes through SceneCanvas over a SceneProjection, which is what makes tiles draw on Impact and Elorin, where RuneLite's Perspective draws nothing. Register with PrivBotOverlays.install(net.runelite.client.ui.overlay.OverlayManager, net.runelite.client.ui.overlay.Overlay...) in startUp() and OverlaySet.close() in shutDown().

The Workflow Studio (Builder) HUD and the "Move overlay" support classes also live here; the HUD's own classes are not plugin API. Guide: the SDK docs, Concepts (UI kit surfaces) and the overlays and UI cookbook.