> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlanta.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Utils

> A general-purpose module containing miscellaneous utility functions for debugging, system interaction, clipboard management, and accessing essential window/process information.

***

## 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.

```lua Utils Usage Example theme={null}
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.

```lua theme={null}
print(...): void
```

<ParamField path="..." type="variadic" required>The values to print. Accepts multiple arguments of any type.</ParamField>

### warn

Prints a warning message to the history window output section.

```lua theme={null}
warn(...): void
```

<ParamField path="..." type="variadic" required>The values to print as a warning. Accepts multiple arguments of any type.</ParamField>

### error

Prints an error message to the history window output section.

```lua theme={null}
error(...): void
```

<ParamField path="..." type="variadic" required>The values to print as an error. Accepts multiple arguments of any type.</ParamField>

### info

Prints an informational message to the history window output section.

```lua theme={null}
info(...): void
```

<ParamField path="..." type="variadic" required>The values to print as information. Accepts multiple arguments of any type.</ParamField>

### set\_clipboard

Sets the system clipboard text to the specified string.

```lua theme={null}
set_clipboard(string: text): void
```

<ParamField path="text" type="string" required>The text to copy to the clipboard.</ParamField>

### get\_process\_id

Gets the target process ID. Returns the process ID as a number.

```lua theme={null}
get_process_id(): number
```

***

### get\_delta

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

```lua theme={null}
get_delta(): number
```

***

### get\_window\_position

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

```lua theme={null}
get_window_position(): Vector2
```

***

### get\_window\_size

Gets the current window size. Returns a Vector2 containing the width and height.

```lua theme={null}
get_window_size(): Vector2
```

***

### get\_window\_rect

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

```lua theme={null}
get_window_rect(): Rect
```

***

### get\_running

Checks if the application is currently running. Returns `true` if running, `false` otherwise.

```lua theme={null}
get_running(): boolean
```

***

### get\_focused

Checks if the window is currently focused. Returns `true` if focused, `false` otherwise.

```lua theme={null}
get_focused(): boolean
```

***

### get\_open

Checks if the window is currently open. Returns `true` if open, `false` otherwise.

```lua theme={null}
get_open(): boolean
```
