RemoteCommandService¶
Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
Studio-only Team Create service; not accessible from experience scripts. Powers remote command execution: a Studio client submits Luau source, which the collaborative editing server runs inside a dedicated sandboxed thread, streaming the command's output and errors back to the client that started it.
Commands take one of two forms: a persistent command that opens a two-way channel between the client and the running code, and a one-shot command that runs once and hands back a single result or error.
While a persistent command runs, its server-side code communicates with the originating client through the members on this service: SendUpdate() pushes values to the client, GetReceivedUpdateSignal() delivers values the client sends back, GetStoppingSignal() fires when the command is stopped, and GetExecutingPlayer() identifies the collaborator who started it.
Inheritance¶
Object → Instance → RemoteCommandService
Methods¶
| Member | Signature | Summary |
|---|---|---|
ExecuteCommand |
RemoteCommandService:ExecuteCommand(code: string, args: Tuple): ExecutedRemoteCommand |
— |
ExecuteCommandAsync |
RemoteCommandService:ExecuteCommandAsync(code: string, args: Tuple): Tuple |
— |
GetExecutingPlayer |
RemoteCommandService:GetExecutingPlayer(): Player |
Returns the Player for the Studio collaborator who started the command that is currently executing. |
GetReceivedUpdateSignal |
RemoteCommandService:GetReceivedUpdateSignal(): RBXScriptSignal |
Returns a signal that fires on the server each time the Studio client that started the command sends it an update. |
GetStoppingSignal |
RemoteCommandService:GetStoppingSignal(): RBXScriptSignal |
Returns a signal that fires on the server when the command that is currently executing is being stopped. |
SendUpdate |
RemoteCommandService:SendUpdate(args: Tuple): null |
Sends a set of values from the running command back to the Studio client that started it. |
Events¶
| Member | Signature | Summary |
|---|---|---|
CommandSentFromStudio |
CommandSentFromStudio(commandId: int64, code: string, args: Tuple) |
— |
OneshotCommandErrorFromRcc |
OneshotCommandErrorFromRcc(commandId: int64, error: string) |
— |
OneshotCommandResultFromRcc |
OneshotCommandResultFromRcc(commandId: int64, args: Tuple) |
— |
OneshotCommandSentFromStudio |
OneshotCommandSentFromStudio(commandId: int64, code: string, args: Tuple) |
— |
StandardOutMessageFromRcc |
StandardOutMessageFromRcc(messageType: MessageType, message: string) |
— |
StopSentFromStudio |
StopSentFromStudio(commandId: int64) |
— |
UpdateSentFromRcc |
UpdateSentFromRcc(commandId: int64, args: Tuple) |
— |
UpdateSentFromStudio |
UpdateSentFromStudio(commandId: int64, args: Tuple) |
— |
Roblox reference: RemoteCommandService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.