Class GameClient

Session, plugin ve realtime lifecycle'ını tek oyun sahibi altında toplar.

Neden yazıldı: Oyun-specific adapter'ların aynı account/environment scope'unu kullanmasını ve session generation değişince eski private child binding'lerinin etkisiz kalmasını sağlar. Kullanım: Oyun bir kez createGameClient çağırır; oyun policy'si kendi adapter'ında kalır, bu sınıf yalnız generic SDK composition yapar.

Parametreler

options: GameClientOptions — mevcut PlayerClient veya oluşturma ayarları.

Hatalar

CrxError(Configuration) — hem player hem playerOptions verilirse veya ikisi de eksikse.

Index

Constructors

constructor

new GameClient(options: GameClientOptions): GameClient
PlayerClient'ı kurar veya verilen tek instance'ı composition sahibi yapar.
Parameters
- options: GameClientOptions
Returns GameClient

Accessors

player

get player(): PlayerClient
GameClient'ın tek PlayerClient sahibi.

Returns PlayerClient

realtime

get realtime(): RealtimeClient
Player'a ait tek generic realtime bağlantısı.

Returns RealtimeClient

session

get session(): PlayerSession
Player session lifecycle'ı.

Returns PlayerSession

Methods

dispose

dispose(): Promise<void>
Child façade'ları ve GameClient'ın oluşturduğu PlayerClient'ı kapatır.

Dönüş
- Promise<void> — local cleanup tamamlandığında çözülür; server logout yapmaz.
Returns Promise<void>

plugin

plugin<
    TQueries extends
        Readonly<Record<string, PluginQueryDefinition<unknown, unknown>>>,
    TCommands extends
        Readonly<Record<string, PluginCommandDefinition<unknown, unknown>>>,
    TModules extends Readonly<Record<string, PluginModuleDefinition>>,
>(
    binding: PluginBinding<TQueries, TCommands, TModules>,
    pin?: PluginCompatibilityPin,
): BoundPlugin<TQueries, TCommands, TModules>
Private generated binding'i current authenticated generation'a bağlar.

Parametreler
- binding: PluginBinding — generated plugin binding.
- pin: PluginCompatibilityPin | undefined — varsa exact release pin'i.
Dönüş
- BoundPlugin — session-scoped query/command/module descriptor façade'ı.
Hatalar
- CrxError(UpgradeRequired) — compatibility pin uyuşmazsa.
- CrxError(Auth|Disposed) — session authenticated değilse veya client kapalıysa.
Type Parameters
- TQueries extends Readonly<Record<string, PluginQueryDefinition<unknown, unknown>>>
- TCommands extends Readonly<Record<string, PluginCommandDefinition<unknown, unknown>>>
- TModules extends Readonly<Record<string, PluginModuleDefinition>>
Parameters
- binding: PluginBinding<TQueries, TCommands, TModules>
- Optionalpin: PluginCompatibilityPin
Returns BoundPlugin<TQueries, TCommands, TModules>

publicPlugin

publicPlugin<
    TQueries extends
        Readonly<Record<string, PluginQueryDefinition<unknown, unknown>>>,
    TCommands extends
        Readonly<Record<string, PluginCommandDefinition<unknown, unknown>>>,
    TModules extends Readonly<Record<string, PluginModuleDefinition>>,
>(
    binding: PluginBinding<TQueries, TCommands, TModules>,
    pin?: PluginCompatibilityPin,
): PublicBoundPlugin<TQueries, TCommands, TModules>
Public generated binding'i credential'sız query façade'sına bağlar.

Parametreler
- binding: PluginBinding — public query metadata'sı taşıyan generated binding.
- pin: PluginCompatibilityPin | undefined — varsa exact release pin'i.
Dönüş
- PublicBoundPlugin — yalnız anonymous/public query'leri taşıyan façade.
Hatalar
- CrxError(UpgradeRequired) — compatibility pin uyuşmazsa.
- CrxError(Disposed) — client kapalıysa.
Type Parameters
- TQueries extends Readonly<Record<string, PluginQueryDefinition<unknown, unknown>>>
- TCommands extends Readonly<Record<string, PluginCommandDefinition<unknown, unknown>>>
- TModules extends Readonly<Record<string, PluginModuleDefinition>>
Parameters
- binding: PluginBinding<TQueries, TCommands, TModules>
- Optionalpin: PluginCompatibilityPin
Returns PublicBoundPlugin<TQueries, TCommands, TModules>

Class GameClient

Parametreler

Hatalar

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GameClient

Accessors

player

Returns PlayerClient

realtime

Returns RealtimeClient

session

Returns PlayerSession

Methods

dispose

Dönüş

Returns Promise<void>

plugin

Parametreler

Dönüş

Hatalar

Type Parameters

Parameters

Returns BoundPlugin<TQueries, TCommands, TModules>

publicPlugin

Parametreler

Dönüş

Hatalar

Type Parameters

Parameters

Returns PublicBoundPlugin<TQueries, TCommands, TModules>

Settings

On This Page