Function: useKataMultiplayer() — Kata docs
Kata docs

kata-framework


Function: useKataMultiplayer()

function useKataMultiplayer(syncManager): object;

Defined in: packages/kata-react/src/useKataMultiplayer.ts:14

Parameters

syncManager

KataSyncManager

Returns

object

actions

actions: object;

actions.connect

connect: (roomId, options?) => Promise<void>;
Parameters
roomId

string

options?

any

Returns

Promise<void>

actions.disconnect

disconnect: () => void;
Returns

void

actions.makeChoice

makeChoice: (id) => void;
Parameters
id

string

Returns

void

actions.next

next: () => void;
Returns

void

actions.setChoicePolicy

setChoicePolicy: (policy) => void;
Parameters
policy

ChoicePolicy

Returns

void

actions.start

start: (id) => void;
Parameters
id

string

Returns

void

connectionState

connectionState: ConnectionState = state.connectionState;

ended

ended: boolean = state.ended;

frame

frame: KSONFrame | null = state.frame;

isAuthority

isAuthority: boolean = state.isAuthority;

players

players: PlayerInfo[] = state.players;

state

state: Record<string, any> | null;