Potassium API

https://potassium.gitbook.io/api
Admin
The Potassium API provides utilities for managing instances, including functions for caching,...
Tokens:15,282
Snippets:174
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Render Stepped Callbacks (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Retrieves a list of all callbacks that have been bound using RunService.BindToRenderStep.

```lua
<table> getrendersteppedlist()
```

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

### Get Nil Instances (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Retrieves a list of instances that are not descendants of a service provider. This is similar to getinstances but filters out service-provided instances.

```lua
<table> getnilinstances()
```

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

### Get All Scripts (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns a list of all LocalScript and ModuleScript objects present in the game. This provides a comprehensive overview of available scripts.

```lua
getscripts()
```

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

### Get Calling Script - Lua

Source: https://potassium.gitbook.io/api/environment/closures

Retrieves the BaseScript object that initiated the currently executing function. This is essential for understanding the execution context.

```lua
getcallingscript()
```

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

### Get Script Bytecode (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieves the raw Luau bytecode for a given script. This can be used for decompilation or advanced script analysis.

```lua
getscriptbytecode(script)
```

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

### Thread Identity Management

Source: https://potassium.gitbook.io/api/environment/scripts

Get the identity of the current thread and set the current thread identity.

```APIDOC
## GET /scripts/getthreadidentity

### Description
Returns the identity of the current thread.

### Method
GET

### Endpoint
/scripts/getthreadidentity

### Response
#### Success Response (200)
- **threadIdentity** (number) - The identity of the current thread.

## POST /scripts/setthreadidentity

### Description
Sets the current thread identity.

### Method
POST

### Endpoint
/scripts/setthreadidentity

### Parameters
#### Request Body
- **identity** (number) - Required - The identity to set for the current thread.

### Response
#### Success Response (200)
- **message** (string) - Indicates successful setting of thread identity.
```

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

### Get Running Scripts (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns a list of all scripts (LocalScript and ModuleScript) that are currently executing. This function is valuable for debugging and runtime analysis.

```lua
getrunningscripts()
```

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

### Get Executor Global Environment (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns the custom global environment specific to the executor. This environment contains executor-defined global variables and functions.

```lua
getgenv()
```

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

### Metatable Operations

Source: https://potassium.gitbook.io/api/environment/metatable

Functions for getting, setting, and manipulating metatables, including read-only and namecall methods.

```APIDOC
## getrawmetatable

### Description
Returns the metatable of `object`, where the `__metatable` field would normally lock the metatable.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/getrawmetatable

### Parameters
#### Query Parameters
- **object** (table) - Required - The object whose metatable to retrieve.

### Response
#### Success Response (200)
- **metatable** (table) - The metatable of the object.

#### Response Example
```json
{
  "metatable": {}
}
```

## hookmetamethod

### Description
Replaces a metamethod with a hook. Returns a function to access the original definition.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/hookmetamethod

### Parameters
#### Query Parameters
- **object** (table) - Required - The object to hook.
- **method** (string) - Required - The name of the metamethod to hook.
- **hook** (function) - Required - The function to use as the hook.

### Response
#### Success Response (200)
- **original_function** (function) - A function to access the original definition.

#### Response Example
```json
{
  "original_function": "<function>"
}
```

## getnamecallmethod

### Description
Returns the name of the method that invoked the `__namecall` metamethod.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/getnamecallmethod

### Response
#### Success Response (200)
- **method_name** (string) - The name of the `__namecall` method.

#### Response Example
```json
{
  "method_name": "__namecall"
}
```

## setnamecallmethod

### Description
Changes the name of the method that invoked the `__namecall` metamethod.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setnamecallmethod

### Parameters
#### Query Parameters
- **method** (string) - Required - The new name for the `__namecall` method.

### Response
#### Success Response (200)
- **status** (nil) - Indicates the operation was successful.

#### Response Example
```json
{
  "status": null
}
```

## isreadonly

### Description
Returns whether an object is read-only.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/isreadonly

### Parameters
#### Query Parameters
- **object** (table) - Required - The object to check.

### Response
#### Success Response (200)
- **readonly** (boolean) - True if the object is read-only, false otherwise.

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

## setrawmetatable

### Description
Sets the metatable of an object, bypassing the `__metatable` lock.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setrawmetatable

### Parameters
#### Query Parameters
- **object** (table) - Required - The object whose metatable to set.
- **metatable** (table) - Required - The new metatable for the object.

### Response
#### Success Response (200)
- **status** (nil) - Indicates the operation was successful.

#### Response Example
```json
{
  "status": null
}
```

## setreadonly

### Description
Sets whether an object is read-only.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setreadonly

### Parameters
#### Query Parameters
- **object** (table) - Required - The object to modify.
- **readonly** (boolean) - Required - Whether to set the object as read-only.

### Response
#### Success Response (200)
- **status** (nil) - Indicates the operation was successful.

#### Response Example
```json
{
  "status": null
}
```

## makewriteable

### Description
Unfreezes an object, making it writable.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/makewriteable

### Parameters
#### Query Parameters
- **object** (table) - Required - The object to unfreeze.

### Response
#### Success Response (200)
- **status** (nil) - Indicates the operation was successful.

#### Response Example
```json
{
  "status": null
}
```

## makereadonly

### Description
Freezes an object, making it read-only, bypassing `__metatable` checks.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/makereadonly

### Parameters
#### Query Parameters
- **object** (table) - Required - The object to freeze.

### Response
#### Success Response (200)
- **status** (nil) - Indicates the operation was successful.

#### Response Example
```json
{
  "status": null
}
```
```

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

### Get Loaded Module Scripts (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns a table containing all ModuleScript objects that have been loaded within the current Luau environment. This is useful for script management and analysis.

```lua
getloadedmodules()
```

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

### Get Game Client Global Environment (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieves the global environment used by the game client. This environment provides access to global functions and variables accessible by LocalScripts and ModuleScripts.

```lua
getrenv()
```

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

### Get All Actors (Lua)

Source: https://potassium.gitbook.io/api/environment/actor

Returns a table containing all actors currently present in the game. This is useful for iterating through actors or selecting specific ones for operations.

```lua
function getactors()
  -- Implementation details for returning a table of all actors
end
```

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

### Get Namecall Method (Lua)

Source: https://potassium.gitbook.io/api/environment/metatable

Retrieves the name of the method that invoked the __namecall metamethod. This is useful for understanding the context in which __namecall was triggered.

```lua
getnamecallmethod()
```

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

### Get Script Bytecode Hash (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Calculates and returns the SHA384 hash of a script's bytecode. This hash can be used for script identification and integrity checks.

```lua
getscripthash(script)
```

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

### Get All Upvalues from Function

Source: https://potassium.gitbook.io/api/environment/debug

Returns a list of all upvalues associated with a given function or stack level. This is useful for understanding variable scope and closures in Lua.

```lua
debug.getupvalues(<function | number> func)
```

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

### Get Internal Parent Instance

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Retrieves the internal parent field of a given Instance object. It takes an Instance as input and returns an Instance.

```lua
getinternalparent(instance)
```

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

### Get All Actor Threads (Lua)

Source: https://potassium.gitbook.io/api/environment/actor

Retrieves a table containing all threads that are associated with actors in the game. This function is useful for managing or inspecting actor-specific threads.

```lua
function getactorthreads()
  -- Implementation details for returning a table of all actor threads
end
```

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

### Get Lua Registry (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns the Lua registry, which is a special table containing references to various internal Lua states and functions. It typically holds functions and threads.

```lua
getreg()
```

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

### Get Thread Environment (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieves the environment associated with a specific Luau thread. This allows inspection of a thread's local and global scope.

```lua
getenv(thread)
```

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

### Get All Constants from Function

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves the entire constant table associated with a given function. This provides access to all literal values used within the function's bytecode.

```lua
debug.getconstants(<function | number> func)
```

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

### Get All Prototypes from Function

Source: https://potassium.gitbook.io/api/environment/debug

Returns a list of all function prototypes associated with a given function or stack level. This allows for deep inspection of a function's internal structure and nested functions.

```lua
debug.getprotos(<function | number> func)
```

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

### Get Current Thread Identity (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Returns a numerical identifier representing the identity of the currently executing thread. This can be used for context tracking.

```lua
getthreadidentity()
```

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

### Get Communication Channel by ID (Lua)

Source: https://potassium.gitbook.io/api/environment/actor

Retrieves a communication channel based on its numerical ID. Returns the BindableEvent if the channel exists, otherwise returns nil.

```lua
function get_comm_channel(id)
  -- Implementation details for retrieving a BindableEvent by its ID
end
```

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

### Get Debug Information for Function

Source: https://potassium.gitbook.io/api/environment/debug

Fetches detailed debugging information about a function or a specific stack level. This includes source file, function name, line number, and details about parameters and upvalues.

```lua
debug.getinfo(<function | number> func)
```

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

### Get Feature Flag Value

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Retrieves the value of a specified feature flag (fflag). It takes a string argument representing the fflag name and returns its value of any type.

```lua
getfflag(fflag)
```

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

### Get Script Global Environment (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieves the global environment associated with a specific script. This allows access to global variables and functions not declared as local within that script.

```lua
getsenv(script)
```

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

### Get Lua Registry

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves the Lua registry, which is a special table containing global information and internal Lua states. This can be used for advanced introspection or manipulation of the Lua environment.

```lua
debug.getregistry()
```

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

### Get Garbage Collector List (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieves a list of objects currently managed by the Luau garbage collector. An optional boolean argument can exclude tables from the returned list.

```lua
getgc(includetables)
```

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

### Get Specific Prototype from Function

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves a specific function prototype (proto) from a given function or stack level by its index. If 'active' is true, it returns all active functions associated with the proto. Prototypes represent compiled code units.

```lua
debug.getproto(<function | number> func, <number> index, <boolean?> active)
```

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

### Get Specific Upvalue from Function

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves an upvalue (an external local variable accessible by inner functions) from a function or stack level by its index. An error is thrown if the upvalue does not exist.

```lua
debug.getupvalue(<function | number> func, <number> index)
```

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

### Get Raw Metatable (Lua)

Source: https://potassium.gitbook.io/api/environment/metatable

Retrieves the metatable of a given object, bypassing any restrictions imposed by the __metatable field. This function is useful for inspecting or modifying the metatable directly.

```lua
getrawmetatable(object)
```

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

### Get Specific Constant from Function

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves a specific constant from a function's constant table by its index. An error is thrown if the constant does not exist. This is useful for inspecting the compiled bytecode of a function.

```lua
debug.getconstant(<function | number> func, <number> index)
```

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

### Establish WebSocket Connection and Handle Events (Lua)

Source: https://potassium.gitbook.io/api/environment/web-sockets

Establishes a WebSocket connection to a given URL and sets up event handlers for receiving messages and connection closures. It also demonstrates sending a message and closing the connection.

```lua
local ws = WebSocket.connect("ws://localhost:8080")

ws.OnMessage:Connect(function(message)
	print(message)
end)

ws.OnClose:Connect(function()
	print("Closed")
end)

ws:Send("Hello, World!")
ws:Close()
```

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

### Get Render Property (Lua)

Source: https://potassium.gitbook.io/api/environment/drawing

Retrieves the value of a specified property from a drawing object. This function provides an alternative way to access drawing object properties, functionally equivalent to direct property access (e.g., `drawing[property]`).

```lua
getrenderproperty(<DrawingObject> drawing, <string> property)
```

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

### Get Hidden Property Value - gethiddenproperty

Source: https://potassium.gitbook.io/api/environment/instance

Retrieves the value of a hidden property from an instance, which is not accessible via standard indexing. It returns the property's value and a boolean indicating if the property was indeed hidden.

```lua
local fire = Instance.new("Fire")
print(gethiddenproperty(fire, "size_xml")) --> 5, true
print(gethiddenproperty(fire, "Size")) --> 5, false
```

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

### Get Stack Frame Value

Source: https://potassium.gitbook.io/api/environment/debug

Retrieves a value from a specific stack frame level by its index. If no index is provided, the entire stack frame is returned. This function is crucial for runtime stack inspection.

```lua
debug.getstack(<function | number> func, <number?> index)
```

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

### Input Simulation API

Source: https://potassium.gitbook.io/api/environment/input

This section details the functions available for simulating user input, including mouse movements, clicks, and checking window focus.

```APIDOC
## isrbxactive

### Description
Returns whether the game's window is in focus. Must be true for other input functions to work.

### Method
GET

### Endpoint
/input/isrbxactive

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **isrbxactive** (boolean) - True if the game window is in focus, false otherwise.

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

## mouse1click

### Description
Dispatches a left mouse button click.

### Method
POST

### Endpoint
/input/mouse1click

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mouse1press

### Description
Dispatches a left mouse button press.

### Method
POST

### Endpoint
/input/mouse1press

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mouse1release

### Description
Dispatches a left mouse button release.

### Method
POST

### Endpoint
/input/mouse1release

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mouse2click

### Description
Dispatches a right mouse button click.

### Method
POST

### Endpoint
/input/mouse2click

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mouse2press

### Description
Dispatches a right mouse button press.

### Method
POST

### Endpoint
/input/mouse2press

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mouse2release

### Description
Dispatches a right mouse button release.

### Method
POST

### Endpoint
/input/mouse2release

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mousemoveabs

### Description
Moves the mouse cursor to the specified absolute position.

### Method
POST

### Endpoint
/input/mousemoveabs

### Parameters
#### Query Parameters
None

#### Request Body
- **x** (number) - Required - The absolute X coordinate to move the mouse to.
- **y** (number) - Required - The absolute Y coordinate to move the mouse to.

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

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mousemoverel

### Description
Adjusts the mouse cursor by the specified relative amount.

### Method
POST

### Endpoint
/input/mousmoverel

### Parameters
#### Query Parameters
None

#### Request Body
- **x** (number) - Required - The relative X offset to move the mouse by.
- **y** (number) - Required - The relative Y offset to move the mouse by.

### Request Example
```json
{
  "x": 10,
  "y": -5
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

## mousescroll

### Description
Dispatches a mouse scroll by the specified number of pixels.

### Method
POST

### Endpoint
/input/mousescroll

### Parameters
#### Query Parameters
None

#### Request Body
- **pixels** (number) - Required - The number of pixels to scroll. Positive values scroll up, negative values scroll down.

### Request Example
```json
{
  "pixels": 15
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

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

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

### Running and All Scripts

Source: https://potassium.gitbook.io/api/environment/scripts

Retrieve lists of currently running scripts and all scripts present in the game.

```APIDOC
## GET /scripts/getrunningscripts

### Description
Returns a list of scripts that are currently running.

### Method
GET

### Endpoint
/scripts/getrunningscripts

### Response
#### Success Response (200)
- **runningScripts** (table<LocalScript | ModuleScript>) - A list of currently running scripts.

## GET /scripts/getscripts

### Description
Returns a list of every script in the game.

### Method
GET

### Endpoint
/scripts/getscripts

### Response
#### Success Response (200)
- **allScripts** (table<LocalScript | ModuleScript>) - A list of all scripts in the game.
```

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

### setrbxclipboard

Source: https://potassium.gitbook.io/api/environment/instance

Sets the Studio client's clipboard with provided model data.

```APIDOC
## setrbxclipboard

### Description
Sets the clipboard of the Studio client with the provided string data, typically in `rbxm` or `rbxmx` format. This allows content from the game to be pasted directly into a Studio environment.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setrbxclipboard

### Parameters
#### Request Body
- **data** (string) - Required - The model data (`rbxm` or `rbxmx`) to set on the clipboard.

### Request Example
```json
{
  "data": "<rbxm or rbxmx model data>"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Returns `true` if the clipboard was successfully set, `false` otherwise.

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

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

### Create Folder

Source: https://potassium.gitbook.io/api/environment/file-system

Creates a new directory at the specified path. If the folder already exists, the function does nothing. Does not create parent directories.

```lua
makefolder(<string> path)
```

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

### Set Studio Clipboard (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Sets the Studio client's clipboard with provided model data in 'rbxm' or 'rbxmx' format. This allows data from the game to be copied into a Studio client for pasting.

```lua
<boolean> setrbxclipboard(<string> data)
```

```lua
local data = readfile("model.rbxm")
setrbxclipboard(data) -- Can be pasted into Studio
```

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

### List Files and Folders

Source: https://potassium.gitbook.io/api/environment/file-system

Lists all files and subfolders within a specified directory path. Returns a table containing the full paths of all items in the directory.

```lua
listfiles(<string> path)
```

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

### Registry and Loaded Modules

Source: https://potassium.gitbook.io/api/environment/scripts

Access the Lua registry and retrieve a list of loaded ModuleScripts.

```APIDOC
## GET /scripts/getreg

### Description
Returns the Lua registry.

### Method
GET

### Endpoint
/scripts/getreg

### Response
#### Success Response (200)
- **luaRegistry** (table) - The Lua registry.

## GET /scripts/getloadedmodules

### Description
Returns a list of ModuleScripts that have been loaded.

### Method
GET

### Endpoint
/scripts/getloadedmodules

### Response
#### Success Response (200)
- **loadedModules** (table<ModuleScript>) - A list of loaded ModuleScripts.
```

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

### replicatesignal

Source: https://potassium.gitbook.io/api/environment/instance

Replicates a given Roblox signal on the server.

```APIDOC
## replicatesignal

### Description
Replicates a specified `RBXScriptSignal` on the server. If the signal is expected to have arguments, they must be provided in the function call.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/replicatesignal

### Parameters
#### Request Body
- **signal** (RBXScriptSignal) - Required - The signal to replicate.
- **arguments** (...) - Optional - Any arguments that the signal expects.

### Request Example
```json
{
  "signal": "game.Players.LocalPlayer.Kill",
  "arguments": []
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the signal replication (e.g., "success").

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

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

### getrendersteppedlist

Source: https://potassium.gitbook.io/api/environment/instance

Retrieves a list of all callbacks bound to the RenderStepped event.

```APIDOC
## getrendersteppedlist

### Description
Returns a table containing all callback functions that have been bound to the `RunService.BindToRenderStep` event.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/getrendersteppedlist

### Parameters
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **callbacks** (table) - A table containing all registered RenderStepped callbacks.

#### Response Example
```json
{
  "callbacks": [
    // List of callbacks
  ]
}
```
```

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

### Environment Access

Source: https://potassium.gitbook.io/api/environment/scripts

Access various environments including the executor's global environment, a specific thread's environment, the game client's global environment, and a script's global environment.

```APIDOC
## GET /scripts/getgenv

### Description
Returns the custom global environment of the executor.

### Method
GET

### Endpoint
/scripts/getgenv

### Response
#### Success Response (200)
- **globalEnvironment** (table) - The executor's global environment.

## GET /scripts/gettenv

### Description
Returns the environment of a specified thread.

### Method
GET

### Endpoint
/scripts/gettenv

### Parameters
#### Query Parameters
- **thread** (thread) - Required - The thread whose environment to retrieve.

### Response
#### Success Response (200)
- **threadEnvironment** (table) - The environment of the specified thread.

## GET /scripts/getrenv

### Description
Returns the global environment of the game client. It can be used to access global functions used by LocalScripts and ModuleScripts.

### Method
GET

### Endpoint
/scripts/getrenv

### Response
#### Success Response (200)
- **clientGlobalEnvironment** (table) - The game client's global environment.

## GET /scripts/getsenv

### Description
Returns the global environment of a given script. It can be used to access variables and functions not defined as local.

### Method
GET

### Endpoint
/scripts/getsenv

### Parameters
#### Query Parameters
- **script** (LocalScript | ModuleScript) - Required - The script whose environment to retrieve.

### Response
#### Success Response (200)
- **scriptEnvironment** (table) - The global environment of the specified script.
```

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

### setclipboard

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Copies the specified text to the system clipboard.

```APIDOC
## setclipboard

### Description
Copies the provided text content to the system clipboard, making it available for pasting elsewhere.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setclipboard

### Parameters
#### Query Parameters
None

#### Request Body
- **text** (string) - The text content to be copied to the clipboard.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "copied").

#### Response Example
```json
{
  "status": "copied"
}
```
```

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

### Simulate Touch Event - firetouchinterest

Source: https://potassium.gitbook.io/api/environment/instance

Simulates a touch event between two instances, typically parts. It takes the instance being touched, the part that is touching, and a boolean indicating whether the touch is active (true) or ended (false).

```lua
local rootPart = game.Players.LocalPlayer.Character.HumanoidRootPart
firetouchinterest(workspace.TouchPart, rootPart, true)
firetouchinterest(workspace.TouchPart, rootPart, false)
```

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

### Replicate Signal (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Replicates a given RBXScriptSignal on the server. If the signal has arguments, they must be provided during the call.

```lua
<nil> replicatesignal(<RBXScriptSignal> signal, ...)
```

```lua
replicatesignal(game.Players.LocalPlayer.Kill) --> Kills you

local sword = game.Players.LocalPlayer.Character.ClassicSword
replicatesignal(sword.Activated) --> Swings the sword
```

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

### Load Lua File as Chunk

Source: https://potassium.gitbook.io/api/environment/file-system

Loads a Lua file and compiles it into a function (chunk). It can optionally take a chunk name for error reporting. Returns the function on success or nil and an error message on failure.

```lua
loadfile(<string> path, <string?> chunkname)
```

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

### Copy Text to Clipboard

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Copies the provided string text to the system clipboard. This function takes a string argument and does not return a value.

```lua
setclipboard(text)
```

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

### Script Bytecode and Closure

Source: https://potassium.gitbook.io/api/environment/scripts

Obtain the raw Luau bytecode of a script or generate a new closure from its bytecode.

```APIDOC
## GET /scripts/getscriptbytecode

### Description
Returns the raw Luau bytecode of the given script.

### Method
GET

### Endpoint
/scripts/getscriptbytecode

### Parameters
#### Query Parameters
- **script** (LocalScript | ModuleScript) - Required - The script to get bytecode from.

### Response
#### Success Response (200)
- **bytecode** (string) - The raw Luau bytecode of the script.

## GET /scripts/getscriptclosure

### Description
Generates a new closure using the bytecode of the given script.

### Method
GET

### Endpoint
/scripts/getscriptclosure

### Parameters
#### Query Parameters
- **script** (LocalScript | ModuleScript) - Required - The script to generate a closure from.

### Response
#### Success Response (200)
- **closure** (function) - A new closure generated from the script's bytecode.
```

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

### queue_on_teleport

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Queues a script to be executed after the player teleports.

```APIDOC
## queue_on_teleport

### Description
Queues the specified script code to be executed automatically after the player successfully teleports to a different game place.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/queue_on_teleport

### Parameters
#### Query Parameters
None

#### Request Body
- **code** (string) - The Lua script code to be queued for execution.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "queued").

