Real

https://projectreal.gg/en/docs
Admin
Real is a Roblox script execution platform providing custom Lua runtime APIs, a script editor, and...
Tokens:156,495
Snippets:1,775
Trust Score:5.4
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### ImGuiWindow.Text example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-text

Example call with placeholder values. Passes nil as the window and "example" as the text, then prints the result.

```lua
local result = ImGuiWindow.Text(nil, "example")
print(result)
```

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

### ImGuiWindow.InputText Example Call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-inputtext

Example call with placeholder values. It passes nil for the window, a label and initial text of "example", and an empty callback function, then prints the returned ImGuiWindow object.

```lua
local result = ImGuiWindow.InputText(nil, "example", "example", function() end)
print(result)
```

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

### Example call to getinstancesbyclass

Source: https://projectreal.gg/en/docs/scripts/getinstancesbyclass

Example call with placeholder values. Prints the returned table to the console.

```lua
local result = getinstancesbyclass("example")
print(result)
```

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

### getrunningscripts example call

Source: https://projectreal.gg/en/docs/scripts/getrunningscripts

Example call with placeholder values. Calls getrunningscripts() and prints the result.

```lua
local result = getrunningscripts()
print(result)
```

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

### HttpGet example: perform a GET request

Source: https://projectreal.gg/en/docs/miscellaneous/httpget

Run a DataModel-style GET request and return the response body string. The URL must pass Real's URL restrictions. The cache parameter is set to true to enable the URL cache.

```lua
local body = game:HttpGet("https://example.com", true)
print(body)
```

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

### ImGuiWindow.SameLine signature and example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-sameline

Shows the signature and example from the ImGuiWindow.SameLine documentation. The signature declares a method that takes a single `window` argument and returns the same handle for chaining. The example call passes `nil` and immediately prints the returned value, which is a placeholder usage.

```lua
ImGuiWindow.SameLine(window: ImGuiWindow): ImGuiWindow

```

```lua
local result = ImGuiWindow.SameLine(nil)
print(result)

```

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

### Example: Call ImGuiWindow.Checkbox with placeholder values

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-checkbox

Example call using nil for window, a label string, nil for checked, and an empty callback. Prints the result.

```lua
local result = ImGuiWindow.Checkbox(nil, "example", nil, function() end)
print(result)
```

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

### ImGuiWindow.Button example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-button

Example call with placeholder values. The window argument is nil, which would raise a Lua error if the window were invalid or destroyed.

```lua
local result = ImGuiWindow.Button(nil, "example", function() end)
print(result)
```

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

### openfolderdialog example

Source: https://projectreal.gg/en/docs/filesystem/openfolderdialog

Example that opens a folder picker with a title and default path, then prints the selected folder's name and folder status, or a cancellation message.

```lua
local folder = openfolderdialog({
    title = "Choose a folder",
    defaultPath = ".",
})

if folder then
    print(folder:GetName())
    print(folder:IsFolder())
else
    print("No folder selected")
end
```

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

### getrenv Example

Source: https://projectreal.gg/en/docs/environment/getrenv

Example of calling getrenv and printing the type and raw values from the returned environment table.

```lua
local robloxEnv = getrenv()

print(type(robloxEnv))
print(rawget(robloxEnv, "_G"))
print(rawget(robloxEnv, "shared"))
```

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

### ColorPicker example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-colorpicker

Example call using placeholder values; note passing nil for window and an empty function as onChange.

```lua
local result = ImGuiWindow.ColorPicker(nil, "example", 1, 1, 1, 1, function() end)
print(result)
```

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

### rconsoleshow() Example

Source: https://projectreal.gg/en/docs/console/rconsoleshow

Example showing how to display the current Windows console window when one exists. The sequence creates a console, hides it, then shows it again.

```plaintext
rconsolecreate()
rconsolehide()
rconsoleshow()
```

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

### queue_on_teleport example usage

Source: https://projectreal.gg/en/docs/miscellaneous/queue-on-teleport

Example usage that queues a print statement to run after a later teleport initialization.

```plaintext
queue_on_teleport("print('queued after teleport')")
```

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

### ImGuiWindow.destroy Example Call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-destroy

Example call with placeholder values. Passing nil is shown, though the argument expects an ImGuiWindow object.

```lua
ImGuiWindow.destroy(nil)
```

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

