Skip to content
rodeo

studio

local studio = require("@rodeo-client-lune/studio")

Summary

Section titled “Summary”
EntryDescription
MultiplayerTestClient
MultiplayerTestServer
OpenFileOpts
OpenOpts
OpenPlaceOpts
SaveResult
StartMultiplayerTestOpts
Studio
StudioBackend

Types

Section titled “Types”

MultiplayerTestClient

Section titled “MultiplayerTestClient”
type MultiplayerTestClient = vmMod.Vm & {
  disconnect: () -> (),
}

MultiplayerTestServer

Section titled “MultiplayerTestServer”
type MultiplayerTestServer = vmMod.Vm & {
  connectClient: () -> MultiplayerTestClient,
  close: () -> (),
}

OpenFileOpts

Section titled “OpenFileOpts”
type OpenFileOpts = {
  fflags: { string }?,
  background: boolean?,
  profile: boolean?,
  logs: string?,
  noHud: boolean?,
}

OpenOpts

Section titled “OpenOpts”
type OpenOpts = {
  fflags: { string }?,
  background: boolean?,
  profile: boolean?,
  logs: string?,
  noHud: boolean?,
}

OpenPlaceOpts

Section titled “OpenPlaceOpts”
type OpenPlaceOpts = {
  placeId: number,
  fflags: { string }?,
  background: boolean?,
  profile: boolean?,
  logs: string?,
  noHud: boolean?,
}

SaveResult

Section titled “SaveResult”
type SaveResult = {
  saved: boolean,
  path: string?,
  error: string?,
}

StartMultiplayerTestOpts

Section titled “StartMultiplayerTestOpts”
type StartMultiplayerTestOpts = {
  placeFile: string?,
  placeId: number?,
  fflags: { string }?,
  profile: boolean?,
  runId: string?,
  noHud: boolean?,
}

Studio

Section titled “Studio”
type Studio = {
  sessionGuid: string,
  backendId: string,
  editVm: vmMod.Vm,
  serverVm: vmMod.Vm?,
  clientVm: vmMod.Vm?,
  setMode: (mode: string) -> (),
  getMode: () -> string,
  save: () -> SaveResult,
  close: () -> (),
  getVms: () -> { vmMod.Vm },
}

StudioBackend

Section titled “StudioBackend”
type StudioBackend = {
  id: string,
  name: string,
  open: (opts: OpenOpts?) -> Studio,
  openPlace: (opts: OpenPlaceOpts) -> Studio,
  openFile: (path: string, opts: OpenFileOpts?) -> Studio,
  startMultiplayerTest: (opts: StartMultiplayerTestOpts?) -> MultiplayerTestServer,
}