Class WebrtcMultiplayerController<MessageData>

constructor

• new WebrtcMultiplayerController<MessageData extends JsonCompatibleValue = any>(
      gameId: string,
      multiplayerApi: Readonly<
          RestVirApi<
              ServiceDefinition<
                  "multiplayer-service",
                  {
                      "/": {
                          methods: { GET: true };
                          requestDataShape: undefined;
                          requiredClientOrigin: {};
                          responseDataShape: ShapeExact<readonly ["ok"]>;
                      };
                      "/health": {
                          methods: { GET: true };
                          requestDataShape: undefined;
                          requiredClientOrigin: {};
                          responseDataShape: ShapeExact<readonly ["ok"]>;
                      };
                      "/rooms": {
                          methods: { GET: true };
                          requestDataShape: undefined;
                          responseDataShape: ShapeDefinition<
                              ShapeIndexedKeys<
                                  [
                                      {
                                          keys: CustomSpecifier<
                                              `${(...)}-${(...)}-${(...)}-${(...)}-${(...)}`,
                                          >;
                                          required: false;
                                          values: ShapeDefinition<
                                              {
                                                  clientCount: ...;
                                                  hasRoomPassword: ...;
                                                  roomId: ...;
                                                  roomName: ...;
                                              },
                                              false,
                                          >;
                                      },
                                  ],
                              >,
                              false,
                          >;
                          searchParamsShape: { gameId: ShapeTuple<[string]> };
                      };
                  },
                  {
                      "/connect": {
                          messageFromClientShape: ShapeOr<
                              [
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              ShapeDefinition<(...), (...)>,
                                              { data: ...; type: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              ShapeDefinition<(...), (...)>,
                                              { clientSecret: ...; roomPassword: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              ShapeDefinition<(...), (...)>,
                                              {
                                                  clientCount: ...;
                                                  clientSecret: ...;
                                                  roomPassword: ...;
                                                  type: ...;
                                              },
                                          ],
                                      >,
                                      false,
                                  >,
                              ],
                          >;
                          messageFromHostShape: ShapeOr<
                              [
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              ShapeDefinition<(...), (...)>,
                                              { data: ...; type: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              ShapeDefinition<(...), (...)>,
                                              { data: ...; type: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              { hostClientId: ...; type: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                                  ShapeDefinition<
                                      ShapeAnd<
                                          [
                                              ShapeDefinition<(...), (...)>,
                                              { errorMessage: ...; type: ... },
                                          ],
                                      >,
                                      false,
                                  >,
                              ],
                          >;
                          searchParamsShape: { gameId: ShapeTuple<[string]> };
                      };
                  },
              >,
          >,
      >,
      stunServerUrls: readonly string[],
      multiplayerRoom: Readonly<RoomInput>,
      clientId?: `${string}-${string}-${string}-${string}-${string}`,
      shouldAllowConnectionCheck?: ShouldAllowConnectionCheck<
          WebrtcMultiplayerController<MessageData>,
      >,
  ): WebrtcMultiplayerController<MessageData>

  Type Parameters

  • MessageData extends JsonCompatibleValue = any

  Parameters

  • gameId: string
  • multiplayerApi: Readonly<
        RestVirApi<
            ServiceDefinition<
                "multiplayer-service",
                {
                    "/": {
                        methods: { GET: true };
                        requestDataShape: undefined;
                        requiredClientOrigin: {};
                        responseDataShape: ShapeExact<readonly ["ok"]>;
                    };
                    "/health": {
                        methods: { GET: true };
                        requestDataShape: undefined;
                        requiredClientOrigin: {};
                        responseDataShape: ShapeExact<readonly ["ok"]>;
                    };
                    "/rooms": {
                        methods: { GET: true };
                        requestDataShape: undefined;
                        responseDataShape: ShapeDefinition<
                            ShapeIndexedKeys<
                                [
                                    {
                                        keys: CustomSpecifier<
                                            `${(...)}-${(...)}-${(...)}-${(...)}-${(...)}`,
                                        >;
                                        required: false;
                                        values: ShapeDefinition<
                                            {
                                                clientCount: ...;
                                                hasRoomPassword: ...;
                                                roomId: ...;
                                                roomName: ...;
                                            },
                                            false,
                                        >;
                                    },
                                ],
                            >,
                            false,
                        >;
                        searchParamsShape: { gameId: ShapeTuple<[string]> };
                    };
                },
                {
                    "/connect": {
                        messageFromClientShape: ShapeOr<
                            [
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            ShapeDefinition<(...), (...)>,
                                            { data: ...; type: ... },
                                        ],
                                    >,
                                    false,
                                >,
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            ShapeDefinition<(...), (...)>,
                                            { clientSecret: ...; roomPassword: ... },
                                        ],
                                    >,
                                    false,
                                >,
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            ShapeDefinition<(...), (...)>,
                                            {
                                                clientCount: ...;
                                                clientSecret: ...;
                                                roomPassword: ...;
                                                type: ...;
                                            },
                                        ],
                                    >,
                                    false,
                                >,
                            ],
                        >;
                        messageFromHostShape: ShapeOr<
                            [
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            ShapeDefinition<(...), (...)>,
                                            { data: ...; type: ... },
                                        ],
                                    >,
                                    false,
                                >,
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            ShapeDefinition<(...), (...)>,
                                            { data: ...; type: ... },
                                        ],
                                    >,
                                    false,
                                >,
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            { hostClientId: ...; type: ... },
                                        ],
                                    >,
                                    false,
                                >,
                                ShapeDefinition<
                                    ShapeAnd<
                                        [
                                            ShapeDefinition<(...), (...)>,
                                            { errorMessage: ...; type: ... },
                                        ],
                                    >,
                                    false,
                                >,
                            ],
                        >;
                        searchParamsShape: { gameId: ShapeTuple<[string]> };
                    };
                },
            >,
        >,
    >
  • stunServerUrls: readonly string[]
    • 'stun.l.google.com:19302'
    • 'stun.stunprotocol.org'
    • 'stun.cloudflare.com:3478'
  • multiplayerRoom: Readonly<RoomInput>
  • clientId: `${string}-${string}-${string}-${string}-${string}` = ...

    The randomized client id for this controller and client.
  • shouldAllowConnectionCheck: ShouldAllowConnectionCheck<WebrtcMultiplayerController<MessageData>> = ...

    This is fired when a WebRTC peer attempts to connect to the host client (this will only be fired if your client is the host). Return true to accept the connection. Return false to reject it.

    Default

    accept all connections
    Copy

  Returns WebrtcMultiplayerController<MessageData>