### ImGuiWindow.SliderInt example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-sliderint

Example call with placeholder values. It passes nil for the window, which would raise a Lua error if executed. The result is printed to the console.

```lua
local result = ImGuiWindow.SliderInt(nil, "example", 1, 1, 1, 1)
print(result)
```

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

### Example: Create and hide console

Source: https://projectreal.gg/en/docs/console/rconsolehide

Example that creates a console with rconsolecreate() and then hides it with rconsolehide(). The hide call does not detach from or destroy the console.

```lua
rconsolecreate()
rconsolehide()
```

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

### ImGuiWindow.CollapsingHeader example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-collapsingheader

Example call with placeholder values. The content callback is invoked immediately with the same ImGuiWindow object; errors in the callback are caught and not returned. The result is the same ImGuiWindow object, allowing chained calls.

```lua
local result = ImGuiWindow.CollapsingHeader(nil, "example", function() end)
print(result)
```

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

### getcallingscript example call

Source: https://projectreal.gg/en/docs/scripts/getcallingscript

Example call with placeholder values. Assigns the result to a local variable and prints it.

```luau
local result = getcallingscript()
print(result)
```

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

### rconsoleinfo example

Source: https://projectreal.gg/en/docs/console/rconsoleinfo

Creates a console and writes a bright blue message using rconsoleinfo. The example includes rconsolecreate() to ensure a console exists.

```plaintext
rconsolecreate()
rconsoleinfo("Connected", "
")
```

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

### mousemoverel example call

Source: https://projectreal.gg/en/docs/input/mousemoverel

Example call with placeholder values, moving the mouse by a relative delta of (1, 1).

```lua
mousemoverel(1, 1)
```

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

### imgui.setvsync syntax and example call

Source: https://projectreal.gg/en/docs/imgui/imgui-setvsync

The syntax declaration shows the function signature with the enabled parameter. The example call requests vertical synchronization by passing true.

```lua
imgui.setvsync(enabled: boolean)
```

```lua
imgui.setvsync(true)
```

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

### get_comm_channel Example

Source: https://projectreal.gg/en/docs/actors/get-comm-channel

Example usage: creates a communication channel, retrieves its BindableEvent, and prints it. The event is nil if the channel ID does not exist.

```lua
local channelId = create_comm_channel()
local event = get_comm_channel(channelId)

print(event)
```

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

### SliderFloat example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-sliderfloat

Example call with placeholder values. The callback argument is passed as a number (1) instead of a function, which would be invalid in practice.

```lua
local result = ImGuiWindow.SliderFloat(nil, "example", 1, 1, 1, 1)
print(result)
```

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

### RealSignal.Fire Example

Source: https://projectreal.gg/en/docs/realsignal/realsignal-fire

Example of firing a RealSignal with a value. A callback connected via Connect receives the value and updates a total, which is then printed after Fire is called.

```lua
local signal = Signal.new()
local total = 0

signal:Connect(function(value)
    total += value
end)

signal:Fire(5)
print(total)
```

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

### setclipboard and toclipboard usage example

Source: https://projectreal.gg/en/docs/environment/setclipboard

Example usage of setclipboard and its alias toclipboard. Both write a value to the Windows clipboard as text; the first writes a string, the second writes a number.

```plaintext
setclipboard("Copied from Real")

toclipboard(12345)
```

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

### RealSignal.Wait Example

Source: https://projectreal.gg/en/docs/realsignal/realsignal-wait

Yields until the signal fires and receives the fired values. The example creates a signal, spawns a task that fires it after one second, and then waits for the signal to resume with the values.

```lua
local signal = Signal.new()

task.spawn(function()
    task.wait(1)
    signal:Fire("done", 2)
end)

local status, count = signal:Wait()
print(status, count)
```

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

### Replicate RemoteEvent signal example

Source: https://projectreal.gg/en/docs/signals/replicatesignal

Example that replicates a RemoteEvent signal with a matching argument. It gets the RemoteEvent from ReplicatedStorage and calls replicatesignal with the OnClientEvent signal and the string "hello".

```lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local remote = ReplicatedStorage:FindFirstChild("RemoteEvent")

if remote and remote:IsA("RemoteEvent") then
    replicatesignal(remote.OnClientEvent, "hello")
end
```

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

