Documentation
Reference

Classes

Class: PlotConnectionError

Class: PlotError

Class: PlotNotReadyError

Class: PlotOperationError

Interfaces

Interface: Channel<T>

Interface: ChannelMessage<T>

Interface: ChannelOptions

Interface: ChannelsApi

Interface: ConnectionApi

Interface: ConnectionRecoveryInfo

Interface: GameStateApi

Interface: GameStateChangedEvent<T>

Interface: GameStateSnapshotInfo<T>

Interface: LatestChannelApi

Interface: LatestChannelStatus

Interface: PartyApi

Interface: PartyPlayer

Interface: PartyPlayerAddedEvent

Interface: PartyPlayerChangedEvent

Interface: PartySnapshot

Interface: PlayerDataApi

Interface: PlayerDataChangedEvent<T>

Interface: PlayerDataSnapshot<T>

Interface: PlayerDataSnapshotInfo<T>

Interface: Plot

Interface: PlotErrorOptions

Interface: PlotReadyOptions

Interface: RealtimeApi

Interface: SnapshotInfo

Interface: SyncedAudio

Interface: SyncedAudioAnchor

Interface: SyncedAudioEndedEvent

Interface: SyncedAudioSnapshot

Interface: SyncedObjectSchema<T>

Interface: TimeApi

Interface: ToolkitApi

Interface: TypedGameStateApi<T>

Interface: TypedPlayerDataApi<T>

Types

Type Alias: ChannelDelivery

Type Alias: ConnectionStatus

Type Alias: ImmutableJson<T>

Type Alias: ImmutableSynced<T>

Type Alias: JsonArray

Type Alias: JsonObject

Type Alias: JsonPrimitive

Type Alias: JsonValue

Type Alias: PartyPlayerChangedField

Type Alias: PartyPlayerState

Type Alias: PlayerIcon

Type Alias: PlayerId

Type Alias: PlotConnectionErrorCode

Type Alias: PlotErrorCode

Type Alias: PlotOperationErrorCode

Type Alias: SnapshotReason

Type Alias: SyncedArray

Type Alias: SyncedAudioEndedReason

Type Alias: SyncedAudioMode

Type Alias: SyncedAudioOptions

Type Alias: SyncedAudioState

Type Alias: SyncedObject

Type Alias: SyncedObjectChangedPaths

Type Alias: SyncedObjectChangeReason

Type Alias: SyncedObjectPath

Type Alias: SyncedValue

Type Alias: SystemUi

Type Alias: Unsubscribe

Variables

Variable: ChannelDelivery

Variable: ConnectionStatus

Variable: PartyPlayerState

Variable: PlayerIcon

Variable: PlotErrorCode

Variable: SnapshotReason

Variable: SyncedAudioEndedReason

Variable: SyncedAudioMode

Variable: SyncedAudioState

Variable: SyncedObjectChangeReason

Variable: SystemUi

Variable: ChannelDelivery

const ChannelDelivery: Readonly<{ Latest: "latest"; Reliable: "reliable"; }>

The available delivery modes for a realtime channel.

Previous pageType Alias: Unsubscribe Next pageVariable: ConnectionStatus

ON THIS PAGE