#### Response Example
```json
{
  "status": "queued"
}
```
```

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

### Load String - Lua

Source: https://potassium.gitbook.io/api/environment/closures

Compiles and executes a string containing Lua source code. It returns the compiled chunk or nil with an error message. The environment of the returned function is the global environment.

```lua
loadstring(source, chunkname)
```

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

### Clone Instance Reference - Potassium API

Source: https://potassium.gitbook.io/api/index

Returns a copy of the Instance reference to a given object. This is useful for managing an Instance without directly referencing it, providing a safe way to handle object references.

```Potassium API
cloneref(<Instance> object)
```

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

### Queue Script on Teleport

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Queues a script to be executed after the player teleports to a different place. It takes a string argument representing the script code.

```lua
queue_on_teleport(code)
```

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

### isscriptable

Source: https://potassium.gitbook.io/api/environment/instance

Checks if a given property of an instance is scriptable.

```APIDOC
## isscriptable

### Description
Determines if a specified property of an instance is scriptable. A property is considered scriptable if it does not have the `notscriptable` tag.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/isscriptable

### Parameters
#### Query Parameters
- **object** (Instance) - Required - The instance containing the property.
- **property** (string) - Required - The name of the property to check.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **scriptable** (boolean) - Returns `true` if the property is scriptable, `false` if it is not scriptable, or `nil` if the property does not exist.

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

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