ReadonlyclientId

ReadonlyhostClientId

ReadonlyisDestroyed

ReadonlymultiplayerRoom

ReadonlystunServerUrls

destroy

• destroy(): void

  Destroy this controller and clean everything up.

  Returns void

getAllClientIds

• getAllClientIds(): `${string}-${string}-${string}-${string}-${string}`[]

  Get all room client ids.

  • For host clients, this will indicate how many clients are connected to the room, including the host client itself.
  • For non-host clients, this will only list the host's client.

  For host clients, this includes the host client id whereas WebrtcMultiplayerController.getConnectedClientIds does not.

  Returns `${string}-${string}-${string}-${string}-${string}`[]

getConnectedClientIds

• getConnectedClientIds(): `${string}-${string}-${string}-${string}-${string}`[]

  Get all connected client ids.

  • For host clients, this will indicate how many member clients are connected to the host client, not including the host itself.
  • For non-host clients, this will only list the host's client.

  For host clients, this does ont include the host client id whereas WebrtcMultiplayerController.getAllClientIds does.

  Returns `${string}-${string}-${string}-${string}-${string}`[]

initConnection

• initConnection(): Promise<boolean>

  Call this to connect to the multiplayer server.

  Returns Promise<boolean>

  Whether or not the connection was initialized (it won't be initialized, for example, if the WebRTC connections already exist).

isConnected

• isConnected(): boolean

  Indicates whether ths client is connected to a multiplayer room.

  Returns boolean

isHost

• isHost(): boolean

  If this controller is the host, it'll behave differently:

  • Hosts hold WebRTC connections to all clients (non-hosts only hold a WebRTC connection to the host).
  • Hosts hold a WebSocket connection to the signal server so they can receive more clients at any time.

  Returns boolean

sendMessage

• sendMessage(data: Readonly<MessageData>): void

  Send a message to the room participants.

  • If the current client is the room host, this message is sent to all other room clients.
  • If the current client is just a room member (not the host), the message is sent to the host.

  Parameters

  • data: Readonly<MessageData>

  Returns void

sendToOnlyOneClient

• sendToOnlyOneClient(
      clientId: `${string}-${string}-${string}-${string}-${string}`,
      data: Readonly<MessageData>,
  ): void

  Send a message to just a single client. This is only allowed on a host client.

  Parameters

  • clientId: `${string}-${string}-${string}-${string}-${string}`
  • data: Readonly<MessageData>

  Returns void