Class LockStepGameStateController<Action>

constructor

• new LockStepGameStateController<Action extends JsonCompatibleValue = any>(
      frameDuration:
          | undefined
          | Partial<Record<DurationUnit, undefined | number>>,
      allowMultiplayerConnectionCheck?: ShouldAllowConnectionCheck<
          LockStepGameStateController<Action>,
      >,
  ): LockStepGameStateController<Action>

  Type Parameters

  • Action extends JsonCompatibleValue = any

  Parameters

  • frameDuration: undefined | Partial<Record<DurationUnit, undefined | number>>
  • allowMultiplayerConnectionCheck: ShouldAllowConnectionCheck<LockStepGameStateController<Action>> = ...

  Returns LockStepGameStateController<Action>

clientId

ReadonlycurrentFps

act

• act(actions: readonly Action[]): void

  Perform an action for the current client.

  Parameters

  • actions: readonly Action[]

  Returns void

destroy

• destroy(): void

  Cleanup everything.

  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 LockStepGameStateController.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 LockStepGameStateController.getAllClientIds does.

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

isConnected

• isConnected(): undefined | boolean

  Checks if the current controller is connected to the room.

  Returns undefined | boolean

isHost

• isHost(): undefined | boolean

  Checks if the current controller is the room host.

  Returns undefined | boolean

multiplayerConnect

• multiplayerConnect(
      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>,
  ): Promise<boolean>

  Startup the controller in multiplayer mode and connect to a room.

  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>

  Returns Promise<boolean>

  Whether the connection was a successful or not.

  See

  LockStepGameStateController.startSingleplayer for starting the controller in singleplayer mode.

runFrame

• runFrame(actions?: readonly Action[]): void

  Manually run the next frame.

  Parameters

  • Optionalactions: readonly Action[]

  Returns void

  Throws

  Error if frameDuration has been set.

startSingleplayer

• startSingleplayer(): void

  Startup the controller in singleplayer mode.

  Returns void

  See

  LockStepGameStateController.multiplayerConnect for starting the controller in multiplayer mode.