### setscriptable

Source: https://potassium.gitbook.io/api/environment/instance

Controls whether a property of an instance is scriptable.

```APIDOC
## setscriptable

### Description
Sets the scriptability of a given property on an instance. This function allows you to enable or disable script access to a property. It returns the previous scriptability state of the property.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setscriptable

### Parameters
#### Request Body
- **object** (Instance) - Required - The instance containing the property.
- **property** (string) - Required - The name of the property to modify.
- **value** (boolean) - Required - `true` to make the property scriptable, `false` to make it non-scriptable.

### Request Example
```json
{
  "object": "<Instance>",
  "property": "Transparency",
  "value": false
}
```

### Response
#### Success Response (200)
- **previous_scriptable** (boolean) - Returns `true` if the property was scriptable before the change, `false` otherwise.

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

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

### Create Message Box

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Displays a message box to the user with specified text, caption, and flags. The function yields until the user interacts with the box and returns a number representing the user's input.

```lua
messagebox(text, caption, flags)
```

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

### setfpscap

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Sets the in-game frames per second (FPS) cap.

```APIDOC
## setfpscap

### Description
Sets the maximum frames per second (FPS) that the game will render. Setting the FPS cap to 0 disables the cap.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/setfpscap

### Parameters
#### Query Parameters
None

