RbxCli

https://rbxcli.github.io/
Admin
RbxCli is an external tool for the ROBLOX engine that enables game modification, analysis, and...
Tokens:20,572
Snippets:98
Trust Score:8.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Product Information with rbxcli

Source: https://rbxcli.github.io/eUNC/api/rbxcli

Retrieves information about the product running the script. This function returns a table containing details about the product's version.

```lua
local productInfo = rbxcli.get_product_information()
print(productInfo)
```

--------------------------------

### Get Base Address of Main Module (Lua)

Source: https://rbxcli.github.io/eUNC/api/memory

Retrieves the base memory address of the main module of the target process. This is a static function within the memory library and returns a number representing the address.

```Lua
memory.get_base_address()
```

--------------------------------

### Get Part's Physics Pool Index with RbxCli

Source: https://rbxcli.github.io/eUNC/api/physics

Retrieves the internal physics 'pool' index for a given BasePart. This index affects update rates and data freshness. Handles errors for freed objects, non-BaseParts, or untracked parts.

```Lua
local poolIndex = physics.get_part_pool(part)
```

--------------------------------

### Get Cached Part Size with RbxCli Physics

Source: https://rbxcli.github.io/eUNC/api/physics

Retrieves the cached 'Size' of a BasePart from the last RbxCli update. This is faster than standard property access but may be slightly out of date. Handles errors for freed objects, non-BaseParts, or untracked parts.

```Lua
local cachedSize = physics.get_tracked_size(part)
```

--------------------------------

### Instance Methods

Source: https://rbxcli.github.io/eUNC/api/Instance

This section covers the methods available on the Instance object for interacting with its children and attributes.

```APIDOC
## FindFirstChild

### Description
Attempts to find the first child on the instance whose name matches the given string.

### Method
[Implicit Method Call]

### Endpoint
[N/A - Object Method]

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lua
local foundChild = instance:FindFirstChild("ChildName")
```

### Response
#### Success Response (200)
- **Instance?** - An instance, which may be null if it was not found.

#### Response Example
```lua
-- Returns an Instance object or nil
```

## FindFirstChildWhichIsA

### Description
Attempts to find the first child on the instance whose class matches or inherits from the given class.

:::warning Performance
    This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself.
:::

### Method
[Implicit Method Call]

### Endpoint
[N/A - Object Method]

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lua
local foundInstance = instance:FindFirstChildWhichIsA("BasePart")
```

### Response
#### Success Response (200)
- **Instance?** - An instance, which may be null if it was not found.

#### Response Example
```lua
-- Returns an Instance object or nil
```

## GetAttribute

### Description
Attempts to retrieve the attribute with the given name.

### Method
[Implicit Method Call]

### Endpoint
[N/A - Object Method]

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lua
local attributeValue = instance:GetAttribute("AttributeName")
```

### Response
#### Success Response (200)
- **any?** - The value of the attribute, which may be nil.

#### Response Example
```lua
-- Returns the attribute value or nil
```

## GetAttributes

### Description
Attempts to retrieve all attributes of the instance.

### Method
[Implicit Method Call]

### Endpoint
[N/A - Object Method]

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```lua
local allAttributes = instance:GetAttributes()
```

### Response
#### Success Response (200)
- **{ [string]: any? }** - A dictionary containing all attributes available with their names as the key.

#### Response Example
```lua
{
    "Attribute1": "Value1",
    "Attribute2": 123
}
```
```

--------------------------------

### Instance Properties

Source: https://rbxcli.github.io/eUNC/api/Instance

This section details the properties of the Instance object.

```APIDOC
## Name Property

### Description
Contains the Name of the object.

:::warning Readonly Validity
    This property may be safe to read/write on certain conditions. However this behaviour is not guaranteed by spec.
:::

### Method
[Property Access]

### Endpoint
[N/A - Object Property]

### Parameters
N/A

### Request Example
```lua
local name = instance.Name
```

### Response
#### Success Response (200)
- **string** - The name of the instance.

#### Response Example
```lua
"MyInstance"
```

## ClassName Property

### Description
Contains the ClassName of the object, held in its class descriptor.

### Method
[Property Access]

### Endpoint
[N/A - Object Property]

### Parameters
N/A

### Request Example
```lua
local className = instance.ClassName
```

### Response
#### Success Response (200)
- **string** - The class name of the instance.

#### Response Example
```lua
"BasePart"
```

## Parent Property

### Description
The parent of the instance, may be nil.

### Method
[Property Access]

### Endpoint
[N/A - Object Property]

### Parameters
N/A

### Request Example
```lua
local parent = instance.Parent
```

### Response
#### Success Response (200)
- **instance?** - The parent instance, or nil if it has no parent.

