Functions
Complete list of all available functions
Aimbot
API functions for Aimbot
GetPosition
BothLast updated: 02/05/2026Gets the target position of the aimbot.
Parameters
Returns
Vector/noneExamples
GetTarget
BothLast updated: 02/05/2026Gets the target of the aimbot.
Parameters
Returns
Entity/noneExamples
IsActive
BothLast updated: 02/05/2026Gets the state of the aimbot.
Parameters
Returns
booleanExamples
SetPosition
BothLast updated: 02/05/2026Sets the target position of the aimbot.
Parameters
Target:VectorParameter Target of type Vector
Returns
Examples
SetTarget
BothLast updated: 02/05/2026Sets the target of the aimbot.
Parameters
Target:EntityParameter Target of type Entity
Returns
Examples
Backtrack
API functions for Backtrack
GetRecords
ClientLast updated: 06/21/2026Gets the usable backtrack records for the desired player.
Parameters
Player:PlayerThe 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 } } } }Examples
bf_read
API functions for bf_read
FetchNext
BothLast updated: 05/02/2025Fetches the next value.
Parameters
Returns
Examples
GetNumBitsLeft
BothLast updated: 05/02/2025Returns the number of bits left.
Parameters
Returns
numberExamples
GetNumBitsRead
BothLast updated: 05/02/2025Returns the number of bits read.
Parameters
Returns
numberExamples
GetNumBytesLeft
BothLast updated: 05/02/2025Returns the number of bytes left.
Parameters
Returns
numberExamples
GetNumBytesRead
BothLast updated: 05/02/2025Returns the number of bytes read.
Parameters
Returns
numberExamples
GrabNextDWord
BothLast updated: 05/02/2025Grabs the next DWord.
Parameters
OverflowImmediately:bool(optional)Parameter OverflowImmediately of type bool
Returns
Examples
IsOverflowed
BothLast updated: 05/02/2025Returns if the buffer is overflowed.
Parameters
Returns
booleanExamples
PeekUBitLong
BothLast updated: 05/02/2025Peeks an unsigned number of bits.
Parameters
Bits:numberParameter Bits of type number
Returns
numberExamples
ReadAndAllocateString
BothLast updated: 05/02/2025Reads and allocates a string.
Parameters
Returns
stringExamples
ReadBitAngle
BothLast updated: 05/02/2025Reads a single angle.
Parameters
Bits:numberParameter Bits of type number
Returns
numberExamples
bf_write
API functions for bf_write
ByteSizeSignedVarInt32
BothLast updated: 05/02/2025Returns the byte size of a signed var int 32.
Parameters
Value:numberParameter Value of type number
Returns
numberExamples
ByteSizeSignedVarInt64
BothLast updated: 05/02/2025Returns the byte size of a signed var int 64.
Parameters
Value:numberParameter Value of type number
Returns
numberExamples
ByteSizeVarInt32
BothLast updated: 05/02/2025Returns the byte size of a var int 32.
Parameters
Value:numberParameter Value of type number
Returns
numberExamples
ByteSizeVarInt64
BothLast updated: 05/02/2025Returns the byte size of a var int 64.
Parameters
Value:numberParameter Value of type number
Returns
numberExamples
GetNumBitsLeft
BothLast updated: 05/02/2025Returns the number of bits left.
Parameters
Returns
numberExamples
IsOverflowed
BothLast updated: 05/02/2025Returns if the buffer is overflowed.
Parameters
Returns
booleanExamples
Reset
BothLast updated: 05/02/2025Resets the buffer write position.
Parameters
Returns
Examples
SeekToBit
BothLast updated: 05/02/2025Seeks to the bit.
Parameters
Position:numberParameter Position of type number
Returns
Examples
WriteBitAngle
BothLast updated: 05/02/2025Writes a bit angle.
Parameters
Value:numberParameter Value of type number
Bits:numberParameter Bits of type number
Returns
Examples
WriteBitAngles
BothLast updated: 05/02/2025Writes bit angles.
Parameters
Value:AngleParameter Value of type Angle
Returns
Examples
Callbacks
API functions for Callbacks
Add
BothLast updated: 06/11/2025Adds a custom callback handler that can return a value.
Parameters
Event:stringThe event name.
Key:stringThe unique key for the callback.
Callback:functionThe callback function to run when the callback is fired.
Returns
Examples
Call
BothLast updated: 06/11/2025Runs a callback and returns all values from the first non-nil return.
Parameters
Event:stringThe event name.
Arguments:...anyThe arguments to pass.
Returns
...any/noneExamples
Remove
BothLast updated: 06/11/2025Removes a callback handler if it exists.
Parameters
Event:stringThe event name.
Key:stringThe unique key for the callback.
Returns
Examples
Command
API functions for Command
AddFlags
BothLast updated: 05/03/2025Adds flags to a Command. Returns whether the flag was added or not.
Parameters
Command:stringParameter Command of type string
Flags:FCVAR_Parameter Flags of type FCVAR_
Returns
booleanExamples
RemoveFlags
BothLast updated: 05/03/2025Removes flags from a Command. Returns whether the flag was removed or not.
Parameters
Command:stringParameter Command of type string
Flags:FCVAR_Parameter Flags of type FCVAR_
Returns
booleanExamples
Run
BothLast updated: 05/03/2025Runs a command through the in-game console.
Parameters
Command:stringParameter Command of type string
Returns
Examples
Config
API functions for Config
Destroy
BothLast updated: 05/03/2025Removes a config key. Use -> to traverse sections. (Example: Custom->Variable)
Parameters
Key:stringParameter Key of type string
Returns
Examples
Get
BothLast updated: 05/03/2025Gets a config key if it exists. Use -> to traverse sections. (Example: Menu->Key)
Parameters
Key:stringParameter Key of type string
Returns
string/number/boolean/table/noneExamples
GetCurrent
BothLast updated: 05/03/2025Gets the current loaded config.
Parameters
Returns
stringExamples
Load
BothLast updated: 05/03/2025Loads a named config.
Parameters
Config:stringParameter Config of type string
Returns
Examples
Save
BothLast updated: 05/03/2025Saves a named config.
Parameters
Config:stringParameter Config of type string
Returns
Examples
Set
BothLast updated: 05/03/2025Sets a config key to a specified value. Use -> to traverse sections. (Example: Visuals->ESP->Entity->List)
Parameters
Key:stringParameter Key of type string
Value:anyParameter Value of type any
Returns
Examples
Console
API functions for Console
AddCommand
BothLast updated: 05/03/2025Adds a Console command.
Parameters
Command:stringParameter Command of type string
Callback:functionParameter Callback of type function
Description:stringParameter Description of type string
Returns
Examples
AddFilter
BothLast updated: 05/03/2025Adds a Console filter.
Parameters
Filter:stringParameter 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
Examples
Clear
BothLast updated: 05/03/2025Clears the Console window.
Parameters
Returns
Examples
ExternalLog
BothLast updated: 05/03/2025Logs a string to the external console. The available realms, modules, and color formatters are below.
Parameters
RealmOrMessage:stringParameter RealmOrMessage of type string
ModuleOrMessage:string(optional)Parameter ModuleOrMessage of type string
Message:string(optional)Parameter Message of type string
Returns
Examples
Log
BothLast updated: 05/03/2025Logs a string to the Console window. The Type argument can be: Warn, Info, or Success.
Parameters
Type:stringParameter Type of type string
Message:stringParameter Message of type string
Filter:string(optional)Parameter Filter of type string
Returns
Examples
RemoveFilter
BothLast updated: 05/03/2025Removes a Console filter.
Parameters
Filter:stringParameter Filter of type string
Returns
Examples
ConVar
API functions for ConVar
AddFlags
BothLast updated: 05/03/2025Adds flags to a ConVar. Returns whether the flag was added or not.
Parameters
ConVar:stringParameter ConVar of type string
Flags:FCVAR_Parameter Flags of type FCVAR_
Returns
booleanExamples
RemoveFlags
BothLast updated: 05/03/2025Removes flags from a ConVar. Returns whether the flag was removed or not.
Parameters
ConVar:stringParameter ConVar of type string
Flags:FCVARParameter Flags of type FCVAR
Returns
booleanExamples
SetDefault
BothLast updated: 05/03/2025Sets the default value of a ConVar. Returns whether a convar was set or not.
Parameters
ConVar:stringParameter ConVar of type string
Value:string/numberParameter Value of type string/number
Returns
booleanExamples
SetValue
BothLast updated: 05/03/2025Sets the value of a ConVar. Returns whether a convar was set or not.
Parameters
ConVar:stringParameter ConVar of type string
Value:string/numberParameter Value of type string/number
Returns
booleanExamples
Detours
API functions for Detours
HookCFunction
BothLast updated: 10/21/2026Hooks 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:cfunctionParameter Function of type cfunction
Callback:functionParameter Callback of type function
Returns
cfunctionExamples
SuppressOriginalCall
BothLast updated: 10/21/2026Suppresses a detour's original c function call.
Parameters
Returns
Examples
UnhookCFunction
BothLast updated: 10/21/2026Unhooks a c function.
Parameters
Function:cfunctionParameter Function of type cfunction
Returns
Examples
Environment
API functions for Environment
GetPlayerStatus
BothLast updated: 05/03/2025Gets the current status of a player.
SaveToList argument will save the status to the internal list allowing it to be saved to the config.Parameters
Player:EntityParameter Player of type Entity
Returns
Status_/noneExamples
SetPlayerStatus
BothLast updated: 05/03/2025Sets the status of a player. Returns whether the status was set or not.
Parameters
Player:EntityParameter Player of type Entity
Status:Status_Parameter Status of type Status_
SaveToList:boolean(optional)Parameter SaveToList of type boolean
Returns
booleanExamples
ESP
API functions for ESP
DrawEntityItem
BothLast updated: 08/03/2026Draws 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
Examples
DrawPlayerItem
BothLast updated: 08/03/2026Draws 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
Examples
File
API functions for File
CreateDirectory
BothLast updated: 05/03/2025Creates a directory relative to Benzoylmethylecgonine/.
Parameters
Directory:stringParameter Directory of type string
Returns
booleanExamples
Delete
BothLast updated: 05/03/2025Deletes a file relative to Benzoylmethylecgonine/.
Parameters
File:stringParameter File of type string
Returns
booleanExamples
Read
BothLast updated: 05/03/2025Reads a file relative to Benzoylmethylecgonine/.
Parameters
File:stringParameter File of type string
Returns
string [optional]Examples
Write
BothLast updated: 05/03/2025Writes a file relative to Benzoylmethylecgonine/.
Parameters
File:stringParameter File of type string
Contents:stringParameter Contents of type string
Returns
booleanExamples
Freecam
API functions for Freecam
GetActive
BothLast updated: 05/03/2025Gets the current freecam state.
Parameters
Returns
booleanExamples
GetAngle
BothLast updated: 05/03/2025Gets the current freecam angle.
Parameters
Returns
AngleExamples
GetPosition
BothLast updated: 05/03/2025Gets the current freecam position.
Parameters
Returns
VectorExamples
GetSpeed
BothLast updated: 05/03/2025Gets the current freecam speed.
Parameters
Returns
numberExamples
SetActive
BothLast updated: 05/03/2025Sets the state of freecam.
Parameters
State:booleanParameter State of type boolean
Returns
Examples
SetAngle
BothLast updated: 05/03/2025Sets the angle of freecam.
Parameters
Angle:AngleParameter Angle of type Angle
Returns
Examples
SetPosition
BothLast updated: 05/03/2025Sets the position of freecam.
Parameters
Position:VectorParameter Position of type Vector
Returns
Examples
SetSpeed
BothLast updated: 05/03/2025Sets the speed of freecam.
Parameters
Speed:numberParameter Speed of type number
Returns
Examples
GUI
API functions for GUI
GetAlpha
BothLast updated: 05/03/2025Returns the current alpha of the menu and the desired alpha of the menu in a sequential table.
Parameters
Returns
float[2]Examples
GetMenuBarSize
BothLast updated: 05/03/2025Gets the size of the menu bar.
Parameters
Returns
{x: number, y: number}Examples
GetScreenSize
BothLast updated: 05/03/2025Gets the size of the screen.
Parameters
Returns
{x: number, y: number}Examples
Notifications.Add
BothLast updated: 05/03/2025Adds a custom notification to the notification list.
Parameters
Text:stringParameter 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
Examples
SetVisible
BothLast updated: 05/03/2025Sets the visibility state of the menu.
Parameters
State:booleanParameter State of type boolean
Returns
Examples
ImGui
API functions for ImGui
ArrowButton
BothLast updated: 08/03/2026Draws an ImGui button with an arrow.
Parameters
Text:stringParameter Text of type string
Direction:numberParameter Direction of type number
Returns
booleanExamples
BeginChildFrame
BothLast updated: 08/03/2026Begins 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
booleanExamples
BeginCombo
BothLast updated: 08/03/2026Begins an ImGui combo.
Parameters
Label:stringParameter Label of type string
PreviewValue:stringParameter PreviewValue of type string
Flags:ImGuiComboFlags_(optional)Parameter Flags of type ImGuiComboFlags_
Returns
booleanExamples
BeginDisabled
BothLast updated: 08/03/2026Begins an ImGui disabled scope.
Parameters
State:booleanParameter State of type boolean
Returns
Examples
BeginGroup
BothLast updated: 08/03/2026Begins an ImGui group.
Parameters
Returns
Examples
BeginListBox
BothLast updated: 08/03/2026Begins an ImGui list box.
Parameters
Label:stringParameter Label of type string
Size:{x: number, y: number}(optional)Parameter Size of type {x: number, y: number}
Returns
booleanExamples
BeginMainMenuBar
BothLast updated: 08/03/2026Begins the ImGui main menu bar.
Parameters
Returns
booleanExamples
BeginMenu
BothLast updated: 08/03/2026Begins an ImGui menu.
Parameters
Label:stringParameter Label of type string
Enabled:boolean(optional)Parameter Enabled of type boolean
Returns
booleanExamples
BeginMenuBar
BothLast updated: 08/03/2026Begins an ImGui menu bar.
Parameters
Returns
booleanExamples
BeginPopup
BothLast updated: 08/03/2026Begins an ImGui popup.
EndPopup after a BeginPopupModal call!Parameters
Identifier:stringParameter Identifier of type string
Returns
booleanExamples
Input
API functions for Input
AddBind
BothLast updated: 05/03/2025Adds 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:stringParameter Name of type string
Key:stringParameter Key of type string
Button:numberParameter Button of type number
OnHeld:functionParameter OnHeld of type function
OnDown:functionParameter OnDown of type function
OnUp:functionParameter OnUp of type function
Returns
Examples
Display
BothLast updated: 05/03/2025Displays a custom bind handler that allow it to be rebound.
Parameters
Name:stringParameter Name of type string
Title:stringParameter Title of type string
Inline:boolean(optional)Parameter Inline of type boolean
Returns
Examples
GetLastKey
BothLast updated: 05/03/2025Returns the last pressed key.
Parameters
Returns
numberExamples
RemoveBind
BothLast updated: 05/03/2025Removes a custom bind handler if it exists.
Display requires an ImGui render context.Parameters
Key:stringParameter Key of type string
Returns
Examples
Linker
The linker api functions.
GetOriginal
BothLast updated: 05/03/2026Gets 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:stringThe table name to look up.
Function:string(optional)The specific function to get.
Returns
table/c functionExamples
Isolate
BothLast updated: 05/03/2026Creates an isolated state where _G and the ENV only access linker libraries.
Parameters
State:boolean(optional)The state to set for isolation.
Returns
booleanExamples
Lua Bridge
API functions for Lua Bridge
ArgError
BothLast updated: 05/02/2025Throws an argument error.
Parameters
Index:numberParameter Index of type number
Type:stringParameter Type of type string
Returns
Examples
Bridge
BothLast updated: 05/02/2025Creates a state bridge allowing cross communication.
Parameters
Realm:STATE_Parameter Realm of type STATE_
Callback:function(optional)Parameter Callback of type function
Returns
LuaStateExamples
Call
BothLast updated: 05/02/2025Calls a function.
Parameters
Arguments:numberParameter Arguments of type number
Returns:numberParameter Returns of type number
Returns
Examples
CheckType
BothLast updated: 05/02/2025Checks that the type of the value at Index is Type, if not, throws a type error.
Parameters
Index:numberParameter Index of type number
Type:TYPE_Parameter Type of type TYPE_
Returns
Examples
Equal
BothLast updated: 05/02/2025Returns true if the value at IndexA and IndexB are equal.
Parameters
IndexA:numberParameter IndexA of type number
IndexB:numberParameter IndexB of type number
Returns
booleanExamples
GetActualTypeName
BothLast updated: 05/02/2025Gets the actual type name of the value at Index.
Parameters
Index:numberParameter Index of type number
Returns
stringExamples
GetBool
BothLast updated: 05/02/2025Returns the bool at Index.
Parameters
Index:numberParameter Index of type number
Returns
booleanExamples
GetCFunction
BothLast updated: 05/02/2025Returns the user type at Index.
Parameters
Index:numberParameter Index of type number
Type:TYPE_Parameter Type of type TYPE_
MetaName:stringParameter MetaName of type string
Returns
anyExamples
GetField
BothLast updated: 05/02/2025Pushes 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:stringParameter Name of type string
Returns
Examples
GetMetaTable
BothLast updated: 05/02/2025Pushes the metatable of the value at Index to the top of the stack and returns true if it has one.
Parameters
Index:numberParameter Index of type number
Returns
booleanExamples
Miscellaneous
API functions for Miscellaneous
AddButtonToModifiedCommand
BothLast updated: 08/03/2026Adds a button to the modified command data which is processed when the command is sent. This can be used for numpad inputs.
Parameters
CommandData:ModifiedCommandDataParameter CommandData of type ModifiedCommandData
Key:IN_Parameter Key of type IN_
Returns
Examples
ChangeName
BothLast updated: 08/03/2026Changes 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:stringParameter 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
Examples
CL_Move
BothLast updated: 08/03/2026Forces CL_Move to run again.
Parameters
ExtraSamples:floatParameter ExtraSamples of type float
FinalTick:booleanParameter FinalTick of type boolean
Returns
Examples
DisableLuaHooks
BothLast updated: 08/03/2026Toggles the blocking of certain lua hooks.
Parameters
Hooks:{...string}Parameter Hooks of type {...string}
State:booleanParameter State of type boolean
Returns
Examples
Disconnect
BothLast updated: 08/03/2026Disconnects from the current server with the desired message or queues it for the next disconnect message.
Parameters
Reason:stringParameter Reason of type string
Returns
Examples
EndPrediction
BothLast updated: 08/03/2026Ends engine prediction. Returns whether the current context was ended or not.
Parameters
Returns
booleanExamples
GetClientState
BothLast updated: 08/03/2026Returns the [CClientState](https://github.com/VSES/SourceEngine2007/blob/master/se2007/engine/client.h#L133-L174) table.
Parameters
Returns
table [CClientState]Examples
GetConVar
BothLast updated: 08/03/2026Gets a ConVar.
Parameters
Name:stringParameter Name of type string
Returns
ConVar/boolean [false]Examples
GetEnv
BothLast updated: 08/03/2026Gets the environment table.
Parameters
Returns
tableExamples
GetGlobalVars
BothLast updated: 08/03/2026Returns the [CGlobalVarsBase](https://github.com/ValveSoftware/source-sdk-2013/blob/master/mp/src/public/globalvars_base.h#L19) table.
Parameters
Returns
table [CGlobalVarsBase]Examples
Net
API functions for Net
Abort
BothLast updated: 05/03/2025Aborts the current net message.
client lua state.Parameters
Returns
Examples
SendToServer
BothLast updated: 05/03/2025Sends the net message to the server.
Parameters
Returns
Examples
Start
BothLast updated: 05/03/2025Starts a net message. Returns whether the message was started or not.
client lua state.Parameters
Name:stringParameter Name of type string
Reliable:boolean(optional)Parameter Reliable of type boolean
Returns
booleanExamples
WriteAngle
BothLast updated: 05/03/2025Writes a bit.
client lua state.Parameters
Bit:booleanParameter Bit of type boolean
Returns
Examples
WriteData
BothLast updated: 05/03/2025Writes data.
client lua state.Parameters
Data:stringParameter Data of type string
Length:numberParameter Length of type number
Returns
Examples
WriteDouble
BothLast updated: 05/03/2025Writes a double.
client lua state.Parameters
Double:numberParameter Double of type number
Returns
Examples
WriteFloat
BothLast updated: 05/03/2025Writes a float.
client lua state.Parameters
Float:numberParameter Float of type number
Returns
Examples
WriteInt
BothLast updated: 05/03/2025Writes an int.
client lua state.Parameters
Value:numberParameter Value of type number
Bits:numberParameter Bits of type number
Returns
Examples
WriteMatrix
BothLast updated: 05/03/2025Writes a matrix.
client lua state.Parameters
Value:MatrixParameter Value of type Matrix
Returns
Examples
WriteNormal
BothLast updated: 05/03/2025Writes a normal.
client lua state.Parameters
Value:VectorParameter Value of type Vector
Returns
Examples
Socket
API functions for Socket
Emit
BothLast updated: 08/10/2026Emits an event to the current socket room.
Parameters
Event:stringParameter Event of type string
Arguments:...anyParameter Arguments of type ...any
Returns
Examples
EmitTo
BothLast updated: 08/10/2026Emits an event to a specific client in the current socket room.
Parameters
ClientID:stringParameter ClientID of type string
Event:stringParameter Event of type string
Arguments:...anyParameter Arguments of type ...any
Returns
Examples
GetRoomList
BothLast updated: 08/10/2026Gets the current room's list.
Parameters
Returns
{ ...{ ID: string, HWID: string, Name: string, SteamID64: string } }Examples
HWID
BothLast updated: 08/10/2026Gets our HWID.
Parameters
Returns
stringExamples
Off
BothLast updated: 08/10/2026Removes an event handler.
Parameters
Event:stringParameter Event of type string
Returns
Examples
On
BothLast updated: 08/10/2026Registers an event handler.
Parameters
Event:stringParameter Event of type string
Callback:functionParameter Callback of type function
Returns
Examples
Once
BothLast updated: 08/10/2026Registers a one time event handler that removes itself upon being ran.
Parameters
Event:stringParameter Event of type string
Callback:functionParameter Callback of type function
Returns
Examples
SessionID
BothLast updated: 08/10/2026Gets the socket's current session id.
Parameters
Returns
stringExamples
Subscribe
BothLast updated: 08/10/2026Subscribes to a socket room to emit events to.
Parameters
Room:stringParameter Room of type string
Password:string(optional)Parameter Password of type string
Returns
Examples
Unsubscribe
BothLast updated: 08/10/2026Unsubscribes from the current socket room.
Parameters
Returns
Examples
Thirdperson
API functions for Thirdperson
GetActive
BothLast updated: 05/03/2025Gets the current thirdperson state.
Parameters
Returns
booleanExamples
GetBackDistance
BothLast updated: 05/03/2025Gets the current thirdperson back distance.
Parameters
Returns
numberExamples
GetSideDistance
BothLast updated: 05/03/2025Gets the current thirdperson side distance.
Parameters
Returns
numberExamples
GetUpDistance
BothLast updated: 05/03/2025Gets the current thirdperson up distance.
Parameters
Returns
numberExamples
SetActive
BothLast updated: 05/03/2025Sets the state of thirdperson.
Parameters
State:booleanParameter State of type boolean
Returns
Examples
SetBackDistance
BothLast updated: 05/03/2025Sets the back distance of thirdperson.
Parameters
Distance:numberParameter Distance of type number
Returns
Examples
SetSideDistance
BothLast updated: 05/03/2025Sets the side distance of thirdperson.
Parameters
Distance:numberParameter Distance of type number
Returns
Examples
SetUpDistance
BothLast updated: 05/03/2025Sets the up distance of thirdperson.
Parameters
Distance:numberParameter Distance of type number
Returns
Examples
Triggerbot
API functions for Triggerbot
IsActive
BothLast updated: 06/08/2025Gets the state of the triggerbot.
Parameters
Returns
booleanExamples
UserCmd
API functions for UserCmd
GetRandomSeed
BothLast updated: 06/08/2025Gets the CUserCmd's random seed.
Parameters
Command:CUserCmdParameter Command of type CUserCmd
Returns
numberExamples
SetCommandNumber
BothLast updated: 06/08/2025Sets the CUserCmd's command number.
Parameters
Command:CUserCmdParameter Command of type CUserCmd
CommandNumber:numberParameter CommandNumber of type number
Returns
Examples
SetRandomSeed
BothLast updated: 06/08/2025Sets the CUserCmd's random seed.
Parameters
Command:CUserCmdParameter Command of type CUserCmd
Seed:numberParameter Seed of type number
Returns
Examples
SetTick
BothLast updated: 06/08/2025Sets the CUserCmd's tick.
Parameters
Command:CUserCmdParameter Command of type CUserCmd
Tick:numberParameter Tick of type number
Returns
Examples
SetWorldClicker
BothLast updated: 06/08/2025Sets the world clicker direction of a CUserCmd.
Parameters
Command:CUserCmdParameter Command of type CUserCmd
Direction:VectorParameter Direction of type Vector
Returns
Examples
Web
API functions for Web
Create
BothLast updated: 02/19/2026Creates a new web client instance with the specified url.
Parameters
URL:stringThe url to open the client on.
Returns
WebClientExamples
GetAll
BothLast updated: 02/19/2026Gets the list of all current web clients.
Parameters
Returns
{...WebClient}Examples
WebClient
API functions for WebClient
Destroy
BothLast updated: 02/19/2026Destroys the web client instance.
Parameters
Returns
Examples
Draw
BothLast updated: 02/19/2026Draws the web client.
Parameters
Size:{x: number, y: number}The size to draw the web client at in the current window.
Returns
Examples
ExecuteJavascript
BothLast updated: 02/19/2026Executes javascript on the web client.
Parameters
Code:stringThe javascript to execute on the web client.
Returns
Examples
GetFocused
BothLast updated: 02/19/2026Gets the web client's focus state.
Parameters
Returns
booleanExamples
GetHeight
BothLast updated: 02/19/2026Gets the height of the web client.
Parameters
Returns
numberExamples
GetIdentifier
BothLast updated: 02/19/2026Gets the web client's string identifier.
Parameters
Returns
stringExamples
GetURL
BothLast updated: 02/19/2026Gets the url of the web client.
Parameters
Returns
stringExamples
GetWidth
BothLast updated: 02/19/2026Gets the width of the web client.
Parameters
Returns
numberExamples
OnIPCMessage
BothLast updated: 02/19/2026Adds an event handler for a web client IPC message.
Parameters
Event:stringThe IPC message event name.
Callback:functionThe callback function to run.
Returns
Examples
OpenURL
BothLast updated: 02/19/2026Opens a url on the web client.
Parameters
Returns
Examples