### filtergc Example: Find GC Tables by Key Filters

Source: https://projectreal.gg/en/docs/environment/filtergc

Searches live garbage-collected tables that have a key named 'RealDocsMarker' and prints a message when the marker table is found. Also demonstrates the returnOne parameter to get the first match or nil.

```lua
local marker = {
    RealDocsMarker = true,
}

local matches = filtergc("table", {
    Keys = { "RealDocsMarker" },
})

for _, value in ipairs(matches) do
    if value == marker then
        print("found marker")
        break
    end
end

local first = filtergc("table", {
    Keys = { "RealDocsMarker" },
}, true)

print(first ~= nil)
```

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

### getexecutorname usage example

Source: https://projectreal.gg/en/docs/miscellaneous/getexecutorname

Example usage of getexecutorname. It retrieves the executor name and prints it.

```lua
local name = getexecutorname()
print(name)
```

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

### getexecutorversion example

Source: https://projectreal.gg/en/docs/miscellaneous/getexecutorversion

Example usage of getexecutorversion to retrieve and print the executor version string.

```lua
local version = getexecutorversion()
print(version)
```

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

### Example call to getsignalwhitelist

Source: https://projectreal.gg/en/docs/signals/getsignalwhitelist

Example call that assigns the result of getsignalwhitelist to a local variable and prints it.

```lua
local result = getsignalwhitelist()
print(result)
```

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

### getscriptthread Example

Source: https://projectreal.gg/en/docs/scripts/getscriptthread

Example usage of getscriptthread. It finds a LuaSourceContainer descendant and prints the associated thread.

```lua
local targetScript

for _, descendant in ipairs(game:GetDescendants()) do
    if descendant:IsA("LuaSourceContainer") then
        targetScript = descendant
        break
    end
end

if targetScript then
    local thread = getscriptthread(targetScript)
    print(thread)
end
```

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

### ImGuiWindow.Separator example call

Source: https://projectreal.gg/en/docs/imgui/imguiwindow-separator

Example call with placeholder values. Calling ImGuiWindow.Separator with a nil argument is used for illustration; a valid ImGuiWindow handle from imgui.create is normally required, and invalid or destroyed windows raise a Lua error.

```lua
local result = ImGuiWindow.Separator(nil)
print(result)
```

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

### getreg example

Source: https://projectreal.gg/en/docs/debug/getreg

Example usage of getreg and its aliases to retrieve and print the type of the registry table.

```lua
local registry = getreg()

print(type(registry))
print(type(getregistry()))
print(type(debug.getreg()))
print(type(debug.getregistry()))
```

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

### setupvalue syntax

Source: https://projectreal.gg/en/docs/debug/setupvalue

Shows the function signature for setupvalue. The target can be a Lua function or a stack level, index is a one-based upvalue index, and value is the new value.

```lua
setupvalue(target: function | number, index: number, value: any)
```

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

### Clear teleport queue example

Source: https://projectreal.gg/en/docs/miscellaneous/clear-teleport-queue

Example that queues a teleport action and then clears the queue using clear_teleport_queue().

```plaintext
queue_on_teleport("print('queued after teleport')")
clear_teleport_queue()
```

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

### Example: POST request with HttpPost

Source: https://projectreal.gg/en/docs/miscellaneous/httppost

Performs a POST request to example.com with a JSON body and an X-Example header, then prints the response body. The URL must pass Real's URL restrictions. The body is returned as a string or an error string.

```luau
local body = game:HttpPost(
    "https://example.com",
    '{"hello":"world"}',
    "application/json",
    { ["X-Example"] = "Real" }
)

print(body)
```

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

### getnilinstances example call

Source: https://projectreal.gg/en/docs/instances/getnilinstances

Example call to getnilinstances with placeholder values. Assigns the result to a local variable and prints it.

```lua
local result = getnilinstances()
print(result)
```

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

### isrbxactive example call

Source: https://projectreal.gg/en/docs/input/isrbxactive

Example call to isrbxactive with placeholder values. It stores the boolean result in a variable and prints it.

```lua
local result = isrbxactive()
print(result)
```

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

### isvalidlevel example

Source: https://projectreal.gg/en/docs/debug/isvalidlevel

Example calls to isvalidlevel and its aliases validlevel, debug.isvalidlevel, and debug.validlevel, checking stack level 0.