#### Request Body
- **fps** (number) - The desired frames per second cap. Set to 0 to disable the cap.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "fps cap set").

#### Response Example
```json
{
  "status": "fps cap set"
}
```
```

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

### Script Hash

Source: https://potassium.gitbook.io/api/environment/scripts

Calculate the SHA384 hash of a script's bytecode.

```APIDOC
## GET /scripts/getscripthash

### Description
Returns a SHA384 hash of the script's bytecode.

### Method
GET

### Endpoint
/scripts/getscripthash

### Parameters
#### Query Parameters
- **script** (LocalScript | ModuleScript) - Required - The script to hash.

### Response
#### Success Response (200)
- **hash** (string) - The SHA384 hash of the script's bytecode.
```

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

### Execute Lua File

Source: https://potassium.gitbook.io/api/environment/file-system

Loads and executes the Lua code from a specified file within a new thread. This is useful for running scripts or modules.

```lua
dofile(<string> path)
```

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

### Compare Instance Equality - Potassium API

Source: https://potassium.gitbook.io/api/index

Returns a boolean value indicating whether two objects, 'a' and 'b', reference the same Instance. This is used for checking if two variables point to the identical underlying object.

```Potassium API
compareinstances(<Instance> a, <Instance> b)
```

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

### Write File Data

Source: https://potassium.gitbook.io/api/environment/file-system

Writes provided string data to a file at the specified path. If the path points to a folder, the operation will fail. Overwrites existing content.

```lua
writefile(<string> path, <string> data)
```

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

### Create New Drawing Object (Lua)

Source: https://potassium.gitbook.io/api/environment/drawing

Creates a new drawing object of a specified type. Supported types include Line, Text, Image, Circle, Square, Quad, and Triangle. This function is the entry point for creating visual elements in the drawing system.

```lua
Drawing.new(<string> type)
```

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

### getnilinstances

Source: https://potassium.gitbook.io/api/environment/instance

Retrieves a list of all instances that are not descendants of a service provider.

```APIDOC
## getnilinstances

