🎨Render

Table to work with render v2.

FilledRect(start: Vec2, end_: Vec2, color: Color, rounding [?]: number, flags [?]: Enum.DrawFlags): nil

Draws a filled rectangle.

Rect(start: Vec2, end_: Vec2, color: Color, rounding [?]: number, flags [?]: Enum.DrawFlags, thickness [?]: number): nil

Draws an unfilled rectangle.

RoundedProgressRect(start: Vec2, end_: Vec2, color: Color, percent: number, rounding: number, thickness [?]: number): nil

Draw a progress rectangle.

Line(start: Vec2, end_: Vec2, color: Color, thickness [?]: number): nil

Draws a line between two points.

PolyLine(points: Vec2[], color: Color, thickness [?]: number): nil

Draws a series of connected lines (polyline).

Circle(pos: Vec2, radius: number, color: Color, thickness [?]: number, startDeg [?]: number, percentage [?]: number, rounded [?]: boolean, segments [?]: integer): nil

Draws a circle.

FilledCircle(pos: Vec2, radius: number, color: Color, startDeg [?]: number, percentage [?]: number, segments [?]: integer): nil

Draws a filled circle.

CircleGradient(pos: Vec2, radius: number, colorOuter: Color, colorInner: Color, startDeg [?]: number, percentage [?]: number): nil

Draws a circle with a gradient.

Triangle(points: Vec2[], color: Color, thickness [?]: number): nil

Draws a triangle outline.

FilledTriangle(points: Vec2[], color: Color): nil

Draws a filled triangle.

TexturedPoly(points: Vertex[], textureHandle: integer, color: Color, grayscale [?]: number): nil

Draws a textured polygon.

LoadFont(fontName: string, fontFlag [?]: Enum.FontCreate|integer, weight [?]: integer): integer

Loads a font and returns its handle. Returns handle to the loaded font.

Text(font: integer, fontSize: number, text: string, pos: Vec2, color: Color): nil

Draws text at a specified position.

WorldToScreen(pos: Vector): Vec2, boolean

Converts a 3D world position to a 2D screen position. Returns A Vec2 representing the 2D screen position and a boolean indicating visibility on the screen.

Example

-- Example: Convert the center of the map (0,0,0) to screen coordinates.
local worldPos = Vector(0.0, 0.0, 0.0)
local screenPos, isVisible = Render.WorldToScreen(worldPos)
if isVisible then
    Log.Write("Screen Position: " .. screenPos.x .. ", " .. screenPos.y)
else
    Log.Write("Position is not visible on the screen")
end

ScreenSize(): Vec2

Retrieves the current screen size, returning it as a Vec2 where x is the width and y is the height of the screen.

TextSize(font: integer, fontSize: number, text: string): Vec2

Calculates the size of the given text using the specified font, returning the size as a Vec2 where x is the width and y is the height of the text.

LoadImage(path: string): integer

Loads an image and returns its handle.

Image(imageHandle: integer, pos: Vec2, size: Vec2, color: Color, rounding [?]: number, flags [?]: Enum.DrawFlags, uvMin [?]: Vec2, uvMax [?]: Vec2, grayscale [?]: number): nil

Draws an image at a specified position and size.

ImageCentered(imageHandle: integer, pos: Vec2, size: Vec2, color: Color, rounding [?]: number, flags [?]: Enum.DrawFlags, uvMin [?]: Vec2, uvMax [?]: Vec2, grayscale [?]: number): nil

Draws an image centered at a specified position and size.

ImageSize(imageHandle: integer): Vec2

Retrieves the size of an image. Returns the size of the image as a Vec2.

OutlineGradient(start: Vec2, end_: Vec2, topLeft: Color, topRight: Color, bottomLeft: Color, bottomRight: Color, rounding [?]: number, flags [?]: Enum.DrawFlags, thickness [?]: number): nil

Draws a outlined gradient rectangle.

Gradient(start: Vec2, end_: Vec2, topLeft: Color, topRight: Color, bottomLeft: Color, bottomRight: Color, rounding [?]: number, flags [?]: Enum.DrawFlags): nil

Draws a filled gradient rectangle.

Shadow(start: Vec2, end_: Vec2, color: Color, thickness: number, obj_rounding [?]: number, flags [?]: Enum.DrawFlags, offset [?]: Vec2): nil

Draws a shadow effect within a specified rectangular area.

ShadowCircle(center: Vec2, radius: number, color: Color, thickness: number, num_segments [?]: integer, flags [?]: Enum.DrawFlags, offset [?]: Vec2): nil

Draws a circle shadow effect.

ShadowConvexPoly(points: Vec[], color: Color, thickness: number, flags [?]: Enum.DrawFlags, offset [?]: Vec2): nil

Draws a shadow convex polygon effect.

ShadowNGon(center: Vec2, radius: number, color: Color, thickness: number, num_segments: integer, flags [?]: Enum.DrawFlags, offset [?]: Vec2): nil

Draws a shadow n-gon (polygon with n sides) effect.

Blur(start: Vec2, end_: Vec2, strength [?]: number, alpha [?]: number, rounding [?]: number, flags [?]: Enum.DrawFlags): nil

Applies a blur effect within a specified rectangular area.

PushClip(start: Vec2, end_: Vec2, intersect [?]: boolean): nil

Begins a new clipping region. Only the rendering within the specified rectangular area will be displayed.

PopClip(): nil

Ends the most recently begun clipping region, restoring the previous clipping region.

StartRotation(angle: number): nil

Begins a new rotation.

StopRotation(): nil

End the rotation.

SetGlobalAlpha(alpha: number): nil

Set the global alpha value for rendering.

ResetGlobalAlpha(): nil

Reset the global alpha value for rendering to 1.0.