Docs / Drawing

Drawing

Native D3D11 overlay renderer. Drawing.new(type) returns a mutable object.

Library#17 of 23 Functions7
Drawing.new(type: string) → DrawObject
Types: "Line", "Text", "Image", "Circle", "Square", "Triangle", "Quad". Every draw object supports Visible, ZIndex, Transparency, Color, plus type-specific properties (e.g. Position, Size, Radius, Text, Data for Image, etc.). Call obj:Remove() to destroy.
lua
local text = Drawing.new("Text")
text.Text     = "Hello"
text.Position = Vector2.new(100, 100)
text.Size     = 20
text.Color    = Color3.new(1, 1, 1)
text.Visible  = true
cleardrawcache()
Destroy every drawing object created by the executor.
lua
cleardrawcache()   -- wipe overlay on script reload
isrenderobj(value: any) → boolean
true if the value is a Drawing object.
lua
local sq = Drawing.new("Square")
print(isrenderobj(sq))     --> true
print(isrenderobj({}))     --> false
getrenderproperty(obj: DrawObject, property: string) → any
Generic property read — same as obj[property].
lua
print(getrenderproperty(sq, "Visible"))
setrenderproperty(obj: DrawObject, property: string, value: any)
Generic property write.
lua
setrenderproperty(sq, "Color", Color3.new(1, 0, 0))
getfpscap() → number
Current FPS cap set on the render loop.
lua
print(getfpscap())
setfpscap(fps: number)
Cap the client's FPS. 0 = uncapped.
lua
setfpscap(240)
setfpscap(0)   -- unlock
lua
local sq = Drawing.new("Square")
sq.Size         = Vector2.new(100, 60)
sq.Position     = Vector2.new(400, 300)
sq.Color        = Color3.fromRGB(255, 84, 69)
sq.Filled       = true
sq.Transparency = 0.8
sq.Visible      = true