```lua
print(isvalidlevel(0))
print(validlevel(0))
print(debug.isvalidlevel(0))
print(debug.validlevel(0))
```

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

### Create a tracked ImGui window and append controls

Source: https://projectreal.gg/en/docs/imgui/imgui-create

Creates one tracked ImGui window and appends controls to the returned ImGuiWindow userdata. The example uses methods such as Text, Separator, Checkbox, SliderFloat, InputText, ColorPicker, and CollapsingHeader. The callbacks print the values when the controls change.

```lua
local window = imgui.create("Runtime settings")

window:Text("Controls")
window:Separator()

window:Checkbox("Enabled", true, function(enabled)
    print("Enabled:", enabled)
end)

window:SliderFloat("Opacity", 0.8, 0, 1, function(value)
    print("Opacity:", value)
end)

window:InputText("Label", "Real", function(text)
    print("Label:", text)
end)

window:ColorPicker("Accent", 0.3, 0.6, 1, 1, function(red, green, blue, alpha)
    print(red, green, blue, alpha)
end)

window:CollapsingHeader("Advanced", function(section)
    section:Text("Advanced controls go here")
end)
```

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

### rconsoledestroy() Example

Source: https://projectreal.gg/en/docs/console/rconsoledestroy

Clears and hides the current console, then detaches from it. The example creates a console, prints a message, and then destroys it.

```lua
rconsolecreate()
rconsoleprint("Console closing")
rconsoledestroy()
```

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

### getcustomasset Example

Source: https://projectreal.gg/en/docs/filesystem/getcustomasset

Copies an existing workspace file into ExtraContent/<hwid>/ and prints the returned rbxasset:// string. Also demonstrates the alias getsynasset.

```lua
local path = "assets/example.txt"
writefile(path, "asset bytes")

local assetId = getcustomasset(path)
print(assetId)
print(getsynasset(path))
```

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

### ishiddenstack Example

Source: https://projectreal.gg/en/docs/closures/ishiddenstack

Example usage of ishiddenstack. It defines a local function target and prints whether it is marked as hidden.

```lua
local function target()
end

print(ishiddenstack(target))
```

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

### Example call to getloadedmodules

Source: https://projectreal.gg/en/docs/scripts/getloadedmodules

Calls getloadedmodules with true and prints the result.

```lua
local result = getloadedmodules(true)
print(result)
```

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

### List deleted actor threads example

Source: https://projectreal.gg/en/docs/actors/getdeletedactors

Example that calls getdeletedactors and iterates over the returned table to print each thread.

```lua
local deletedActorThreads = getdeletedactors()

for _, thread in ipairs(deletedActorThreads) do
    print(thread)
end
```

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

### Enumerate direct child paths with listfiles

Source: https://projectreal.gg/en/docs/filesystem/listfiles

Creates example directories and a file, then iterates over the result of listfiles to print each direct child path. Entries are not sorted and may include both files and folders.

```lua
makefolder("examples/listing")
writefile("examples/listing/config.json", "{}")
makefolder("examples/listing/nested")

for _, path in ipairs(listfiles("examples/listing")) do
    print(path)
end
```

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

### dumpstring Example - Read Decompressed Bytecode

Source: https://projectreal.gg/en/docs/scripts/dumpstring

Example that finds a LuaSourceContainer descendant and prints its decompressed bytecode using dumpstring.

```lua
local targetScript

for _, descendant in ipairs(game:GetDescendants()) do
    if descendant:IsA("LuaSourceContainer") then
        targetScript = descendant
        break
    end
end

if targetScript then
    local bytecode = dumpstring(targetScript)
    print(bytecode)
end
```

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

### Set FPS cap and read it back with getfpscap

Source: https://projectreal.gg/en/docs/miscellaneous/setfpscap

Example that sets the FPS cap to 240 and then prints the current cap using getfpscap.

```plaintext
setfpscap(240)
print(getfpscap())
```

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

### openfilesdialog Example: Select and Handle Files

Source: https://projectreal.gg/en/docs/filesystem/openfilesdialog

Example that opens the dialog with a title, default path, and extension filter, then iterates over the selected files to print their names and file status. If the dialog is cancelled, it prints 'No files selected'.