#### Response Example
```lua
-- Returns a parent Instance object or nil
```

## Address Property

### Description
The address of the instance in roblox memory.

### Method
[Property Access]

### Endpoint
[N/A - Object Property]

### Parameters
N/A

### Request Example
```lua
local address = instance.Address
```

### Response
#### Success Response (200)
- **number** - The memory address of the instance.

#### Response Example
```lua
1234567890
```
```

--------------------------------

### Scan Memory for Signature

Source: https://rbxcli.github.io/eUNC/api/memory

Scans the process memory for a given AOB (Array of Bytes) signature. Optionally accepts start and end addresses to limit the scan range. Returns a status code and a list of matching addresses.

```lua
memory.scan_signature(signature: string, startAddress: number?, endAddress: number?) -> (number, {number}?)
```

--------------------------------

### Instance Functions API

Source: https://rbxcli.github.io/eUNC/api/Instance

This section covers the functions available for Instance objects, including inheritance checks, retrieving children and descendants, and finding specific child instances.

```APIDOC
## Instance Functions API

### Description
This section covers the functions available for Instance objects, including inheritance checks, retrieving children and descendants, and finding specific child instances.

### Functions

#### `IsA`
- **Description**: Performs an inheritance check, validating whether the object's class derives from the given `className`.
- **Parameters**:
  - `className` (string) - Required - The name of the class that is checked for inheritance.
- **Returns**: `boolean` - Whether the object's class inherits from className.

#### `GetChildren`
- **Description**: Retrieves the children for the instance.
- **Returns**: `{Instance}` - All children of the instance.

#### `GetDescendants`
- **Description**: Retrieves the descendants for the instance. This function may be **very** slow and should be avoided if possible.
- **Returns**: `{Instance}` - All descendants of the instance.

#### `GetFullName`
- **Description**: Retrieves the fully qualified name for the given instance.
- **Returns**: `string` - The fully qualified name for the instance.

#### `OfClass`
- **Description**: Checks the immediate Class of the object.
- **Parameters**:
  - `className` (string) - Required - The expected class name.
- **Returns**: `boolean` - Whether the given class name is equal to the one the instance possesses.

#### `FindFirstChild`
- **Description**: Attempts to find the first child on the instance which matches the given name. This function may silently perform `GetChildren` for every invocation; consider caching children if repeatedly accessing them.
- **Parameters**:
  - `name` (string) - Required - The instance name.
- **Returns**: `Instance?` - An instance, which may be null if it was not found.

#### `FindFirstChildOfClass`
- **Description**: Attempts to find the first child on the instance which matches the given class name. This function may silently perform `GetChildren` for every invocation; consider caching children if repeatedly accessing them.
- **Parameters**:
  - `className` (string) - Required - The class name of the target instance.
- **Returns**: `Instance?` - An instance, which may be null if it was not found.

#### `FindFirstChildWhichIsA`
- **Description**: Attempts to find the first child on the instance whose class matches or inherits from the given class. This function may silently perform `GetChildren` for every invocation; consider caching children if repeatedly accessing them.
- **Parameters**:
  - `className` (string) - Required - The class name of the target instance.
- **Returns**: `Instance?` - An instance, which may be null if it was not found.

#### `GetAttribute`
- **Description**: Attempts to retrieve the attribute with the given name.
- **Parameters**:
  - `attributeName` (string) - Required - The name of the target attribute.
- **Returns**: `any?` - The value of the attribute, which may be nil.
```

--------------------------------

### Get Cached Part CFrame with RbxCli Physics

Source: https://rbxcli.github.io/eUNC/api/physics

Retrieves the cached 'CFrame' of a BasePart from the last RbxCli update. This is faster than standard property access but may be slightly out of date. Handles errors for freed objects or non-BaseParts.

```Lua
local cachedCFrame = physics.get_tracked_cframe(part)
```

--------------------------------

### Scan Instances

Source: https://rbxcli.github.io/eUNC/api/memory

Scans for instances in memory given a vtable address.

```APIDOC
## POST /memory/scan_instances

### Description
Scans for instances in memory given a vtable address.

### Method
POST

### Endpoint
/memory/scan_instances

### Parameters
#### Request Body
- **vtableAddress** (number) - Required - The address of the VTable the classes should look for.

### Request Example
```json
{
  "vtableAddress": 5000000
}
```

### Response
#### Success Response (200)
- **instances** (array of numbers) - An array of addresses of the instances whose first member is the VTable.

#### Response Example
```json
{
  "instances": [5001000, 5002500, 5003000]
}
```
```

--------------------------------

### scan_instances

Source: https://rbxcli.github.io/eUNC/api/memory

Scans for instances in memory based on a provided VTable address.

```APIDOC
## static scan_instances

