DrawingObject:Remove Synchronous

  • DrawingObject:Destroy

Permanently remove this drawing from the screen. This cleans up one object while leaving other drawings in place. Use it when the UI element represented by this drawing closes. Hiding with Visible = false keeps the object available; removing it ends its lifetime.

Syntax
Luau
DrawingObject:Remove() -> ()

Parameters

Call this method with a DrawingObject receiver. The colon supplies self implicitly; a dot call must pass the receiver explicitly.

This function takes no arguments.

Returns

()

This function returns no values.

Usage notes

Destroy is an alias for Remove. After removal, __OBJECT_EXISTS is false and isrenderobj returns false. Property updates are rejected.

Example

Example
Luau
local marker = Drawing.new("Circle")
print(marker.__OBJECT_EXISTS) -- true
marker:Remove()
print(marker.__OBJECT_EXISTS) -- false
Kawaii documentation