```lua
local files = openfilesdialog({
    title = "Choose source files",
    defaultPath = ".",
    extensionFilter = { "lua", "luau", "txt" },
})

if files then
    for _, file in ipairs(files) do
        print(file:GetName())
        print(file:IsFile())
    end
else
    print("No files selected")
end
```

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

### getcallbackvalue Example

Source: https://projectreal.gg/en/docs/instances/getcallbackvalue

Example of reading a callback from a BindableFunction's OnInvoke property. Creates a BindableFunction, sets OnInvoke, retrieves it, and calls it.

```lua
local bindable = Instance.new("BindableFunction")
bindable.OnInvoke = function(value)
    return value * 2
end

local callback = getcallbackvalue(bindable, "OnInvoke")
if callback then
    print(callback(21))
end
```

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

### imgui.create

Source: https://projectreal.gg/en/docs/imgui/imgui-create

Creates a tracked ImGui window record and returns an ImGuiWindow object. The title defaults to "REAL_IM_UI" when omitted or nil, and must be unique among currently tracked windows.

```APIDOC
## imgui.create

### Description
Creates a tracked ImGui window record and returns an ImGuiWindow object. The title argument defaults to "REAL_IM_UI" when omitted or nil. The title must be unique among currently tracked ImGui windows; creating another tracked window with the same title raises a Lua error.

### Syntax
```
imgui.create(title?: string): ImGuiWindow
```

### Arguments
| Name | Type | Description |
|------|------|-------------|
| `title?` | `string` | Optional window title. When omitted or nil, "REAL_IM_UI" is used. A duplicate title among currently tracked ImGui windows raises a Lua error. |

### Returns
| Name | Type | Description |
|------|------|-------------|
| `window` | `ImGuiWindow` | ImGuiWindow object with the window methods registered on its methods. |

### Example
Create one tracked ImGui window and append controls to the returned ImGuiWindow userdata.
```lua
local window = imgui.create("Runtime settings")

window:Text("Controls")
window:Separator()

window:Checkbox("Enabled", true, function(enabled)
    print("Enabled:", enabled)
end)

window:SliderFloat("Opacity", 0.8, 0, 1, function(value)
    print("Opacity:", value)
end)

window:InputText("Label", "Real", function(text)
    print("Label:", text)
end)

window:ColorPicker("Accent", 0.3, 0.6, 1, 1, function(red, green, blue, alpha)
    print(red, green, blue, alpha)
end)

window:CollapsingHeader("Advanced", function(section)
    section:Text("Advanced controls go here")
end)
```

### Types
#### ImGuiWindow
Handle returned by imgui.create. Control-building methods return the same handle so calls can be chained.

- `Button` `(label: string, onClick: () -> ()) -> ImGuiWindow` - Appends a button and queues the callback with no arguments after a click.
- `Checkbox` `(label: string, checked: any, onChange: (boolean) -> ()) -> ImGuiWindow` - Appends a checkbox initialized from the checked value.
- `CollapsingHeader` `(label: string, content: (ImGuiWindow) -> ()) -> ImGuiWindow` - Immediately runs content to append elements that render under a collapsible header.
- `ColorPicker` `(label: string, red: number?, green: number?, blue: number?, alpha: number?, onChange: (number, number, number, number) -> ()) -> ImGuiWindow` - Appends a ColorEdit4-backed RGBA editor; onChange is read from argument 7.
- `InputText` `(label: string, text: string?, onChange: (string) -> ()) -> ImGuiWindow` - Appends a single-line InputText using a fixed 256-byte buffer; onChange is argument 4.
- `SameLine` `() -> ImGuiWindow` - Appends a SameLine layout marker that calls same-line layout during rendering.
- `Separator` `() -> ImGuiWindow` - Appends a Separator marker that calls a separator during rendering.
- `SliderFloat` `(label: string, value: number, minimum: number, maximum: number, onChange: (number) -> ()) -> ImGuiWindow` - Appends a SliderFloat element and queues onChange with one Lua number when the value changes.
- `SliderInt` `(label: string, value: integer, minimum: integer, maximum: integer, onChange: (number) -> ()) -> ImGuiWindow` - Appends a SliderInt element and queues onChange with one Lua number when the integer value changes.
- `Text` `(text: string) -> ImGuiWindow` - Appends a non-interactive text element.
- `destroy` `() -> ()` - Removes the window and releases its registered callbacks.
```

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