### Description
Returns a list of instances that are not descendants of a service provider. This is similar to `getinstances` but filters out instances associated with service providers.

### Method
GET

### Endpoint
/websites/potassium_gitbook_io_api/getnilinstances

### Parameters
None

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **instances** (table<Instance>) - A table containing instances that are not descendants of a service provider.

#### Response Example
```json
{
  "instances": [
    // List of instances
  ]
}
```
```

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

### Check Property Scriptability (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Determines if a given property of an instance is scriptable, meaning it does not have the 'notscriptable' tag. Returns true if scriptable, nil if the property does not exist.

```lua
<boolean> isscriptable(<Instance> object, <string> property)
```

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

### LZ4 Data Compression

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Compresses the provided string data using the LZ4 compression algorithm. It takes a single string argument and returns the compressed string.

```lua
lz4compress(data)
```

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

### Print Text to Console (Lua)

Source: https://potassium.gitbook.io/api/environment/console

Prints the provided string `text` to the console window. It does not add a newline character or clear existing content.

```lua
rconsoleprint(text)
```

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

### Simulate Click/Hover Event - fireclickdetector

Source: https://potassium.gitbook.io/api/environment/instance

Dispatches a click or hover event to a ClickDetector. The optional distance parameter defaults to zero if not provided. This function is useful for programmatically triggering click events on UI elements or parts.

```lua
local clickDetector = workspace.Door.Button.ClickDetector
fireclickdetector(clickDetector, 10 + math.random())
```

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

### Clone Function - Lua

Source: https://potassium.gitbook.io/api/environment/closures

Creates a new closure with the same bytecode as a given function. This allows for independent copies of functions while preserving their original behavior.

```lua
local function foo()
    print("Hello, world!")