### Description
Scans for instances in memory given a vtable.

### Method
STATIC

### Parameters
#### Request Body
- **vtableAddress** (number) - Required - The address of the VTable the classes should look for.

### Response
#### Success Response (200)
- **addresses** ({ number }) - An array of addresses of the instances whose first member is the VTable.
```

--------------------------------

### KeyCode Library Constants

Source: https://rbxcli.github.io/eUNC/api

A collection of read-only properties representing standard Win32 virtual key codes.

```APIDOC
## KeyCode Library

### Description
The KeyCode library provides access to standard Win32 virtual key codes. All properties are read-only and return a numeric representation of the specific key.

### Properties
- **LeftButton** (number) - Read Only
- **RightButton** (number) - Read Only
- **MiddleButton** (number) - Read Only
- **Backspace** (number) - Read Only
- **Tab** (number) - Read Only
- **Return** (number) - Read Only
- **Shift** (number) - Read Only
- **Control** (number) - Read Only
- **Alt** (number) - Read Only
- **Escape** (number) - Read Only
- **Space** (number) - Read Only
- **Left/Up/Right/Down** (number) - Read Only
- **A-Z** (number) - Read Only
- **Zero-Nine** (number) - Read Only

### Usage Example
```javascript
// Accessing a key code
const escapeKey = KeyCode.Escape;
console.log(escapeKey);
```
```

--------------------------------

### KeyCode Library Constants

Source: https://rbxcli.github.io/eUNC/api/KeyCode

A collection of read-only properties representing standard Win32 virtual key codes.

```APIDOC
## KeyCode Library

### Description
The KeyCode library provides a mapping of virtual key codes (Win32 VK Codes) used for input operations. All properties are read-only.

### Properties
- **LeftButton** (number) - Read Only
- **RightButton** (number) - Read Only
- **MiddleButton** (number) - Read Only
- **Backspace** (number) - Read Only
- **Tab** (number) - Read Only
- **Return** (number) - Read Only
- **Shift** (number) - Read Only
- **Control** (number) - Read Only
- **Alt** (number) - Read Only
- **Escape** (number) - Read Only
- **Space** (number) - Read Only
- **Left/Up/Right/Down** (number) - Read Only
- **A-Z** (number) - Read Only
- **Zero-Nine** (number) - Read Only

### Usage Example
```javascript
const key = KeyCode.Escape;
if (input === key) {
  // Handle escape logic
}
```
```

--------------------------------

### Get Part Pool Index - Lua

Source: https://rbxcli.github.io/eUNC/api/physics

Retrieves the internal 'pool' index assigned to a part within the RbxCli physics engine. This index affects the update rate of the part's visuals and the freshness of physics data. Requires a BasePart instance as input and returns a number representing the pool index.

```lua
local poolIndex = physics.get_part_pool(part)
print("Part is in pool: " .. tostring(poolIndex))
```

--------------------------------

### request()

Source: https://rbxcli.github.io/eUNC/api/global

Performs an HTTP request and returns the response structure.

```APIDOC
## [FUNCTION] request

### Description
Performs an HTTP request to a specified URL with custom headers, cookies, and body content.

### Method
N/A (Luau Function)

### Parameters
#### Request Options (Table)
- **Url** (string) - Required - The target URL for the request.
- **Method** (string) - Optional - The HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET.
- **Headers** (table) - Optional - A dictionary of string keys and values for HTTP headers.
- **Cookies** (table) - Optional - A dictionary of string keys and values for Cookies.
- **Body** (string) - Optional - The request body (payload).

### Request Example
{
  "Url": "https://api.example.com",
  "Method": "POST",
  "Body": "{\"key\": \"value\"}"
}

### Response
#### Success Response (200)
- **Success** (boolean) - True if the status code is not an error.
- **StatusCode** (number) - The HTTP status code returned.
- **StatusMessage** (string) - The status message (e.g., "200 OK").
- **Body** (string) - The response body.
- **Headers** (table) - A dictionary of response headers.
- **Cookies** (table) - A dictionary of response cookies.

#### Response Example
{
  "Success": true,
  "StatusCode": 200,
  "StatusMessage": "200 OK",
  "Body": "{\"data\": \"success\"}"
}
```

--------------------------------

### Move Mouse Instantly to Instance

Source: https://rbxcli.github.io/eUNC/api/input

Moves the mouse cursor instantly to the center of a specified Roblox UI instance. Requires the Roblox window to be focused and the instance to be a visible, positioned GuiObject.

```Lua
input.mouse_move_instance(instance: Instance)
```

--------------------------------

### Memory Library Status

Source: https://rbxcli.github.io/eUNC/api/memory

Checks if the Memory library is enabled and ready for use.

```APIDOC
## GET /memory/is_enabled

