DrawingImmediate
NOTE: DrawingImmediate APIs can only be called during render steps. See DrawingImmediate.GetPaint for more information.
Functions
Line
void DrawingImmediate.Line(p1: Vector2, p2: Vector2, color: Color3, opacity: number, thickness: number)
Draws a line.
Circle
void DrawingImmediate.Circle(center: Vector2, radius: number, color: Color3, opacity: number, num_sides: int, thickness: number)
Draws a circle.
FilledCircle
void DrawingImmediate.FilledCircle(center: Vector2, radius: number, color: Color3, num_sides: int, opacity: number)
Draws a filled circle.
Triangle
void DrawingImmediate.Triangle(p1: Vector2, p2: Vector2, p3: Vector3, color: Color3, opacity: number, thickness: number)
Draws a triangle.
FilledTriangle
void DrawingImmediate.FilledTriangle(p1: Vector2, p2: Vector2, p3: Vector3, color: Color3, opacity: number)
Draws a filled triangle.
Rectangle
void DrawingImmediate.Rectangle(top_left: Vector2, size: Vector2, color: Color3, opacity: number, rounding: number, thickness: number)
Draws a rectangle.
FilledRectangle
void DrawingImmediate.FilledRectangle(top_left: Vector2, size: Vector2, color: Color3, opacity: number, rounding: number)
Draws a filled rectangle.
Quad
void DrawingImmediate.Quad(p1: Vector2, p2: Vector2, p3: Vector2, p4: Vector2, color: Color3, opacity: number, thickness: number)
Draws a quad.
FilledQuad
void DrawingImmediate.FilledQuad(p1: Vector2, p2: Vector2, p3: Vector2, p4: Vector2, color: Color3, opacity: number)
Draws a filled quad.
Text
void DrawingImmediate.Text(position: Vector2, font: DrawFont, font_size: number, color: Color3, opacity: number, text: string, center: bool)
Draws text.
OutlinedText
void DrawingImmediate.OutlinedText(position: Vector2, font: DrawFont, font_size: number, color: Color3, opacity: number, outline_color: Color3, outline_opacity: number, text: string, center: bool)
Draws outlined text.
GetPaint
SynSignal DrawingImmediate.GetPaint(z_index: int)
Returns an event that is fired every render step for a specific z-index. Lower value z_index
events will fire before higher value events. DrawingImmediate.*
APIs can only be called under these events.