Drawing

Camera and overlays

Camera.worldToScreen, ESP boxes and Notify toasts.

Camera

Converts world positions to screen positions. It assumes a first-person camera and is an approximation.

Camera.fov

Vertical field of view in degrees. Default 70.

Camera.setFov(v)

Sets Camera.fov. Invalid values reset it to 70.

Camera.position()

Returns x, eyeY, z, yaw, pitch for the player, or nil if there is no player.

Camera.worldToScreen(x, y, z)

Returns screenX, screenY, depth, onScreen.

  • If the point is behind you, returns nil, nil, depth, false.
  • onScreen is true when the point is inside the window.
  • Returns nil when there is no player.
local sx, sy, depth, on = Camera.worldToScreen(100, 64, 100)
if on then
  print("on screen at", sx, sy)
end

Camera.isOnScreen(x, y, z)

Returns true if the point is on screen.

ESP

Draws a box and a name for entities on the screen, using Camera.worldToScreen.

ESP.new(opts)

Starts drawing and returns a handle.

OptionDefaultMeaning
playerstrueInclude players (pass false to skip)
hostilenot setInclude hostile mobs
passivenot setInclude passive mobs
othernot setInclude other entities
range64Maximum distance
colorwhiteA Color3, or a function f(entity) returning one
distancetrueAdd [Nm] to the name. Pass false to hide

handle.remove()

Stops drawing and removes all boxes. Note that this is a plain function, not a method: call handle.remove().

local esp = ESP.new({
  range = 80,
  color = function(e) return Colorx.health(1) end,
})

task.wait(30)
esp.remove()

Notify

Short messages shown at the bottom right of the screen. At most 8 are shown at once, and the oldest is removed first. A message fades during its last half second.

Notify.show(text, seconds = 3, color)

Shows a message in the given Color3 (white by default).

Notify.info(text, seconds), Notify.success(text, seconds), Notify.warn(text, seconds), Notify.error(text, seconds)

Same as show with a blue, green, yellow or red colour.

Notify.success("Script loaded")