couch-kit
    Preparing search index...

    Interface GameHostConfig<S, A>

    interface GameHostConfig<S extends IGameState, A extends IAction> {
        debug?: boolean;
        devMode?: boolean;
        devServerUrl?: string;
        disconnectTimeout?: number;
        initialState: S;
        maxMessageBytes?: number;
        onError?: (error: Error) => void;
        onPlayerJoined?: (playerId: string, name: string) => void;
        onPlayerLeft?: (playerId: string) => void;
        port?: number;
        reducer: (state: S, action: A) => S;
        stateThrottleMs?: number;
        staticDir?: string;
        wsPort?: number;
    }

    Type Parameters

    Index
    debug? devMode? devServerUrl? disconnectTimeout? initialState maxMessageBytes? onError? onPlayerJoined? onPlayerLeft? port? reducer stateThrottleMs? staticDir? wsPort?
    debug?: boolean
    devMode?: boolean
    devServerUrl?: string
    disconnectTimeout?: number

    Timeout (ms) before a disconnected player is permanently removed (default: 5 minutes).

    initialState: S
    maxMessageBytes?: number

    Maximum size (in bytes) of an inbound client message. Frames larger than this are discarded before parsing (default: 256 KiB).

    onError?: (error: Error) => void

    Called when a server error occurs.

    onPlayerJoined?: (playerId: string, name: string) => void

    Called when a player successfully joins.

    onPlayerLeft?: (playerId: string) => void

    Called when a player disconnects.

    port?: number
    reducer: (state: S, action: A) => S
    stateThrottleMs?: number

    State broadcast throttle interval in milliseconds (default: 33ms, ~30fps).

    staticDir?: string
    wsPort?: number

    Settings
    Member Visibility

    On This Page
    Properties