Class: StatePartition

Defined in: packages/kata-sync/src/state-partition.ts:4

Constructors

Constructor

new StatePartition(): StatePartition;

Returns

StatePartition

Methods

arriveAtSyncPoint()

arriveAtSyncPoint(
   syncPointSceneId, 
   playerId, 
   totalPlayers): boolean;

Defined in: packages/kata-sync/src/state-partition.ts:63

Mark a player as arrived at a sync point. Returns true if all expected players arrived.

Parameters

syncPointSceneId

string

playerId

string

totalPlayers

number

Returns

boolean

clearSyncPoint()

clearSyncPoint(syncPointSceneId): void;

Defined in: packages/kata-sync/src/state-partition.ts:81

Parameters

syncPointSceneId

string

Returns

void

getMode()

getMode(): MultiplayerMode;

Defined in: packages/kata-sync/src/state-partition.ts:16

Returns

MultiplayerMode

getPlayerCtx()

getPlayerCtx(playerId): Record<string, any>;

Defined in: packages/kata-sync/src/state-partition.ts:58

Parameters

playerId

string

Returns

Record<string, any>

getPlayerPosition()

getPlayerPosition(playerId): PlayerPosition;

Defined in: packages/kata-sync/src/state-partition.ts:38

Parameters

playerId

string

Returns

PlayerPosition

getPlayerSnapshot()

getPlayerSnapshot(playerId): GameStateSnapshot | undefined;

Defined in: packages/kata-sync/src/state-partition.ts:34

Parameters

playerId

string

Returns

GameStateSnapshot | undefined

getSharedCtx()

getSharedCtx(): Record<string, any>;

Defined in: packages/kata-sync/src/state-partition.ts:50

Returns

Record<string, any>

getSyncPointArrivals()

getSyncPointArrivals(syncPointSceneId): string[];

Defined in: packages/kata-sync/src/state-partition.ts:77

Parameters

syncPointSceneId

string

Returns

string[]

isSyncPointReached()

isSyncPointReached(syncPointSceneId, totalPlayers): boolean;

Defined in: packages/kata-sync/src/state-partition.ts:71

Parameters

syncPointSceneId

string

totalPlayers

number

Returns

boolean

registerSyncPoint()

registerSyncPoint(sceneId, syncPointSceneId): void;

Defined in: packages/kata-sync/src/state-partition.ts:20

Parameters

sceneId

string

syncPointSceneId

string

Returns

void

setMode()

setMode(mode): void;

Defined in: packages/kata-sync/src/state-partition.ts:12

Parameters

mode

MultiplayerMode

Returns

void

setPlayerCtx()

setPlayerCtx(playerId, ctx): void;

Defined in: packages/kata-sync/src/state-partition.ts:54

Parameters

playerId

string

ctx

Record<string, any>

Returns

void

setPlayerSnapshot()

setPlayerSnapshot(playerId, snapshot): void;

Defined in: packages/kata-sync/src/state-partition.ts:28

In branching mode, store per-player snapshots

Parameters

playerId

string

snapshot

GameStateSnapshot

Returns

void

setSharedCtx()

setSharedCtx(ctx): void;

Defined in: packages/kata-sync/src/state-partition.ts:46

Parameters

ctx

Record<string, any>

Returns

void