Skip to main content

​
Access

All utils C++ functions are exposed to your Lua script via a single global table named utils. You access individual values by using the dot (.) or bracket ([]) operator on this table.
Utils Usage Example
local current_delta = utils.get_delta(); -- Dot Operator
utils["set_clipboard"](";-;"); -- Bracket Operator

​
Functions

This section lists all available C++ functions exposed within the global utils table. These functions provide general-purpose utilities, including debugging output, system information retrieval, and clipboard manipulation.

​
print

Prints a message to the history window output section. 
print(...): void
​
...
variadic
required
The values to print. Accepts multiple arguments of any type.

​
warn

Prints a warning message to the history window output section. 
warn(...): void
​
...
variadic
required
The values to print as a warning. Accepts multiple arguments of any type.

​
error

Prints an error message to the history window output section. 
error(...): void
​
...
variadic
required
The values to print as an error. Accepts multiple arguments of any type.

​
info

Prints an informational message to the history window output section. 
info(...): void
​
...
variadic
required
The values to print as information. Accepts multiple arguments of any type.

​
set_clipboard

Sets the system clipboard text to the specified string. 
set_clipboard(string: text): void
​
text
string
required
The text to copy to the clipboard.

​
get_process_id

Gets the target process ID. Returns the process ID as a number. 
get_process_id(): number

​
get_delta

Gets the delta time (time elapsed since launch). Returns the delta time in seconds as a number. 
get_delta(): number

​
get_window_position

Gets the current window position on the screen. Returns a Vector2 containing the X and Y coordinates. 
get_window_position(): Vector2

​
get_window_size

Gets the current window size. Returns a Vector2 containing the width and height. 
get_window_size(): Vector2

​
get_window_rect

Gets the current window rectangle (position and size). Returns a Rect containing the window bounds. 
get_window_rect(): Rect

​
get_running

Checks if the application is currently running. Returns true if running, false otherwise. 
get_running(): boolean

​
get_focused

Checks if the window is currently focused. Returns true if focused, false otherwise. 
get_focused(): boolean

​
get_open

Checks if the window is currently open. Returns true if open, false otherwise. 
get_open(): boolean
⌘I