Client

Tip

This is a Static Class named Client. You can access it’s methods directly with :. It is not possible to initialize or create new instances.

Note

This is a Client only Class.

Functions

Returns

Name

Description

DrawDebugLine(Vector Start, Vector End, Color Color = (1, 0, 0), number Duration = 5, number Thickness = 0)

Draws a Debug Line in the World

DrawDebugPoint(Vector Start, Color Color = (1, 0, 0), number Duration = 5, number Thickness = 0)

Draws a Debug Point in the World

DrawDebugSphere(Vector Start, number Radius, number Segments, Color Color = (1, 0, 0), number Duration = 5, number Thickness = 0)

Draws a Debug Line in the World

SendChatMessage(string Message)

Sends a chat message which will display local only

SetChatConfiguration(Vector2D Location = (-25, 0), Vector2D Size = (600, 250), Vector2D AchorsMin = (1, 0.5), Vector2D AchorsMax = (1, 0.5), Vector2D Alignment = (1, 0.5), boolean bJustify = false (false = Left, true = Right))

Configure the Chat. Anchors = (1, 1) means the location will be relative to bottom right and (0, 0) to top left.

SetCrosshairEnabled(boolean)

Enables/Disables the default Crosshair

SetDiscordActivity(string State, string Details, string LargeImage, string LargeText)

Comunicates with Discord and sets a custom user status

SetMouseEnabled(boolean)

Sets mouse enabled and toggles game input

SetOutlineColor(Color OutlineColor)

Changes the Outline Color for interactable stuff. Multiply it by 5 (or more) for having a glowing effect.

SetHighlightColor(Color HighlightColor)

Changes the Highlight Color for highlighted actors. Multiply it by 5 (or more) for having a glowing effect.

Spectate(Player Player)

Spectates a Player. The local camera will follow the Player’s camera.

Unspectate()

Leaves the Spectator’s State.

table

Trace(Vector Start, Vector End, boolean DrawDebug = false)

Trace a ray against the world and returns a table with the first blocking hit information {"Success", "Location", "Normal", "Actor"}. Currently only supports trace for Character, Vehicle and Prop, more can be requested.

Vector2D

GetMousePosition()

Gives the current mouse location

boolean

IsKeyDown(string KeyName)

Returns if a key is being pressed

boolean

IsMouseEnabled()

Events

Name

Parameters

Description

Chat

string Text

Called when a chat text is submitted (by LocalPlayer) - return false to do not send the message

Console

string Text

Called when a console command is submitted

KeyDown

string KeyName

A keyboard key has been pressed / is being pressed

KeyUp

string KeyName

A keyboard key has been released

MouseDown

string KeyName, number MouseX, number MouseY

A mouse button has been pressed / is being pressed

MouseUp

string KeyName, number MouseX, number MouseY

A mouse button has been released

Tick

number DeltaTime

Called Every Frame. Do not abuse.

Examples

Client:on("MouseUp", function(KeyName, MouseX, MouseY)
    if (KeyName == "LeftMouseButton") then
        Package:Log("Left Click pressed at X: " .. MouseX .. ", Y: " .. MouseY)
    end
end)

Available Discord Images

Yeah naming is trash

Name

screenshot_137

screenshot_140

screenshot_141

screenshot_146

screenshot_148

screenshot_152

screenshot_152

screenshot_156

screenshot_157

screenshot_157

screenshot_159

screenshot_159

screenshot_164

screenshot_168

screenshot_173

screenshot_173

screenshot_175

screenshot_191

screenshot_191

screenshot_195