Version: latest - a1.73.x ⚖️

⌨️ Client

Static Class present on Client side.

🗿Static Class

This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.

💂Authority

This static class can be accessed only on 🟧 Client side.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

🗿 Static Functions

Returns	Name	Description
	`CopyToClipboard`	Copies a text to Clipboard
	`Disconnect`	Disconnects from the server
table of string	`GetAllValuesKeys`	Gets a list of all values keys
string	`GetConnectedServerIP`	Gets the current connected server IP:Port
float	`GetFrameTime`	Gets the current Frame Time
Player	`GetLocalPlayer`	Gets the local Player
string	`GetMap`	Returns the current Map
float	`GetNearClipPlane`	Gets the Near Clip Plane value
table of table	`GetPackages`	Returns a list of Packages running
integer	`GetTime`	Gets the Unix Epoch Time in milliseconds
any	`GetValue`	Gets a value given a key
boolean	`IsPackageLoaded`	Returns if a Package is currently loaded
	`SetDebugEnabled`	Enables/Disables Debug settings and Client Console to be used
	`SetEscapeMenuText`	Sets the Escape Menu text
	`SetHighlightColor`	Changes the Highlight Color for highlighted actors at a specific Index
	`SetNearClipPlane`	Sets the Near Clip Plane
	`SetOutlineColor`	Changes the Outline Color for outlined actors at a specific Index
	`SetValue`	Sets a global value in the Client, which can be accessed from anywhere (client side)
function	`Subscribe`	Subscribes for an Event
	`Unsubscribe`	Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

`CopyToClipboard`

Copies a text to Clipboard

Client.CopyToClipboard(text)

Type	Parameter	Default	Description
string	`text`	Required parameter	No description provided

`Disconnect`

Disconnects from the server

Client.Disconnect()

`GetAllValuesKeys`

Gets a list of all values keys

— Returns table of string (a list with all values keys).

local ret = Client.GetAllValuesKeys()

`GetConnectedServerIP`

Gets the current connected server IP:Port

— Returns string.

local ret = Client.GetConnectedServerIP()

`GetFrameTime`

Gets the current Frame Time

— Returns float (The Frame Time).

local ret = Client.GetFrameTime()

`GetLocalPlayer`

Gets the local Player

— Returns Player (The local Player).

local ret = Client.GetLocalPlayer()

`GetMap`

Returns the current Map

— Returns string (The current Map).

local ret = Client.GetMap()

`GetNearClipPlane`

Gets the Near Clip Plane value

— Returns float.

local ret = Client.GetNearClipPlane()

`GetPackages`

Returns a list of Packages running

— Returns table of table (a list of Packages data with this format).

local ret = Client.GetPackages(package_type_filter?)

Type	Parameter	Default	Description
PackageType	`package_type_filter?`	`-1`	Which Package type to return. Leave it default (-1) to return all types.

`GetTime`

Gets the Unix Epoch Time in milliseconds

— Returns integer (the unix timestamp).

local ret = Client.GetTime()

`GetValue`

Gets a value given a key

— Returns any (Value at key or fallback if key doesn't exist).

local ret = Client.GetValue(key, fallback)

Type	Parameter	Default	Description
string	`key`	Required parameter	No description provided
any	`fallback`	Required parameter	No description provided

`IsPackageLoaded`

Returns if a Package is currently loaded

— Returns boolean (If the package is loaded).

local ret = Client.IsPackageLoaded(package_name)

Type	Parameter	Default	Description
string	`package_name`	Required parameter	No description provided

`SetDebugEnabled`

Enables/Disables Debug settings and Client Console to be used

Client.SetDebugEnabled(enable_debug)

Type	Parameter	Default	Description
boolean	`enable_debug`	Required parameter	No description provided

`SetEscapeMenuText`

Sets the Escape Menu text

Client.SetEscapeMenuText(text)

Type	Parameter	Default	Description
string	`text`	Required parameter	Supports using `<h1>`, `<h2>`, `<h3>` and `<strong>` tags in the text.

Client.SetEscapeMenuText Examples

`SetHighlightColor`

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

HighlightMode.Always will always be visible, even behind walls
HighlightMode.OnlyHidden will only be visible if behind a wall
HighlightMode.OnlyVisible will only be visible if not behind a wall

Note: You can only have 3 differents indexes (0, 1 or 2).

Client.SetHighlightColor(highlight_color, index, mode?)

Type	Parameter	Default	Description
Color	`highlight_color`	Required parameter	No description provided
integer	`index`	Required parameter	No description provided
HighlightMode	`mode?`	`HighlightMode.Always`	No description provided

`SetNearClipPlane`

Sets the Near Clip Plane

Client.SetNearClipPlane(near_clip_plane)

Type	Parameter	Default	Description
float	`near_clip_plane`	Required parameter	No description provided

`SetOutlineColor`

Changes the Outline Color for outlined actors at a specific Index. Multiply it by 5 (or more) for having a glowing effect.

Note: You can only have 3 differents indexes (0, 1 or 2), and the default Outline color index used by the game is 0 (when interacting with stuff).

Client.SetOutlineColor(outline_color, index?, thickness?)

Type	Parameter	Default	Description
Color	`outline_color`	Required parameter	No description provided
integer	`index?`	`0`	No description provided
float	`thickness?`	`2`	No description provided

`SetValue`

Sets a global value in the Client, which can be accessed from anywhere (client side)

Please refer to Entity Values for more information

Client.SetValue(key, value)

Type	Parameter	Default	Description
string	`key`	Required parameter	No description provided
any	`value`	Required parameter	No description provided

`Subscribe`

Subscribes for an Event

— Returns function (the function callback itself).

local ret = Client.Subscribe(event_name, callback)

Type	Parameter	Default	Description
string	`event_name`	Required parameter	No description provided
function	`callback`	Required parameter	No description provided

`Unsubscribe`

Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Client.Unsubscribe(event_name, callback?)

Type	Parameter	Default	Description
string	`event_name`	Required parameter	No description provided
function	`callback?`	`nil`	No description provided

🚀 Events

	Name	Description
	`SpawnLocalPlayer`	Called when the local player spawns (just after the game has loaded)
	`Tick`	Called Every Frame. Do not abuse
	`WindowFocusChange`	Called when the game is focused/unfocused

`SpawnLocalPlayer`

Called when the local player spawns (just after the game has loaded)

Client.Subscribe("SpawnLocalPlayer", function(local_player)
	-- SpawnLocalPlayer was called
end)

Type	Argument	Description
Player	`local_player`	No description provided

`Tick`

Called Every Frame. Do not abuse

Client.Subscribe("Tick", function(delta_time)
	-- Tick was called
end)

Type	Argument	Description
float	`delta_time`	No description provided

`WindowFocusChange`

Called when the game is focused/unfocused

Client.Subscribe("WindowFocusChange", function(is_focused)
	-- WindowFocusChange was called
end)

Type	Argument	Description
boolean	`is_focused`	If it's focused

🗿 Static Functions​

CopyToClipboard

Disconnect

GetAllValuesKeys

GetConnectedServerIP

GetFrameTime

GetLocalPlayer

GetMap

GetNearClipPlane

GetPackages

GetTime

GetValue

IsPackageLoaded

SetDebugEnabled

SetEscapeMenuText

SetHighlightColor

SetNearClipPlane

SetOutlineColor

SetValue

Subscribe

Unsubscribe

🚀 Events​

SpawnLocalPlayer

Tick

WindowFocusChange