run_on_actor

run_on_actor(actor: Actor | thread, source: string, ...: any) -> ()

Compiles and runs a string of Luau source inside an actor’s Lua state. The first argument may be an Actor instance from getactors or a thread handle from getactorthreads. Extra arguments are deep-copied into the actor and arrive as the chunk’s varargs. The code runs with Athena’s full environment, so functions like getgc and getgenv work inside it. Call this from a serial context, not a parallel phase.

Parameters

Actor or thread

required

The actor instance or thread handle to run on.

string

required

The Luau source to run.

any

Arguments copied into the actor as varargs.

Example

local actor = getactors()[1]
run_on_actor(actor, [[
    print("inside the actor:", ...)
]], "hello")

Errors

Message	Condition
`Actor expected`	The first argument was neither an Actor nor an actor thread.
`an actor thread from getactorthreads or getdeletedactors was expected`	A thread argument was not a valid actor handle.
`run_on_actor cannot schedule from a parallel phase`	Called from inside a parallel phase.
`the Actor has no active Lua state`	The actor has no running state to schedule on.

run_on_thread: target a state by its thread.
create_comm_channel: talk back from the actor.

Getting Started

Environment

Closures

Scripts

Reflection

Metatable

Instances

Cache

Signals

Signal

Actors

LuaStateProxy

Console

Input

Drawing

Filesystem

Encoding

Crypt

HTTP

WebSocket

RakNet

Miscellaneous

oth

Parameters

Example

Errors

​Parameters

​Example

​Errors

​Related

Parameters

Example

Errors

Related