Drawing
sUNC Reference

Drawing

Create and manage client-only 2D drawing objects.

Related to sUNC documentation

This reference is based exclusively on the official sUNC documentation.

Overview

  • Drawing objects render outside the DataModel and must be managed manually.
  • Supported shapes are Line, Text, Image, Circle, Square, Quad and Triangle.

Available functions

cleardrawcacheRemoves every active Drawing object.getrenderpropertyReads a Drawing property by name.isrenderobjChecks whether a value is a valid Drawing object.setrenderpropertyAssigns a Drawing property by name.

Constructor

Creates a drawing object of the selected type.

Luau
function Drawing.new(type: string): Drawing

Shared properties

NameTypeDescription
Visibleboolean

Controls whether the object is rendered.

ZIndexnumber

Controls render order.

Transparencynumber

0 is fully visible and 1 is fully transparent.

ColorColor3

Controls the drawing color.

__OBJECT_EXISTSboolean

Reports whether the drawing object exists.

Methods

NameTypeDescription
Destroy()()

Permanently removes the drawing object.