Skip to content

Drawing ​

Screen and world drawing. World primitives are projected with the client's own camera; text and bars are the client's own FontStrings and Textures anchored at projected positions.

14 entry points, 14 documented.

Nyx.Draw.Line ​

lua
Nyx.Draw.Line(x1, y1, x2, y2, r, g, b, a)

Screen-space line between two pixel positions. Colours are 0-1.

Draw.lua

Nyx.Draw.Rect ​

lua
Nyx.Draw.Rect(x, y, width, height, r, g, b, a, filled)

Screen-space rectangle at a pixel position. filled draws a solid block rather than an outline.

Draw.lua

Nyx.Draw.Circle ​

lua
Nyx.Draw.Circle(x, y, radius, r, g, b, a)

Screen-space circle centred on a pixel position.

Draw.lua

Nyx.Draw.WorldLine ​

lua
Nyx.Draw.WorldLine(x1, y1, z1, x2, y2, z2, r, g, b, a)

Line between two WORLD positions, projected with the client camera.

Draw.lua

Nyx.Draw.WorldCircle ​

lua
Nyx.Draw.WorldCircle(x, y, z, radius, r, g, b, a)

Horizontal ring at a world position - a ground marker. radius is in yards.

Draw.lua

Nyx.Draw.Clear ​

lua
Nyx.Draw.Clear()

Drops every queued shape. Drawings persist until replaced, so this is what makes one disappear.

Draw.lua

Nyx.Draw.Probe ​

lua
Nyx.Draw.Probe()

Screen-space proof of life, drawn every tick while the overlay is on. It shares nothing with the world path: if this box appears and the world rings do not, the render hook is fine and the view/projection matrices read at EndScene are not the world transform. If neither appears, the hook itself is not painting and the matrices are beside the point.

Draw.lua

Nyx.Draw.Update ​

lua
Nyx.Draw.Update()

Draws the built-in overlay for one frame. Called by the ticker while /nyx draw is on.

Draw.lua

Nyx.Draw.BeginFrame ​

lua
Nyx.Draw.BeginFrame()

Starts a frame of text and bars: releases the pools and samples the viewport. Pair with EndFrame.

Draw.lua

Nyx.Draw.EndFrame ​

lua
Nyx.Draw.EndFrame()

Hides any text or bar the frame did not use. Without this they linger from the previous frame.

Draw.lua

Nyx.Draw.WorldText ​

lua
Nyx.Draw.WorldText(text, x, y, z, r, g, b)

Text at a world position, drawn with the client's own font. Call between BeginFrame and EndFrame.

Draw.lua

Nyx.Draw.ScreenText ​

lua
Nyx.Draw.ScreenText(text, x, y, r, g, b)

Text at an ABSOLUTE viewport position, in render pixels from the top-left.

WorldText's sibling, and the difference is the whole point: that one projects a world point and therefore disappears when the camera looks away, this one is screen furniture and stays put. The HUD rows on the Visuals page are the callers -- a rotation status line pinned at 50%/42% of the viewport is not attached to anything in the world.

Shares WorldText's pool, so it must be called between BeginFrame and EndFrame like everything else, and an unused row is hidden by the same sweep.

Draw.lua

Nyx.Draw.WorldHealthBar ​

lua
Nyx.Draw.WorldHealthBar(fraction, x, y, z, width, height)

A health bar floating above a world position. width/height are in interface units so bars stay a readable size regardless of resolution.

Draw.lua

Nyx.Draw.HideAll ​

lua
Nyx.Draw.HideAll()

Hides every text and bar immediately, regardless of frame state.

Draw.lua

API reference generated from source.