### Description
Checks if the Memory library is enabled. This function returns a boolean indicating the status.

### Method
GET

### Endpoint
`/memory/is_enabled`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **enabled** (boolean) - True if the Memory library is enabled, false otherwise.

#### Response Example
```json
{
  "enabled": true
}
```
```

--------------------------------

### Instance Properties API

Source: https://rbxcli.github.io/eUNC/api/Instance

This section details the read-only properties of an Instance object, including its Name, ClassName, Parent, and Address.

```APIDOC
## Instance Properties API

### Description
This section details the read-only properties of an Instance object, including its Name, ClassName, Parent, and Address.

### Properties

#### `Name`
- **Type**: `string`
- **Description**: Contains the Name of the object. Read-only.
- **Readonly Validity**: This property may be safe to read/write on certain conditions, however this behaviour is not guaranteed by spec.

#### `ClassName`
- **Type**: `string`
- **Description**: Contains the ClassName of the object, held in its class descriptor. Read-only.

#### `Parent`
- **Type**: `instance?`
- **Description**: The parent of the instance, may be nil. Read-only.

#### `Address`
- **Type**: `number`
- **Description**: The address of the instance in roblox memory. Read-only.
```

--------------------------------

### GetService Method

Source: https://rbxcli.github.io/eUNC/api/DataModel

Attempts to retrieve a service based on its ClassName. This function is similar to FindService and does not create services.

```APIDOC
## GET /DataModel/GetService

### Description
Attempts to retrieve a service based on its ClassName. This function will not create services unlike the Roblox version, it is akin to FindService.

### Method
GET

### Endpoint
`/DataModel/GetService`

### Parameters
#### Query Parameters
- **serviceName** (string) - Required - The name of the service to retrieve.

### Response
#### Success Response (200)
- **Instance?** - The service instance, which may be nil if it does not exist.

#### Response Example
```json
{
  "service": "Players"
}
```

### Aliases
- FindService
- service
- findService
```

--------------------------------

### Simulate Mouse Input with RBXCLI

Source: https://rbxcli.github.io/eUNC/api/input

Function to simulate mouse button interactions. Requires the Roblox window to be focused to function correctly.

```Luau
-- Press and hold left mouse button (1)
mouse_down(1)
```

--------------------------------

### Simulate Keyboard Input with RBXCLI

Source: https://rbxcli.github.io/eUNC/api/input

Functions to manage keyboard states including pressing, releasing, and clicking keys. These functions require a valid Virtual Key (VK) code and will throw errors if the Roblox window is not focused.

```Luau
-- Press and hold a key
key_down(0x41) -- 'A' key

-- Release a key
key_up(0x41)

-- Perform a full click
key_click(0x41)

-- Check key state
local isDown = is_key_down(0x41)
```

--------------------------------

### Mouse Input Simulation

Source: https://rbxcli.github.io/eUNC/api/input

Functions to simulate mouse button interactions and cursor movement. Supports absolute positioning, relative offsets, and smooth tweened movement.

```Lua
input.mouse_down(button: number)
input.mouse_up(button: number)
input.mouse_click(button: number, count: number?)
local isDown = input.is_mouse_down(button: number)
input.mouse_move_absolute(position: Vector2)
input.mouse_move_relative(offset: Vector2)
input.mouse_move_tween(position: Vector2, timeInSeconds: number)
```

--------------------------------

### Scan for VTable Instances

Source: https://rbxcli.github.io/eUNC/api/memory

Scans process memory to find instances of classes based on their VTable address. Requires the VTable address as input and returns an array of addresses of the found instances.

```lua
memory.scan_instances(vtableAddress: number) -> {number}
```

--------------------------------

### Input Key Codes

Source: https://rbxcli.github.io/eUNC/api/KeyCode

This section details the available input key codes, which are read-only numerical representations of keyboard keys.

```APIDOC
## Input Key Codes

### Description
Provides read-only numerical values for various keyboard keys. These values cannot be modified.

### Method
GET

### Endpoint
`/input/keycodes`

### Parameters
#### Query Parameters
- **key** (string) - Optional - The name of the key code to retrieve (e.g., `RightAlt`, `LeftButton`). If not provided, all key codes are returned.

### Response
#### Success Response (200)
- **key_name** (string) - The name of the key code.
- **value** (number) - The numerical representation of the key code.

#### Response Example
```json
{
  "key_name": "RightAlt",
  "value": 12345
}
```

#### Error Response (404)
- **error** (string) - Description of the error if the key is not found.