### Example: Read hardware identifier

Source: https://projectreal.gg/en/docs/miscellaneous/gethwid

Calls gethwid() to retrieve the hardware identifier and prints it.

```lua
local hardwareId = gethwid()
print(hardwareId)
```

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

### WebSocket.connect Example

Source: https://projectreal.gg/en/docs/websocket/websocket-connect

Opens a WebSocket connection, listens for messages and close events, then sends a message and closes the socket.

```lua
local socket = WebSocket.connect("wss://example.com/socket")

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

socket.OnClose:Connect(function()
    print("closed")
end)

socket:Send("hello")
socket:Close()
```

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

### messagebox example

Source: https://projectreal.gg/en/docs/miscellaneous/messagebox

Shows a Windows message box with the text 'Real is ready.' and caption 'Real', then prints the integer result code.

```lua
local result = messagebox("Real is ready.", "Real", 0)
print(result)
```

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

### setreadonly Example

Source: https://projectreal.gg/en/docs/metatables/setreadonly

Example usage of setreadonly. It sets a table's readonly flag to true and then to false, printing the result of isreadonly after each call.

```lua
local target = {}

setreadonly(target, true)
print(isreadonly(target))

setreadonly(target, false)
print(isreadonly(target))
```

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

### Example: json.quote usage

Source: https://projectreal.gg/en/docs/json/json-quote

Example usage of json.quote to convert a string containing a newline and quotes into a complete quoted JSON string literal.

```lua
local source = "Real Docs" .. string.char(10) .. [[Documentation "A"]]
local quoted = json.quote(source)

print(quoted)
```

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

### Example: Check if workspace paths exist as directories

Source: https://projectreal.gg/en/docs/filesystem/isfolder

Creates a folder and a file, then tests `isfolder` on the folder, the file, and a missing path. The folder returns true, the file and missing path return false when printed.

```lua
local folderPath = "examples"
local filePath = "examples/config.json"

makefolder(folderPath)
writefile(filePath, "{}")

print(isfolder(folderPath))
print(isfolder(filePath))
print(isfolder("examples/missing"))
```

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

### Example: Check network ownership for a BasePart

Source: https://projectreal.gg/en/docs/instances/isnetworkowner

Example usage of isnetworkowner to check if a BasePart is network-owned. It finds a BasePart in the workspace and prints the result.

```lua
local part = workspace:FindFirstChildWhichIsA("BasePart", true)

if part then
    local ownsNetwork = isnetworkowner(part)
    print(ownsNetwork)
end
```

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

### run_on_thread(thread: thread, source: string, ...arguments?: ...any)

Source: https://projectreal.gg/en/docs/actors/run-on-thread

Documentation for the run_on_thread function, including its syntax, parameters, and an example.

```APIDOC
## run_on_thread(thread: thread, source: string, ...arguments?: ...any)

### Description
Runs Luau source on a specific Luau thread. Extra arguments after source are passed to the dispatched source when supported. The call returns no values and does not return values produced by the dispatched source. `runonthread` is an alias.

### Method
Function Call

### Signature
`run_on_thread(thread: thread, source: string, ...arguments?: ...any)`

### Parameters
- **thread** (thread) - Required - Target Luau thread used to run the source.
- **source** (string) - Required - Non-empty Luau source string to run on the target thread.
- **...arguments?** (...any) - Optional - Additional values passed to the dispatched source when supported. Unsupported values are passed as nil.

### Return Value
None. The call returns no values and does not return values produced by the dispatched source.

### Example
```lua
local thread = getactorthreads()[1]

if thread then
    run_on_thread(thread, [[
        print(getcurrentactor())
    ]])
end
```
```

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

### Read and write to executor environment

Source: https://projectreal.gg/en/docs/environment/getgenv

Demonstrates how to retrieve the environment table and perform read/write operations on it.

```lua
local env = getgenv()

env.RealDocsValue = "ready"

print(getgenv().RealDocsValue)
```

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

### RealSignal.Once Syntax

Source: https://projectreal.gg/en/docs/realsignal/realsignal-once

Shows the function signature for RealSignal.Once, which takes a RealSignal and a callback and returns a RealSignalConnection.

```lua
RealSignal.Once(signal: RealSignal, callback: (....any) -> ()): RealSignalConnection
```
Tokens:
Raw