end

local bar = clonefunction(foo)

foo() 
bar() 
print(foo == bar)
```

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

### Set Property Scriptability (Lua)

Source: https://potassium.gitbook.io/api/environment/instance

Modifies whether a given property of an instance is scriptable. Returns a boolean indicating the scriptability status prior to the change.

```lua
<boolean> setscriptable(<Instance> object, <string> property, <boolean> value)
```

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

### Create Communication Channel (Lua)

Source: https://potassium.gitbook.io/api/environment/actor

Creates a new communication channel and returns it along with a unique identifier. This channel can be used for inter-actor communication.

```lua
function create_comm_channel()
  -- Implementation details for creating a BindableEvent and returning it with an ID
end
```

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

### Check Network Ownership - isnetworkowner

Source: https://potassium.gitbook.io/api/environment/instance

Returns a boolean indicating whether a given Part instance is owned by the local player. This is crucial for determining which client has authority over a physics object.

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

### Check if Path is File

Source: https://potassium.gitbook.io/api/environment/file-system

Determines if the given path corresponds to an existing file. Returns a boolean value: true if it's a file, false otherwise.

```lua
isfile(<string> path)
```

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

### Set FPS Cap

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Sets the in-game Frames Per Second (FPS) cap. It takes a number argument representing the desired FPS. Setting the value to 0 disables the FPS cap. This function does not return a value.

```lua
setfpscap(fps)
```

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

### Identify Executor Name and Version

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Returns the name and version of the Potassium executor. This function does not take any arguments.

```lua
identifyexecutor()
```

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

### Replace Instance in Cache - Potassium API

Source: https://potassium.gitbook.io/api/index

Replaces an existing object in the Instance cache with a new object. This function takes the object to be replaced and the new object as arguments.

```Potassium API
cache.replace(<Instance> object, <Instance> newobject)
```

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

### request

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Sends an HTTP request using the specified options and returns the response.

```APIDOC
## request