#### Error Example
```json
{
  "error": "Key code 'InvalidKey' not found."
}
```
```

--------------------------------

### Write 64-bit Floating Point

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a 64-bit floating point number to the specified memory address.

```APIDOC
## POST /memory/writef64

### Description
Writes a 64-bit floating point number to the specified memory address.

### Method
POST

### Endpoint
/memory/writef64

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 3.141592653589793
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Click Instance

Source: https://rbxcli.github.io/eUNC/api/input

Moves the mouse cursor to the center of a specified Roblox UI instance and performs a mouse click using a given button code. Requires the Roblox window to be focused, the instance to be a visible and interactable GuiObject, and a valid mouse button code.

```Lua
input.mouse_click_instance(instance: Instance, button: number)
```

--------------------------------

### Input Constants Reference

Source: https://rbxcli.github.io/eUNC/api

A collection of read-only numeric constants representing various keyboard keys, including arithmetic operators, function keys, and lock keys.

```APIDOC
## GET /libraries/input/constants

### Description
Retrieves the list of available input key constants defined in the input library. These are read-only numeric values used for input handling.

### Method
GET

### Parameters
None

### Response
#### Success Response (200)
- **constants** (array) - A list of objects containing the name, lua_type, and value of the input constants.

#### Response Example
{
  "constants": [
    { "name": "Multiply", "lua_type": "number", "value": 594 },
    { "name": "Add", "lua_type": "number", "value": 599 },
    { "name": "F1", "lua_type": "number", "value": 624 },
    { "name": "NumLock", "lua_type": "number", "value": 684 }
  ]
}
```

--------------------------------

### BasePart Properties

Source: https://rbxcli.github.io/eUNC/api/BasePart

A collection of properties defining the physical and spatial state of a BasePart instance.

```APIDOC
## BasePart Properties

### Description
Properties governing the physical behavior, spatial orientation, and network ownership of a BasePart.

### Properties
- **Position** (Vector3) - The current world position of the part.
- **CFrame** (CoordinateFrame) - The coordinate frame representing position and rotation.
- **Size** (Vector3) - The physical collision size of the part.
- **IsNetworkOwner** (boolean) - Read-only; indicates if the LocalPlayer owns the part for physics.
- **NetworkIsSleeping** (boolean) - Indicates if the part is sleeping for physics replication.
- **Anchored** (boolean) - Determines if the part is simulated by the physics engine.
- **CanCollide** (boolean) - Determines if the part is collidable.
- **CanQuery** (boolean) - Determines if the part can be queried for physics interactions.
- **CanTouch** (boolean) - Determines if the part raises Touch events.
- **NetworkOwnerV3** (RaknetID) - The RakNet ID of the part owner.
- **AssemblyLinearVelocity** (Vector3) - The linear velocity of the part in the assembly.

### Usage Note
Writing to `Position` or `CFrame` may be performance-intensive; avoid frequent updates if possible. Modifying `Size` affects collision, not visual scale.
```

--------------------------------

### Keyboard Input Simulation

Source: https://rbxcli.github.io/eUNC/api/input

Functions to simulate keyboard interactions including holding keys, releasing them, and performing full clicks. These functions require the Roblox window to be in focus.

```Lua
input.key_down(key: number)
input.key_up(key: number)
input.key_click(key: number)
local isDown = input.is_key_down(key: number)
```

--------------------------------

### Smoothly Move Mouse to Instance

Source: https://rbxcli.github.io/eUNC/api/input

Smoothly animates the mouse cursor to the center of a specified Roblox UI instance over a given duration. This function blocks execution until the animation completes. It requires the Roblox window to be focused and the instance to be a visible, positioned GuiObject.

```Lua
input.mouse_move_instance_tween(instance: Instance, timeInSeconds: number)
```

--------------------------------

### Logging Functions

Source: https://rbxcli.github.io/eUNC/api/global

Functions for outputting information to the RbxCli logger.

```APIDOC
## [FUNCTION] print / warn

### Description
Prints arguments to the RbxCli logger. `print` uses info level, `warn` uses warning level.

### Parameters
- **...** (any) - Required - The values to print or warn, converted to strings and tab-separated.

### Request Example
print("Operation successful", 123)
warn("Deprecated feature used")
```

--------------------------------

### Read Memory Buffer (Lua)

Source: https://rbxcli.github.io/eUNC/api/memory

Performs a raw memory read operation from a specified address with a given size. It returns a status code indicating success or failure, along with the data read as a buffer.

```Lua
memory.read(address, size)
```

--------------------------------

### Simulate Touch Interest with rbxcli

Source: https://rbxcli.github.io/eUNC/api/rbxcli

Attempts to fire the .Touched event between two BaseParts. It requires the two parts, a touch type (0 for Touch, 1 for Untouch), and an optional boolean to replicate the event to the server.

