Parallel APIs

Functions

table getactors()

Returns a list of "active" Actor instances (any connected to a Lua state).

table getactorstates()

Returns a list of LuaStateProxy objects representing all Lua states created by the engine for use by Actors.

LuaStateProxy getluastate(actor_or_script?: Instance)

Returns a LuaStateProxy for the given Actor or loaded script. If not provided, the current LuaStateProxy is returned.

LuaStateProxy getgamestate()

Returns a LuaStateProxy for the default game state.

bool checkparallel()

Returns whether this code is executing in parallel.

bool syn.run_on_actor(actor: Instance, source: string, ...any)

Schedules code to be executed on an actor's Lua state.

syn.on_actor_state_created(actor: Instance)

Fired upon actor Lua state creation, before any scripts are ran.