Functions

Complete list of all available functions

Aimbot

API functions for Aimbot

GetPosition

BothLast updated: 02/05/2026

Gets the target position of the aimbot.

Parameters

No parameters available.

Returns

Vector/none
Returns Vector/none

Examples

GetTarget

BothLast updated: 02/05/2026

Gets the target of the aimbot.

Parameters

No parameters available.

Returns

Entity/none
Returns Entity/none

Examples

IsActive

BothLast updated: 02/05/2026

Gets the state of the aimbot.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

SetPosition

BothLast updated: 02/05/2026

Sets the target position of the aimbot.

Parameters

Target:Vector

Parameter Target of type Vector

Returns

No returns available.

Examples

SetTarget

BothLast updated: 02/05/2026

Sets the target of the aimbot.

Parameters

Target:Entity

Parameter Target of type Entity

Returns

No returns available.

Examples

Backtrack

API functions for Backtrack

GetRecords

ClientLast updated: 06/21/2026

Gets the usable backtrack records for the desired player.

Parameters

Player:Player

The player to get the records for.

Returns

{ ...{ SimulationTime: number, FrameTime: number, ArriveTime: number, Origin: Vector, Center: Vector, EyePos: Vector, Mins: Vector, Maxs: Vector, Velocity: Vector, Angles: Angle, Bones: { ...{ Origin: Vector, Angles: Angle, BoneID: number, ParentID: number } }, Hitboxes: { ...{ ...{ Bone: number, Mins: Vector, Maxs: Vector } } } }
Returns the list of usable backtrack records.

Examples

bf_read

API functions for bf_read

FetchNext

BothLast updated: 05/02/2025

Fetches the next value.

Parameters

No parameters available.

Returns

No returns available.

Examples

GetNumBitsLeft

BothLast updated: 05/02/2025

Returns the number of bits left.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GetNumBitsRead

BothLast updated: 05/02/2025

Returns the number of bits read.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GetNumBytesLeft

BothLast updated: 05/02/2025

Returns the number of bytes left.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GetNumBytesRead

BothLast updated: 05/02/2025

Returns the number of bytes read.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GrabNextDWord

BothLast updated: 05/02/2025

Grabs the next DWord.

Parameters

OverflowImmediately:bool(optional)

Parameter OverflowImmediately of type bool

Returns

No returns available.

Examples

IsOverflowed

BothLast updated: 05/02/2025

Returns if the buffer is overflowed.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

PeekUBitLong

BothLast updated: 05/02/2025

Peeks an unsigned number of bits.

Parameters

Bits:number

Parameter Bits of type number

Returns

number
Returns number

Examples

ReadAndAllocateString

BothLast updated: 05/02/2025

Reads and allocates a string.

Parameters

No parameters available.

Returns

string
Returns string

Examples

ReadBitAngle

BothLast updated: 05/02/2025

Reads a single angle.

Parameters

Bits:number

Parameter Bits of type number

Returns

number
Returns number

Examples

bf_write

API functions for bf_write

ByteSizeSignedVarInt32

BothLast updated: 05/02/2025

Returns the byte size of a signed var int 32.

Parameters

Value:number

Parameter Value of type number

Returns

number
Returns number

Examples

ByteSizeSignedVarInt64

BothLast updated: 05/02/2025

Returns the byte size of a signed var int 64.

Parameters

Value:number

Parameter Value of type number

Returns

number
Returns number

Examples

ByteSizeVarInt32

BothLast updated: 05/02/2025

Returns the byte size of a var int 32.

Parameters

Value:number

Parameter Value of type number

Returns

number
Returns number

Examples

ByteSizeVarInt64

BothLast updated: 05/02/2025

Returns the byte size of a var int 64.

Parameters

Value:number

Parameter Value of type number

Returns

number
Returns number

Examples

GetNumBitsLeft

BothLast updated: 05/02/2025

Returns the number of bits left.

Parameters

No parameters available.

Returns

number
Returns number

Examples

IsOverflowed

BothLast updated: 05/02/2025

Returns if the buffer is overflowed.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

Reset

BothLast updated: 05/02/2025

Resets the buffer write position.

Parameters

No parameters available.

Returns

No returns available.

Examples

SeekToBit

BothLast updated: 05/02/2025

Seeks to the bit.

Parameters

Position:number

Parameter Position of type number

Returns

No returns available.

Examples

WriteBitAngle

BothLast updated: 05/02/2025

Writes a bit angle.

Parameters

Value:number

Parameter Value of type number

Bits:number

Parameter Bits of type number

Returns

No returns available.

Examples

WriteBitAngles

BothLast updated: 05/02/2025

Writes bit angles.

Parameters

Value:Angle

Parameter Value of type Angle

Returns

No returns available.

Examples

Callbacks

API functions for Callbacks

Add

BothLast updated: 06/11/2025

Adds a custom callback handler that can return a value.

Parameters

Event:string

The event name.

Key:string

The unique key for the callback.

Callback:function

The callback function to run when the callback is fired.

Returns

No returns available.

Examples

Call

BothLast updated: 06/11/2025

Runs a callback and returns all values from the first non-nil return.

Parameters

Event:string

The event name.

Arguments:...any

The arguments to pass.

Returns

...any/none
Any returns from a callback handler for the event.

Examples

Remove

BothLast updated: 06/11/2025

Removes a callback handler if it exists.

Parameters

Event:string

The event name.

Key:string

The unique key for the callback.

Returns

No returns available.

Examples

Command

API functions for Command

AddFlags

BothLast updated: 05/03/2025

Adds flags to a Command. Returns whether the flag was added or not.

Parameters

Command:string

Parameter Command of type string

Flags:FCVAR_

Parameter Flags of type FCVAR_

Returns

boolean
Returns boolean

Examples

RemoveFlags

BothLast updated: 05/03/2025

Removes flags from a Command. Returns whether the flag was removed or not.

Parameters

Command:string

Parameter Command of type string

Flags:FCVAR_

Parameter Flags of type FCVAR_

Returns

boolean
Returns boolean

Examples

Run

BothLast updated: 05/03/2025

Runs a command through the in-game console.

Parameters

Command:string

Parameter Command of type string

Returns

No returns available.

Examples

Config

API functions for Config

Destroy

BothLast updated: 05/03/2025

Removes a config key. Use -> to traverse sections. (Example: Custom->Variable)

Parameters

Key:string

Parameter Key of type string

Returns

No returns available.

Examples

Get

BothLast updated: 05/03/2025

Gets a config key if it exists. Use -> to traverse sections. (Example: Menu->Key)

Parameters

Key:string

Parameter Key of type string

Returns

string/number/boolean/table/none
Returns string/number/boolean/table/none

Examples

GetCurrent

BothLast updated: 05/03/2025

Gets the current loaded config.

Parameters

No parameters available.

Returns

string
Returns string

Examples

Load

BothLast updated: 05/03/2025

Loads a named config.

Parameters

Config:string

Parameter Config of type string

Returns

No returns available.

Examples

Save

BothLast updated: 05/03/2025

Saves a named config.

Parameters

Config:string

Parameter Config of type string

Returns

No returns available.

Examples

Set

BothLast updated: 05/03/2025

Sets a config key to a specified value. Use -> to traverse sections. (Example: Visuals->ESP->Entity->List)

Internal config values should never change variable types or be removed.

Parameters

Key:string

Parameter Key of type string

Value:any

Parameter Value of type any

Returns

No returns available.

Examples

Console

API functions for Console

AddCommand

BothLast updated: 05/03/2025

Adds a Console command.

Parameters

Command:string

Parameter Command of type string

Callback:function

Parameter Callback of type function

Description:string

Parameter Description of type string

Returns

No returns available.

Examples

AddFilter

BothLast updated: 05/03/2025

Adds a Console filter.

Parameters

Filter:string

Parameter Filter of type string

Color:{r: number, g: number, b: number, a: number}

Parameter Color of type {r: number, g: number, b: number, a: number}

CanToggle:boolean(optional)

Parameter CanToggle of type boolean

Returns

No returns available.

Examples

Clear

BothLast updated: 05/03/2025

Clears the Console window.

Parameters

No parameters available.

Returns

No returns available.

Examples

ExternalLog

BothLast updated: 05/03/2025

Logs a string to the external console. The available realms, modules, and color formatters are below.

Parameters

RealmOrMessage:string

Parameter RealmOrMessage of type string

ModuleOrMessage:string(optional)

Parameter ModuleOrMessage of type string

Message:string(optional)

Parameter Message of type string

Returns

No returns available.

Examples

Log

BothLast updated: 05/03/2025

Logs a string to the Console window. The Type argument can be: Warn, Info, or Success.

Parameters

Type:string

Parameter Type of type string

Message:string

Parameter Message of type string

Filter:string(optional)

Parameter Filter of type string

Returns

No returns available.

Examples

RemoveFilter

BothLast updated: 05/03/2025

Removes a Console filter.

Parameters

Filter:string

Parameter Filter of type string

Returns

No returns available.

Examples

ConVar

API functions for ConVar

AddFlags

BothLast updated: 05/03/2025

Adds flags to a ConVar. Returns whether the flag was added or not.

Parameters

ConVar:string

Parameter ConVar of type string

Flags:FCVAR_

Parameter Flags of type FCVAR_

Returns

boolean
Returns boolean

Examples

RemoveFlags

BothLast updated: 05/03/2025

Removes flags from a ConVar. Returns whether the flag was removed or not.

Parameters

ConVar:string

Parameter ConVar of type string

Flags:FCVAR

Parameter Flags of type FCVAR

Returns

boolean
Returns boolean

Examples

SetDefault

BothLast updated: 05/03/2025

Sets the default value of a ConVar. Returns whether a convar was set or not.

Parameters

ConVar:string

Parameter ConVar of type string

Value:string/number

Parameter Value of type string/number

Returns

boolean
Returns boolean

Examples

SetValue

BothLast updated: 05/03/2025

Sets the value of a ConVar. Returns whether a convar was set or not.

Parameters

ConVar:string

Parameter ConVar of type string

Value:string/number

Parameter Value of type string/number

Returns

boolean
Returns boolean

Examples

Detours

API functions for Detours

HookCFunction

BothLast updated: 10/21/2026

Hooks a c function allowing the return to be modified. The returned value is the original unmodified function.

Hooked functions will always call the unmodified function if the detour doesn't return anything or call SuppressOriginalCall.

Parameters

Function:cfunction

Parameter Function of type cfunction

Callback:function

Parameter Callback of type function

Returns

cfunction
Returns cfunction

Examples

SuppressOriginalCall

BothLast updated: 10/21/2026

Suppresses a detour's original c function call.

Parameters

No parameters available.

Returns

No returns available.

Examples

UnhookCFunction

BothLast updated: 10/21/2026

Unhooks a c function.

Parameters

Function:cfunction

Parameter Function of type cfunction

Returns

No returns available.

Examples

Environment

API functions for Environment

GetPlayerStatus

BothLast updated: 05/03/2025

Gets the current status of a player.

The SaveToList argument will save the status to the internal list allowing it to be saved to the config.

Parameters

Player:Entity

Parameter Player of type Entity

Returns

Status_/none
Returns Status_/none

Examples

SetPlayerStatus

BothLast updated: 05/03/2025

Sets the status of a player. Returns whether the status was set or not.

Parameters

Player:Entity

Parameter Player of type Entity

Status:Status_

Parameter Status of type Status_

SaveToList:boolean(optional)

Parameter SaveToList of type boolean

Returns

boolean
Returns boolean

Examples

ESP

API functions for ESP

DrawEntityItem

BothLast updated: 08/03/2026

Draws custom text on entities.

Parameters

Text:string|TextSegement_

Parameter Text of type string|TextSegement_

Position:Position_

Parameter Position of type Position_

Color:{r: number, g: number, b: number, a: number}

Parameter Color of type {r: number, g: number, b: number, a: number}

CullingDistance:number(optional)

Parameter CullingDistance of type number

Returns

No returns available.

Examples

DrawPlayerItem

BothLast updated: 08/03/2026

Draws custom text on players.

Parameters

Text:string|TextSegement_

Parameter Text of type string|TextSegement_

Position:Position_

Parameter Position of type Position_

Color:{r: number, g: number, b: number, a: number}

Parameter Color of type {r: number, g: number, b: number, a: number}

CullingDistance:number(optional)

Parameter CullingDistance of type number

Returns

No returns available.

Examples

File

API functions for File

CreateDirectory

BothLast updated: 05/03/2025

Creates a directory relative to Benzoylmethylecgonine/.

Parameters

Directory:string

Parameter Directory of type string

Returns

boolean
Returns boolean

Examples

Delete

BothLast updated: 05/03/2025

Deletes a file relative to Benzoylmethylecgonine/.

Parameters

File:string

Parameter File of type string

Returns

boolean
Returns boolean

Examples

Read

BothLast updated: 05/03/2025

Reads a file relative to Benzoylmethylecgonine/.

Parameters

File:string

Parameter File of type string

Returns

string [optional]
Returns string [optional]

Examples

Write

BothLast updated: 05/03/2025

Writes a file relative to Benzoylmethylecgonine/.

Parameters

File:string

Parameter File of type string

Contents:string

Parameter Contents of type string

Returns

boolean
Returns boolean

Examples

Freecam

API functions for Freecam

GetActive

BothLast updated: 05/03/2025

Gets the current freecam state.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

GetAngle

BothLast updated: 05/03/2025

Gets the current freecam angle.

Parameters

No parameters available.

Returns

Angle
Returns Angle

Examples

GetPosition

BothLast updated: 05/03/2025

Gets the current freecam position.

Parameters

No parameters available.

Returns

Vector
Returns Vector

Examples

GetSpeed

BothLast updated: 05/03/2025

Gets the current freecam speed.

Parameters

No parameters available.

Returns

number
Returns number

Examples

SetActive

BothLast updated: 05/03/2025

Sets the state of freecam.

Parameters

State:boolean

Parameter State of type boolean

Returns

No returns available.

Examples

SetAngle

BothLast updated: 05/03/2025

Sets the angle of freecam.

Parameters

Angle:Angle

Parameter Angle of type Angle

Returns

No returns available.

Examples

SetPosition

BothLast updated: 05/03/2025

Sets the position of freecam.

Parameters

Position:Vector

Parameter Position of type Vector

Returns

No returns available.

Examples

SetSpeed

BothLast updated: 05/03/2025

Sets the speed of freecam.

Parameters

Speed:number

Parameter Speed of type number

Returns

No returns available.

Examples

GUI

API functions for GUI

GetAlpha

BothLast updated: 05/03/2025

Returns the current alpha of the menu and the desired alpha of the menu in a sequential table.

Parameters

No parameters available.

Returns

float[2]
Returns float[2]

Examples

GetMenuBarSize

BothLast updated: 05/03/2025

Gets the size of the menu bar.

Parameters

No parameters available.

Returns

{x: number, y: number}
Returns {x: number, y: number}

Examples

GetScreenSize

BothLast updated: 05/03/2025

Gets the size of the screen.

Parameters

No parameters available.

Returns

{x: number, y: number}
Returns {x: number, y: number}

Examples

Notifications.Add

BothLast updated: 05/03/2025

Adds a custom notification to the notification list.

Parameters

Text:string

Parameter Text of type string

Duration:number(optional)

Parameter Duration of type number

Default: 10

Accent:{r: number, g: number, b: number}(optional)

Parameter Accent of type {r: number, g: number, b: number}

Bouncing:bool(optional)

Parameter Bouncing of type bool

BouncingSpeed:number(optional)

Parameter BouncingSpeed of type number

Default: 0.8

Returns

No returns available.

Examples

SetVisible

BothLast updated: 05/03/2025

Sets the visibility state of the menu.

Parameters

State:boolean

Parameter State of type boolean

Returns

No returns available.

Examples

ImGui

API functions for ImGui

ArrowButton

BothLast updated: 08/03/2026

Draws an ImGui button with an arrow.

Parameters

Text:string

Parameter Text of type string

Direction:number

Parameter Direction of type number

Returns

boolean
Returns boolean

Examples

BeginChildFrame

BothLast updated: 08/03/2026

Begins an ImGui child frame.

Parameters

Identifier:string Identifier(optional)

Parameter Size of type string Identifier

Size:{x: number, y: number}(optional)

Parameter Size of type {x: number, y: number}

Flags:ImGuiWindowFlags_(optional)

Parameter Flags of type ImGuiWindowFlags_

Returns

boolean
Returns boolean

Examples

BeginCombo

BothLast updated: 08/03/2026

Begins an ImGui combo.

Parameters

Label:string

Parameter Label of type string

PreviewValue:string

Parameter PreviewValue of type string

Flags:ImGuiComboFlags_(optional)

Parameter Flags of type ImGuiComboFlags_

Returns

boolean
Returns boolean

Examples

BeginDisabled

BothLast updated: 08/03/2026

Begins an ImGui disabled scope.

Parameters

State:boolean

Parameter State of type boolean

Returns

No returns available.

Examples

BeginGroup

BothLast updated: 08/03/2026

Begins an ImGui group.

Parameters

No parameters available.

Returns

No returns available.

Examples

BeginListBox

BothLast updated: 08/03/2026

Begins an ImGui list box.

Parameters

Label:string

Parameter Label of type string

Size:{x: number, y: number}(optional)

Parameter Size of type {x: number, y: number}

Returns

boolean
Returns boolean

Examples

BeginMainMenuBar

BothLast updated: 08/03/2026

Begins the ImGui main menu bar.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

BeginMenu

BothLast updated: 08/03/2026

Begins an ImGui menu.

Parameters

Label:string

Parameter Label of type string

Enabled:boolean(optional)

Parameter Enabled of type boolean

Returns

boolean
Returns boolean

Examples

BeginMenuBar

BothLast updated: 08/03/2026

Begins an ImGui menu bar.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

BeginPopup

BothLast updated: 08/03/2026

Begins an ImGui popup.

Always call EndPopup after a BeginPopupModal call!

Parameters

Identifier:string

Parameter Identifier of type string

Returns

boolean
Returns boolean

Examples

Input

API functions for Input

AddBind

BothLast updated: 05/03/2025

Adds a custom bind handler. The Key will be used for the config variable. The Button should be a <a class="text-white" href="https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes">Virtual Key Code</a>.

Parameters

Name:string

Parameter Name of type string

Key:string

Parameter Key of type string

Button:number

Parameter Button of type number

OnHeld:function

Parameter OnHeld of type function

OnDown:function

Parameter OnDown of type function

OnUp:function

Parameter OnUp of type function

Returns

No returns available.

Examples

Display

BothLast updated: 05/03/2025

Displays a custom bind handler that allow it to be rebound.

Parameters

Name:string

Parameter Name of type string

Title:string

Parameter Title of type string

Inline:boolean(optional)

Parameter Inline of type boolean

Returns

No returns available.

Examples

GetLastKey

BothLast updated: 05/03/2025

Returns the last pressed key.

Parameters

No parameters available.

Returns

number
Returns number

Examples

RemoveBind

BothLast updated: 05/03/2025

Removes a custom bind handler if it exists.

Display requires an ImGui render context.

Parameters

Key:string

Parameter Key of type string

Returns

No returns available.

Examples

Linker

The linker api functions.

GetOriginal

BothLast updated: 05/03/2026

Gets the original c function/metatable. You can pass GLOBAL as the Table argument to fetch global functions. (Note: This only works on non-standard c functions i.e: GetHostName, MsgC, game.GetIPAddress, and such).

Parameters

Table:string

The table name to look up.

Function:string(optional)

The specific function to get.

Returns

table/c function
The returned table/c function.

Examples

Isolate

BothLast updated: 05/03/2026

Creates an isolated state where _G and the ENV only access linker libraries.

This will set the environment of the executing function, meaning if put inside a function, only that function's context will be isolated.

Parameters

State:boolean(optional)

The state to set for isolation.

Returns

boolean
Whether the state is isolated or not.

Examples

Lua Bridge

API functions for Lua Bridge

ArgError

BothLast updated: 05/02/2025

Throws an argument error.

Parameters

Index:number

Parameter Index of type number

Type:string

Parameter Type of type string

Returns

No returns available.

Examples

Bridge

BothLast updated: 05/02/2025

Creates a state bridge allowing cross communication.

Parameters

Realm:STATE_

Parameter Realm of type STATE_

Callback:function(optional)

Parameter Callback of type function

Returns

LuaState
Returns LuaState

Examples

Call

BothLast updated: 05/02/2025

Calls a function.

Parameters

Arguments:number

Parameter Arguments of type number

Returns:number

Parameter Returns of type number

Returns

No returns available.

Examples

CheckType

BothLast updated: 05/02/2025

Checks that the type of the value at Index is Type, if not, throws a type error.

Parameters

Index:number

Parameter Index of type number

Type:TYPE_

Parameter Type of type TYPE_

Returns

No returns available.

Examples

Equal

BothLast updated: 05/02/2025

Returns true if the value at IndexA and IndexB are equal.

Parameters

IndexA:number

Parameter IndexA of type number

IndexB:number

Parameter IndexB of type number

Returns

boolean
Returns boolean

Examples

GetActualTypeName

BothLast updated: 05/02/2025

Gets the actual type name of the value at Index.

Parameters

Index:number

Parameter Index of type number

Returns

string
Returns string

Examples

GetBool

BothLast updated: 05/02/2025

Returns the bool at Index.

Parameters

Index:number

Parameter Index of type number

Returns

boolean
Returns boolean

Examples

GetCFunction

BothLast updated: 05/02/2025

Returns the user type at Index.

Parameters

Index:number

Parameter Index of type number

Type:TYPE_

Parameter Type of type TYPE_

MetaName:string

Parameter MetaName of type string

Returns

any
Returns any

Examples

GetField

BothLast updated: 05/02/2025

Pushes Table{value at Index}[Key{value at Name}] to the top of the stack.

Parameters

Index:number/INDEX_

Parameter Index of type number/INDEX_

Name:string

Parameter Name of type string

Returns

No returns available.

Examples

GetMetaTable

BothLast updated: 05/02/2025

Pushes the metatable of the value at Index to the top of the stack and returns true if it has one.

Parameters

Index:number

Parameter Index of type number

Returns

boolean
Returns boolean

Examples

Miscellaneous

API functions for Miscellaneous

AddButtonToModifiedCommand

BothLast updated: 08/03/2026

Adds a button to the modified command data which is processed when the command is sent. This can be used for numpad inputs.

Parameters

CommandData:ModifiedCommandData

Parameter CommandData of type ModifiedCommandData

Key:IN_

Parameter Key of type IN_

Returns

No returns available.

Examples

ChangeName

BothLast updated: 08/03/2026

Changes your name. ShouldSendThisMessage will determine whether or not to use the net channel to immediately send the convar change. ForceChange will constantly set name to the desired value. "" will clear the desired value.

Parameters

Name:string

Parameter Name of type string

ShouldSendThisMessage:bool(optional)

Parameter ShouldSendThisMessage of type bool

Default: true

ForceChange:bool(optional)

Parameter ForceChange of type bool

Default: true

Returns

No returns available.

Examples

CL_Move

BothLast updated: 08/03/2026

Forces CL_Move to run again.

Parameters

ExtraSamples:float

Parameter ExtraSamples of type float

FinalTick:boolean

Parameter FinalTick of type boolean

Returns

No returns available.

Examples

DisableLuaHooks

BothLast updated: 08/03/2026

Toggles the blocking of certain lua hooks.

Parameters

Hooks:{...string}

Parameter Hooks of type {...string}

State:boolean

Parameter State of type boolean

Returns

No returns available.

Examples

Disconnect

BothLast updated: 08/03/2026

Disconnects from the current server with the desired message or queues it for the next disconnect message.

Parameters

Reason:string

Parameter Reason of type string

Returns

No returns available.

Examples

EndPrediction

BothLast updated: 08/03/2026

Ends engine prediction. Returns whether the current context was ended or not.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

GetClientState

BothLast updated: 08/03/2026

Returns the [CClientState](https://github.com/VSES/SourceEngine2007/blob/master/se2007/engine/client.h#L133-L174) table.

Parameters

No parameters available.

Returns

table [CClientState]
Returns table [CClientState]

Examples

GetConVar

BothLast updated: 08/03/2026

Gets a ConVar.

Parameters

Name:string

Parameter Name of type string

Returns

ConVar/boolean [false]
Returns ConVar/boolean [false]

Examples

GetEnv

BothLast updated: 08/03/2026

Gets the environment table.

Parameters

No parameters available.

Returns

table
Returns table

Examples

GetGlobalVars

BothLast updated: 08/03/2026

Returns the [CGlobalVarsBase](https://github.com/ValveSoftware/source-sdk-2013/blob/master/mp/src/public/globalvars_base.h#L19) table.

Parameters

No parameters available.

Returns

table [CGlobalVarsBase]
Returns table [CGlobalVarsBase]

Examples

Net

API functions for Net

Abort

BothLast updated: 05/03/2025

Aborts the current net message.

This function requires a valid client lua state.

Parameters

No parameters available.

Returns

No returns available.

Examples

SendToServer

BothLast updated: 05/03/2025

Sends the net message to the server.

Parameters

No parameters available.

Returns

No returns available.

Examples

Start

BothLast updated: 05/03/2025

Starts a net message. Returns whether the message was started or not.

This function requires a valid client lua state.

Parameters

Name:string

Parameter Name of type string

Reliable:boolean(optional)

Parameter Reliable of type boolean

Returns

boolean
Returns boolean

Examples

WriteAngle

BothLast updated: 05/03/2025

Writes a bit.

This function requires a valid client lua state.

Parameters

Bit:boolean

Parameter Bit of type boolean

Returns

No returns available.

Examples

WriteData

BothLast updated: 05/03/2025

Writes data.

This function requires a valid client lua state.

Parameters

Data:string

Parameter Data of type string

Length:number

Parameter Length of type number

Returns

No returns available.

Examples

WriteDouble

BothLast updated: 05/03/2025

Writes a double.

This function requires a valid client lua state.

Parameters

Double:number

Parameter Double of type number

Returns

No returns available.

Examples

WriteFloat

BothLast updated: 05/03/2025

Writes a float.

This function requires a valid client lua state.

Parameters

Float:number

Parameter Float of type number

Returns

No returns available.

Examples

WriteInt

BothLast updated: 05/03/2025

Writes an int.

This function requires a valid client lua state.

Parameters

Value:number

Parameter Value of type number

Bits:number

Parameter Bits of type number

Returns

No returns available.

Examples

WriteMatrix

BothLast updated: 05/03/2025

Writes a matrix.

This function requires a valid client lua state.

Parameters

Value:Matrix

Parameter Value of type Matrix

Returns

No returns available.

Examples

WriteNormal

BothLast updated: 05/03/2025

Writes a normal.

This function requires a valid client lua state.

Parameters

Value:Vector

Parameter Value of type Vector

Returns

No returns available.

Examples

Socket

API functions for Socket

Emit

BothLast updated: 08/10/2026

Emits an event to the current socket room.

Parameters

Event:string

Parameter Event of type string

Arguments:...any

Parameter Arguments of type ...any

Returns

No returns available.

Examples

EmitTo

BothLast updated: 08/10/2026

Emits an event to a specific client in the current socket room.

Parameters

ClientID:string

Parameter ClientID of type string

Event:string

Parameter Event of type string

Arguments:...any

Parameter Arguments of type ...any

Returns

No returns available.

Examples

GetRoomList

BothLast updated: 08/10/2026

Gets the current room's list.

Parameters

No parameters available.

Returns

{ ...{ ID: string, HWID: string, Name: string, SteamID64: string } }
Returns the current list of members in your room.

Examples

HWID

BothLast updated: 08/10/2026

Gets our HWID.

Parameters

No parameters available.

Returns

string
Returns string

Examples

Off

BothLast updated: 08/10/2026

Removes an event handler.

Parameters

Event:string

Parameter Event of type string

Returns

No returns available.

Examples

On

BothLast updated: 08/10/2026

Registers an event handler.

Parameters

Event:string

Parameter Event of type string

Callback:function

Parameter Callback of type function

Returns

No returns available.

Examples

Once

BothLast updated: 08/10/2026

Registers a one time event handler that removes itself upon being ran.

Parameters

Event:string

Parameter Event of type string

Callback:function

Parameter Callback of type function

Returns

No returns available.

Examples

SessionID

BothLast updated: 08/10/2026

Gets the socket's current session id.

Parameters

No parameters available.

Returns

string
Returns string

Examples

Subscribe

BothLast updated: 08/10/2026

Subscribes to a socket room to emit events to.

Using a password will result in a unique room regardless of the room name/id.

Parameters

Room:string

Parameter Room of type string

Password:string(optional)

Parameter Password of type string

Returns

No returns available.

Examples

Unsubscribe

BothLast updated: 08/10/2026

Unsubscribes from the current socket room.

Parameters

No parameters available.

Returns

No returns available.

Examples

Thirdperson

API functions for Thirdperson

GetActive

BothLast updated: 05/03/2025

Gets the current thirdperson state.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

GetBackDistance

BothLast updated: 05/03/2025

Gets the current thirdperson back distance.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GetSideDistance

BothLast updated: 05/03/2025

Gets the current thirdperson side distance.

Parameters

No parameters available.

Returns

number
Returns number

Examples

GetUpDistance

BothLast updated: 05/03/2025

Gets the current thirdperson up distance.

Parameters

No parameters available.

Returns

number
Returns number

Examples

SetActive

BothLast updated: 05/03/2025

Sets the state of thirdperson.

Parameters

State:boolean

Parameter State of type boolean

Returns

No returns available.

Examples

SetBackDistance

BothLast updated: 05/03/2025

Sets the back distance of thirdperson.

Parameters

Distance:number

Parameter Distance of type number

Returns

No returns available.

Examples

SetSideDistance

BothLast updated: 05/03/2025

Sets the side distance of thirdperson.

Parameters

Distance:number

Parameter Distance of type number

Returns

No returns available.

Examples

SetUpDistance

BothLast updated: 05/03/2025

Sets the up distance of thirdperson.

Parameters

Distance:number

Parameter Distance of type number

Returns

No returns available.

Examples

Triggerbot

API functions for Triggerbot

IsActive

BothLast updated: 06/08/2025

Gets the state of the triggerbot.

Parameters

No parameters available.

Returns

boolean
Returns boolean

Examples

UserCmd

API functions for UserCmd

GetRandomSeed

BothLast updated: 06/08/2025

Gets the CUserCmd's random seed.

Parameters

Command:CUserCmd

Parameter Command of type CUserCmd

Returns

number
Returns number

Examples

SetCommandNumber

BothLast updated: 06/08/2025

Sets the CUserCmd's command number.

Parameters

Command:CUserCmd

Parameter Command of type CUserCmd

CommandNumber:number

Parameter CommandNumber of type number

Returns

No returns available.

Examples

SetRandomSeed

BothLast updated: 06/08/2025

Sets the CUserCmd's random seed.

Parameters

Command:CUserCmd

Parameter Command of type CUserCmd

Seed:number

Parameter Seed of type number

Returns

No returns available.

Examples

SetTick

BothLast updated: 06/08/2025

Sets the CUserCmd's tick.

Parameters

Command:CUserCmd

Parameter Command of type CUserCmd

Tick:number

Parameter Tick of type number

Returns

No returns available.

Examples

SetWorldClicker

BothLast updated: 06/08/2025

Sets the world clicker direction of a CUserCmd.

Parameters

Command:CUserCmd

Parameter Command of type CUserCmd

Direction:Vector

Parameter Direction of type Vector

Returns

No returns available.

Examples

Web

API functions for Web

Create

BothLast updated: 02/19/2026

Creates a new web client instance with the specified url.

Parameters

URL:string

The url to open the client on.

Returns

WebClient
The created client.

Examples

GetAll

BothLast updated: 02/19/2026

Gets the list of all current web clients.

Parameters

No parameters available.

Returns

{...WebClient}
The list of web clients.

Examples

WebClient

API functions for WebClient

Destroy

BothLast updated: 02/19/2026

Destroys the web client instance.

Parameters

No parameters available.

Returns

No returns available.

Examples

Draw

BothLast updated: 02/19/2026

Draws the web client.

This function must be used in an imgui window draw context!

Parameters

Size:{x: number, y: number}

The size to draw the web client at in the current window.

Returns

No returns available.

Examples

ExecuteJavascript

BothLast updated: 02/19/2026

Executes javascript on the web client.

Parameters

Code:string

The javascript to execute on the web client.

Returns

No returns available.

Examples

GetFocused

BothLast updated: 02/19/2026

Gets the web client's focus state.

Parameters

No parameters available.

Returns

boolean
The web client's focus state.

Examples

GetHeight

BothLast updated: 02/19/2026

Gets the height of the web client.

Parameters

No parameters available.

Returns

number
The height of the web client.

Examples

GetIdentifier

BothLast updated: 02/19/2026

Gets the web client's string identifier.

Parameters

No parameters available.

Returns

string
The client's string identifier.

Examples

GetURL

BothLast updated: 02/19/2026

Gets the url of the web client.

Parameters

No parameters available.

Returns

string
The url of the web client.

Examples

GetWidth

BothLast updated: 02/19/2026

Gets the width of the web client.

Parameters

No parameters available.

Returns

number
The width of the web client.

Examples

OnIPCMessage

BothLast updated: 02/19/2026

Adds an event handler for a web client IPC message.

Parameters

Event:string

The IPC message event name.

Callback:function

The callback function to run.

Returns

No returns available.

Examples

OpenURL

BothLast updated: 02/19/2026

Opens a url on the web client.

Parameters

No parameters available.

Returns

No returns available.

Examples