```lua
local partA = game.Workspace.PartA
local partB = game.Workspace.PartB
rbxcli.firetouchinterest(partA, partB, 0, true)
```

--------------------------------

### Check Memory Library Status (Lua)

Source: https://rbxcli.github.io/eUNC/api/memory

Checks if the Memory library's access to the target process is currently enabled. This is a static function that returns a boolean value.

```Lua
memory.is_enabled()
```

--------------------------------

### Perform Raycast with RbxCli Physics

Source: https://rbxcli.github.io/eUNC/api/physics

Performs a raycast in the physical world using origin, direction, distance, and an optional ignore list. Returns hit information or nil. Handles errors related to invalid parameters or unavailable physics.

```Lua
local result = physics.raycast(Vector3.new(0, 10, 0), Vector3.new(0, -1, 0), 100, { workspace.BasePlate })
if result then
    print("Hit " .. result.instance.Name .. " at " .. tostring(result.position))
end
```

--------------------------------

### Write 32-bit Floating Point

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a 32-bit floating point number to the specified memory address.

```APIDOC
## POST /memory/writef32

### Description
Writes a 32-bit floating point number to the specified memory address.

### Method
POST

### Endpoint
/memory/writef32

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 3.14159
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Physics Library Functions

Source: https://rbxcli.github.io/eUNC/api/physics

This section details the functions available in the RbxCli physics library for interacting with game physics.

```APIDOC
## are_parts_trackable

### Description
Checks if a given BasePart is allowed to be tracked by RbxCli.

### Method
Static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **is_trackable** (boolean) - True if the part is allowed to be tracked.

#### Response Example
None

## are_parts_updated

### Description
Checks if part data is being updated internally by RbxCli. If this function returns false, RbxCli will fall back to reading from raw memory, which may reduce execution speed or cause some APIs to fail.

### Method
Static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **updated** (boolean) - True if parts are being updated internally.

#### Response Example
None

## is_point_in_part

### Description
Determines if a given point in world space is located within the bounds of a specified BasePart.

### Method
Static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **in_part** (boolean) - True if the point is inside the part, false otherwise.

#### Response Example
None

## is_point_in_box_volume

### Description
Determines if a given point in world space is located within the bounds of an box volume defined by a CFrame and size.

### Method
Static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **in_volume** (boolean) - True if the point is inside the box volume, false otherwise.

#### Response Example
None

## is_point_in_sphere_volume

### Description
Determines if a given point in world space is located within the bounds of a sphere volume defined by a center point and radius.

### Method
Static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **in_volume** (boolean) - True if the point is inside the sphere volume, false otherwise.

#### Response Example
None
```

--------------------------------

### get_base_address

Source: https://rbxcli.github.io/eUNC/api/memory

Retrieves the base address of the main module.

```APIDOC
## static get_base_address

### Description
Gets the base address of the main module of the target process.

### Method
STATIC

### Response
#### Success Response (200)
- **baseAddress** (number) - The base address.
```

--------------------------------

### Memory Reading Functions

Source: https://rbxcli.github.io/eUNC/api/memory

This section covers functions for reading unsigned integers, signed integers, and floating-point numbers from specified memory addresses.

```APIDOC
## readu32 / readi8 / readi16 / readi32 / readf32 / readf64

### Description
Reads a specific data type (unsigned 32-bit integer, signed 8/16/32-bit integer, 32-bit float, or 64-bit double) from the specified memory address.

### Method
N/A (These are function calls within a script, not HTTP requests)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```lua
-- Example for readu32
local address = 12345678
local status, value = memory.readu32(address)

-- Example for readi8
local address = 87654321
local status, value = memory.readi8(address)

-- Example for readf32
local address = 11223344
local status, value = memory.readf32(address)
```

### Response
#### Success Response
- **status** (number) - A status code indicating the success of the read operation (e.g., ProcessReadResult).
- **value** (number?) - The data read from the memory address. The type depends on the function called (e.g., number for integers and floats).

#### Response Example
```json
-- Assuming a successful read of a 32-bit unsigned integer
-- The actual return is a tuple, represented here conceptually
-- status = 0 (success), value = 42
```
```

--------------------------------

### Write Signed 32-bit Integer

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 32-bit integer to the specified memory address.

```APIDOC
## POST /memory/writei32

### Description
Writes a signed 32-bit integer to the specified memory address.

### Method
POST

### Endpoint
/memory/writei32

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 2147483647
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Write Signed 16-bit Integer

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 16-bit integer to the specified memory address.

