Interface IMultiplayerService

interface IMultiplayerService {
    get brackets(): BracketDefinition[];
    get match(): WatchedValue<null | Match>;
    get matchBracketDefId(): WatchedValue<null | number>;
    get matchJoinIds(): WatchedValue<string[]>;
    get matchmakingInfo(): WatchedValue<null | MatchmakingInfo>;
    acceptAndJoin(factory: IMatchHandlerFactory, signals?: MatchmakingAcceptSignals): Promise<void>;
    findMatches(bracketId: number): Promise<void>;
    leave(): Promise<void>;
    refreshBrackets(): Promise<void>;
    rejoin(matchId: string, meta: Kv<string>, factory: IMatchHandlerFactory, signals: MatchmakingAcceptSignals, retries?: number): Promise<void>;
    send(opCode: number, payload: string | Uint8Array, retries?: number): Promise<void>;
}

Index

Accessors

brackets match matchBracketDefId matchJoinIds matchmakingInfo

Methods

acceptAndJoin findMatches leave refreshBrackets rejoin send

Accessors

brackets

get brackets(): BracketDefinition[]
Returns BracketDefinition[]
- Defined in src/core/multiplayer/interfaces.ts:14

match

get match(): WatchedValue<null | Match>
Returns WatchedValue<null | Match>
- Defined in src/core/multiplayer/interfaces.ts:18

matchBracketDefId

get matchBracketDefId(): WatchedValue<null | number>
Returns WatchedValue<null | number>
- Defined in src/core/multiplayer/interfaces.ts:19

matchJoinIds

get matchJoinIds(): WatchedValue<string[]>
Returns WatchedValue<string[]>
- Defined in src/core/multiplayer/interfaces.ts:17

matchmakingInfo

get matchmakingInfo(): WatchedValue<null | MatchmakingInfo>
Returns WatchedValue<null | MatchmakingInfo>
- Defined in src/core/multiplayer/interfaces.ts:16

Methods

acceptAndJoin

acceptAndJoin(factory, signals?): Promise<void>
Parameters
- factory: IMatchHandlerFactory
- Optionalsignals: MatchmakingAcceptSignals
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:24

findMatches

findMatches(bracketId): Promise<void>
Parameters
- bracketId: number
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:23

leave

leave(): Promise<void>
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:36

refreshBrackets

refreshBrackets(): Promise<void>
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:21

rejoin

rejoin(matchId, meta, factory, signals, retries?): Promise<void>
Parameters
- matchId: string
- meta: Kv<string>
- factory: IMatchHandlerFactory
- signals: MatchmakingAcceptSignals
- Optionalretries: number
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:29

send

send(opCode, payload, retries?): Promise<void>
Parameters
- opCode: number
- payload: string | Uint8Array
- Optionalretries: number
Returns Promise<void>
- Defined in src/core/multiplayer/interfaces.ts:37