Module matchmaking

Type declaration

• FindGameCodeServer: (gameId: number) => Endpoint<never, FindGameCodeServerResponseBody>

  • • (gameId: number): Endpoint<never, FindGameCodeServerResponseBody>

    • Used by the game to find the server that a lobby is hosted on.

      Parameters

      • gameId: number

        The game code of the lobby to find the server for.

      Returns Endpoint<never, FindGameCodeServerResponseBody>

      The server that the lobby is hosted on.

• FindHostServer: () => Endpoint<never, FindHostServerResponseBody>

  • • (): Endpoint<never, FindHostServerResponseBody>

    • Used to find a valid server that the client can connect to in order to host a game.

      Returns Endpoint<never, FindHostServerResponseBody>

      A server that the client can host a game on.

• GetToken: () => Endpoint<GetUserRequestBody, string>

  • • (): Endpoint<GetUserRequestBody, string>

    • Used to get the matchmaking token for the server.

      Returns Endpoint<GetUserRequestBody, string>

      A matchmaking token to use while connecting.

• RequestGameList: (mapBitfield: number, lang: GameKeyword, quickChat: QuickChatMode, platformFlags: number, numImpostors: number) => Endpoint<never, RequestGameListResponseBody>

  • • (mapBitfield: number, lang: GameKeyword, quickChat: QuickChatMode, platformFlags: number, numImpostors: number): Endpoint<never, RequestGameListResponseBody>

    • Request a short list of games that the client is able to connect to, filtered by certain parameters

      Parameters

      • mapBitfield: number

        Map bitfield of games to find.

      • lang: GameKeyword

        The language of games to find.

      • quickChat: QuickChatMode

        The chat mode of games to find.

      • platformFlags: number

        Crossplay bitfield for platforms to find.

      • numImpostors: number

        The number of impostors of games to find.

      Returns Endpoint<never, RequestGameListResponseBody>

      Games that the client can connect to, given the parameters.