Class RealtimeScenes

Provides methods to load scenes from sharedb

Hierarchy

Events
- RealtimeScenes

Index

Constructors

Accessors

Methods

Constructors

constructor

new RealtimeScenes(
realtime: Realtime,
connection: RealtimeConnection,
): RealtimeScenes
Constructor
Parameters
- realtime: Realtime
  The realtime API
- connection: RealtimeConnection
  The realtime connection
Returns RealtimeScenes
Overrides Events.constructor
- Defined in submodules/editor-api/src/realtime/scenes.js:19

Accessors

current

get current(): RealtimeScene
The current scene

Returns RealtimeScene
- Defined in submodules/editor-api/src/realtime/scenes.js:72

Methods

load

load(sceneId: number): RealtimeScene
Loads a scene
Parameters
- sceneId: number
  The scene id
Returns RealtimeScene
The scene
- Defined in submodules/editor-api/src/realtime/scenes.js:33

unload

unload(sceneId: number): void
Unloads a scene
Parameters
- sceneId: number
  The scene id
Returns void
- Defined in submodules/editor-api/src/realtime/scenes.js:56