Drawing.new

Drawing.new(type: "Line" | "Circle" | "Square" | "Triangle" | "Text" | "Image" | "Quad") -> Drawing

Creates a drawing object of the given type and returns it. Set its properties to position and style it; it renders every frame while Visible is true. Call :Destroy() (or :Remove()) on it when you are done, or clear everything at once with cleardrawcache. Every object shares Visible, ZIndex, Transparency, and Color. Each type adds its own:

Line: Thickness, From, To.
Square: Position, Size, Thickness, Filled, Rounding.
Circle: Position, Radius, NumSides, Thickness, Filled.
Triangle: PointA, PointB, PointC, Thickness, Filled.
Quad: PointA, PointB, PointC, PointD, Thickness, Filled.
Text: Text, Size, Center, Outline, OutlineColor, Font, Position, and read-only TextBounds.
Image: Data, Position, Size, Rounding.

Parameters

string

required

One of Line, Circle, Square, Triangle, Text, Image, Quad.

Returns

Drawing

A new drawing object.

Example

local box = Drawing.new("Square")
box.Size = Vector2.new(80, 80)
box.Position = Vector2.new(200, 200)
box.Color = Color3.new(1, 0, 0)
box.Filled = true
box.Visible = true
-- later:
box:Destroy()

Errors

Message	Condition
`'<type>' is not a drawing type, expected Line, Circle, Square, Triangle, Text, Image or Quad`	The type string was not a known drawing type.
`too many drawings are alive, destroy some or call cleardrawcache`	The live-drawing cap was reached.

fonts: font constants for Text.
cleardrawcache: remove everything.

Getting Started

Environment

Closures

Scripts

Reflection

Metatable

Instances

Cache

Signals

Signal

Actors

LuaStateProxy

Console

Input

Drawing

Filesystem

Encoding

Crypt

HTTP

WebSocket

RakNet

Miscellaneous

oth

Parameters

Returns

Example

Errors

​Parameters

​Returns

​Example

​Errors

​Related

Parameters

Returns

Example

Errors

Related