### Description
Sends an HTTP request based on the provided options. This function will pause execution until the request is completed and returns the server's response.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/request

### Parameters
#### Query Parameters
None

#### Request Body
- **options** (object) - An object containing the details of the HTTP request.
  - **Url** (string) - The URL for the request.
  - **Method** (string) - The HTTP method to use (e.g., "GET", "POST", "PUT", "DELETE").
  - **Body** (string, optional) - The body of the request, if applicable.
  - **Headers** (object, optional) - A table of request headers.
  - **Cookies** (object, optional) - A table of cookies to send with the request.

### Response
#### Success Response (200)
- **HttpResponse** (object) - An object representing the HTTP response.
  - **StatusCode** (number) - The HTTP status code of the response.
  - **Body** (string) - The response body.
  - **Headers** (object) - The response headers.

#### Response Example
```json
{
  "StatusCode": 200,
  "Body": "{\"message\": \"Success\"}",
  "Headers": {
    "Content-Type": "application/json"
  }
}
```
```

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

### Read File Content

Source: https://potassium.gitbook.io/api/environment/file-system

Reads the entire content of a file into a string. Requires a valid file path as input. Returns the file's content as a string.

```lua
readfile(<string> path)
```

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

### New C Closure - Lua

Source: https://potassium.gitbook.io/api/environment/closures

Wraps a Lua function to be identified as a C closure. The resulting function behaves identically to the original but is recognized as a C-based closure.

```lua
local foo = function() return true end
local bar = newcclosure(foo)

print(bar())
```

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

### Print Warning to Console (Lua)

Source: https://potassium.gitbook.io/api/environment/console

Prints the provided string `text` as a warning message to the console window. It does not add a newline character or clear existing content.

```lua
rconsolewarn(text)
```

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

### messagebox

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Creates a message box with specified text, caption, and flags. It yields until the message box is closed.

```APIDOC
## messagebox