```APIDOC
## POST /memory/writei16

### Description
Writes a signed 16-bit integer to the specified memory address.

### Method
POST

### Endpoint
/memory/writei16

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 32767
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Read Memory String (Lua)

Source: https://rbxcli.github.io/eUNC/api/memory

Reads an ASCII string from a specified memory address. It supports reading standard C-style strings or C++ style strings and can optionally limit the read size. Returns a status code and the string, or nil if the read fails.

```Lua
memory.read_string(address, isCxxString, readCount, readExactly)
```

--------------------------------

### Check Window Focus

Source: https://rbxcli.github.io/eUNC/api/input

Returns a boolean indicating whether the Roblox window is currently the active, focused window. This is a simple check with no external dependencies.

```Lua
input.is_window_focused(): boolean
```

--------------------------------

### Fire Proximity Prompt with rbxcli

Source: https://rbxcli.github.io/eUNC/api/rbxcli

Attempts to trigger the .Triggered event of a given ProximityPrompt. This function simulates a tap and does not account for hold durations, which might be detected by anti-cheat systems.

```lua
local prompt = game.Workspace.MyProximityPrompt
rbxcli.fireproximityprompt(prompt)
```

--------------------------------

### Write Signed 32-bit Integer to Memory

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 32-bit integer to a specified memory address. Requires the address and the value to write. Returns a status code indicating the success of the operation.

```lua
memory.writei32(address: number, value: number) -> number
```

--------------------------------

### Scan for VTable by Name

Source: https://rbxcli.github.io/eUNC/api/memory

Scans the Roblox PE (Portable Executable) file for a VTable given its mangled name. Returns the pointer to the VTable address, which may be nil if not found.

```lua
memory.scan_vtable(vtableName: string) -> number?
```

--------------------------------

### Mouse Movement API

Source: https://rbxcli.github.io/eUNC/api/input

Functions for manipulating the mouse cursor's position.

```APIDOC
## POST /input/mouse/move/instant

### Description
Moves the mouse cursor instantly by the given offset relative to its current position.

### Method
POST

### Endpoint
/input/mouse/move/instant

### Parameters
#### Request Body
- **offset** (Vector2) - Required - The XY offset to move by.

### Request Example
```json
{
  "offset": {"x": 10, "y": 20}
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Errors
- **"Roblox is not focused"**: Roblox's window is not the focused window.

## POST /input/mouse/move/tween

### Description
Smoothly moves the mouse cursor to the target position over a period of time. This function yields the current thread until the move is complete.

### Method
POST

### Endpoint
/input/mouse/move/tween

### Parameters
#### Request Body
- **position** (Vector2) - Required - The target absolute XY position.
- **timeInSeconds** (number) - Required - The duration of the movement.

### Request Example
```json
{
  "position": {"x": 100, "y": 200},
  "timeInSeconds": 0.5
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Errors
- **"Roblox is not focused"**: Roblox's window is not the focused window.
- **"Time must be a positive number"**: The timeInSeconds parameter was not a positive number.

## POST /input/mouse/move/instance

### Description
Moves the mouse cursor instantly to the center of the given Roblox UI instance.

### Method
POST

### Endpoint
/input/mouse/move/instance

### Parameters
#### Request Body
- **instance** (Instance) - Required - The GuiObject to target.

### Request Example
```json
{
  "instance": "rbxassetid://123456789"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Errors
- **"Roblox is not focused"**: Roblox's window is not the focused window.
- **"Instance must be a valid UI Instance"**: The object was not an Instance object of type GuiObject.
- **"Instance is not visible or has no absolute position"**: The GuiObject was not visible or had no absolute position.

## POST /input/mouse/move/instance/tween

### Description
Smoothly moves the mouse cursor to the center of the given Roblox UI instance. This function yields the current thread until the move is complete.

### Method
POST

### Endpoint
/input/mouse/move/instance/tween

### Parameters
#### Request Body
- **instance** (Instance) - Required - The GuiObject to target.
- **timeInSeconds** (number) - Required - The duration of the movement.

### Request Example
```json
{
  "instance": "rbxassetid://123456789",
  "timeInSeconds": 0.5
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Errors
- **"Roblox is not focused"**: Roblox's window is not the focused window.
- **"Instance must be a valid UI Instance"**: The object was not an Instance object of type GuiObject.
- **"Instance is not visible or has no absolute position"**: The GuiObject was not visible or had no absolute position.
- **"Time must be a positive number"**: The timeInSeconds parameter was not a positive number.

## POST /input/mouse/click/instance

### Description
Moves the mouse cursor to the center of the given Roblox UI instance and performs a mouse click.

### Method
POST

### Endpoint
/input/mouse/click/instance

### Parameters
#### Request Body
- **instance** (Instance) - Required - The GuiObject to target.

### Request Example
```json
{
  "instance": "rbxassetid://123456789"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Errors
- **"Roblox is not focused"**: Roblox's window is not the focused window.
- **"Instance must be a valid UI Instance"**: The object was not an Instance object of type GuiObject.
- **"Instance is not visible or has no absolute position"**: The GuiObject was not visible or had no absolute position.
```

--------------------------------

### Write Signed 16-bit Integer to Memory

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 16-bit integer to a specified memory address. Requires the address and the value to write. Returns a status code indicating the success of the operation.

```lua
memory.writei16(address: number, value: number) -> number
```

--------------------------------

### Write Unsigned 32-bit Integer

Source: https://rbxcli.github.io/eUNC/api/memory

Writes an unsigned 32-bit integer to the specified memory address.

```APIDOC
## POST /memory/writeu32

### Description
Writes an unsigned 32-bit integer to the specified memory address.

### Method
POST

### Endpoint
/memory/writeu32

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 4294967295
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Write 64-bit Float to Memory

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a 64-bit floating-point number to a specified memory address. Requires the address and the value to write. Returns a status code indicating the success of the operation.

```lua
memory.writef64(address: number, value: number) -> number
```

--------------------------------

### Write Signed 8-bit Integer

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 8-bit integer to the specified memory address.

```APIDOC
## POST /memory/writei8

### Description
Writes a signed 8-bit integer to the specified memory address.

### Method
POST

### Endpoint
/memory/writei8

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 127
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Scan VTable

Source: https://rbxcli.github.io/eUNC/api/memory

Scans the Roblox PE for a VTable given the mangled name.

```APIDOC
## POST /memory/scan_vtable

### Description
Scans the Roblox PE for a VTable given the mangled name.

### Method
POST

### Endpoint
/memory/scan_vtable

### Parameters
#### Request Body
- **vtableName** (string) - Required - The name of the vtable in MANGLED form.

### Request Example
```json
{
  "vtableName": "?MyClass@@7B@?AV?$vector@HV?$allocator@H@std@@@std@@@Z"
}
```

### Response
#### Success Response (200)
- **vtableAddress** (number) - The pointer to the VTable address, may be nil if not found.

#### Response Example
```json
{
  "vtableAddress": 6000000
}
```
```

--------------------------------

### Write Signed 8-bit Integer to Memory

Source: https://rbxcli.github.io/eUNC/api/memory

Writes a signed 8-bit integer to a specified memory address. Requires the address and the value to write. Returns a status code indicating the success of the operation.

```lua
memory.writei8(address: number, value: number) -> number
```

--------------------------------

### ProcessWriteResult Library

Source: https://rbxcli.github.io/eUNC/api/ProcessWriteResult

Enumeration of status codes returned by memory write operations.

```APIDOC
## ProcessWriteResult

### Description
Defines the write result statuses for memory writing operations. All properties are read-only.

### Properties
- **PagedOut** (number) - The memory region was outside of the process's Working Set.
- **Successful** (number) - The memory write was successful.
- **Failed** (number) - The memory write failed at the API level (Kernel/Win32).
- **PartialWrite** (number) - The memory write was only completed partially, not completely (Kernel/Win32).

### Usage Example
```lua
local result = Memory.Write(address, data)
if result == ProcessWriteResult.Successful then
    print("Write completed successfully")
elseif result == ProcessWriteResult.Failed then
    warn("Write failed at kernel level")
end
```
```

--------------------------------

### Write Unsigned 16-bit Integer

Source: https://rbxcli.github.io/eUNC/api/memory

Writes an unsigned 16-bit integer to the specified memory address.

```APIDOC
## POST /memory/writeu16

### Description
Writes an unsigned 16-bit integer to the specified memory address.

### Method
POST

### Endpoint
/memory/writeu16

### Parameters
#### Request Body
- **address** (number) - Required - The address to write to.
- **value** (number) - Required - The value to write.

### Request Example
```json
{
  "address": 12345,
  "value": 65535
}
```

### Response
#### Success Response (200)
- **status_code** (number) - A status code (ProcessWriteResult).

#### Response Example
```json
{
  "status_code": 0
}
```
```

--------------------------------

### Is Valid Address

Source: https://rbxcli.github.io/eUNC/api/memory

Validates if the given address is a valid remote pointer.

```APIDOC
## POST /memory/is_valid_address

### Description
Validates if the given address is a valid remote pointer.

### Method
POST

### Endpoint
/memory/is_valid_address

### Parameters
#### Request Body
- **address** (number) - Required - The address to check.

### Request Example
```json
{
  "address": 7000000
}
```

### Response
#### Success Response (200)
- **is_valid** (boolean) - True if the address is a valid pointer in the target process.

#### Response Example
```json
{
  "is_valid": true
}
```
```
Tokens:
Raw