### Description
Creates a message box that displays the provided text with a given caption. The function pauses execution until the user interacts with the message box and returns the user's input code.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/messagebox

### Parameters
#### Query Parameters
None

#### Request Body
- **text** (string) - The message to display in the message box.
- **caption** (string) - The title of the message box window.
- **flags** (number) - Flags that control the appearance and behavior of the message box (e.g., buttons, icons).

### Response
#### Success Response (200)
- **user_input_code** (number) - A code representing the user's action (e.g., which button was clicked).

#### Response Example
```json
{
  "user_input_code": 1
}
```
```

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

### Hash Data - Lua

Source: https://potassium.gitbook.io/api/environment/crypt

Computes a hash of the input data using a specified algorithm. Supports various algorithms like 'sha1', 'sha512', 'md5', 'sha256', and others. Requires data and algorithm name as input.

```lua
crypt.hash(<string> data, <string> algo)
```

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

### Append Data to File

Source: https://potassium.gitbook.io/api/environment/file-system

Appends string data to the end of a file. If the file does not exist, it will be created. This is useful for logging or extending existing files.

```lua
appendfile(<string> path, <string> data)
```

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

### Check if Path is Folder

Source: https://potassium.gitbook.io/api/environment/file-system

Determines if the given path corresponds to an existing directory. Returns a boolean value: true if it's a folder, false otherwise.

```lua
isfolder(<string> path)
```

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

### Run Script on Actor (Lua)

Source: https://potassium.gitbook.io/api/environment/actor

Executes a given script string on a specified actor. This function allows for remote execution of code within an actor's context. It accepts additional arguments to be passed to the script.

```lua
function run_on_actor(actor, script, ...)
  -- Implementation details for running a script on an actor
end

-- Example usage:
run_on_actor(getactors()[1], [[ 
    print("Hello, world!")
]])
```

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

### Generate Script Closure (Lua)

Source: https://potassium.gitbook.io/api/environment/scripts

Creates a new function closure from the bytecode of a specified script. This allows for dynamic execution of script content.

```lua
getscriptclosure(script)
```

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

### lz4compress

Source: https://potassium.gitbook.io/api/environment/miscellaneous

Compresses data using LZ4 compression.

```APIDOC
## lz4compress

### Description
Compresses the provided string data using LZ4 compression.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/lz4compress

### Parameters
#### Query Parameters
None

#### Request Body
- **data** (string) - The string data to compress.

### Response
#### Success Response (200)
- **compressed_data** (string) - The LZ4 compressed data.

#### Response Example
```json
{
  "compressed_data": "compressed_string"
}
```
```

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

### sethiddenproperty

Source: https://potassium.gitbook.io/api/environment/instance

Sets the value of a hidden property of an instance.

```APIDOC
## sethiddenproperty

### Description
Sets the value of a hidden property on an instance that cannot be set through normal means. It returns a boolean indicating whether the property was indeed hidden.

### Method
POST

### Endpoint
/websites/potassium_gitbook_io_api/sethiddenproperty

### Parameters
#### Request Body
- **object** (Instance) - Required - The instance whose hidden property needs to be set.
- **property** (string) - Required - The name of the hidden property.
- **value** (any) - Required - The new value to set for the hidden property.

### Request Example
```json
{
  "object": "<Instance>",
  "property": "size_xml",
  "value": 15
}
```

### Response
#### Success Response (200)
- **hidden** (boolean) - Returns `true` if the property was hidden and successfully set, `false` otherwise.

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

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

### AES Encrypt String - Lua

Source: https://potassium.gitbook.io/api/environment/crypt

Encrypts a string using AES with a provided key and optional Initialization Vector (IV) and mode. If no IV is given, a random one is generated and returned. Supports CBC, ECB, CTR, CFB, OFB, and GCM modes. Defaults to CBC.

```lua
crypt.encrypt(<string> data, <string> key, <string?> iv, <string?> mode)
```

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

### Hook Metamethod (Lua)

Source: https://potassium.gitbook.io/api/environment/metatable

Replaces a metamethod of an object with a custom hook function. The hook is invoked when the metamethod would normally be called. It returns a function to access the original metamethod.

```lua
hookmetamethod(object, method, hook)
```

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

### Generate Random Bytes - Lua

Source: https://potassium.gitbook.io/api/environment/crypt

Generates a random sequence of bytes of a specified size and returns it as a Base64 encoded string using the crypt.generatebytes function. Requires a size parameter.

```lua
crypt.generatebytes(<number> size)
```

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

### Set Namecall Method (Lua)

Source: https://potassium.gitbook.io/api/environment/metatable

Sets the name of the method that will be reported when the __namecall metamethod is invoked. This allows customization of how __namecall calls are identified.

```lua
setnamecallmethod(method)
```
Tokens:
Raw