Variable gameFactoryConst

Type declaration

• getDefaultBotHandler: function

  • getDefaultBotHandler(): Handler<
        GameHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

    Returns Handler<
        GameHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

• getDefaultBotHandlerChain: function

  • getDefaultBotHandlerChain(): HandlerChain<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

    Creates a new handler chain containing only the bot handler for the game events

    Returns HandlerChain<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

• getEventHandler: function

  • getEventHandler(): EventHandlerInterface<Controllers, ResponseMessage>

    Returns EventHandlerInterface<Controllers, ResponseMessage>

• getGameDriver: function

  • getGameDriver(
        players: HandlerChain<
            GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            ControllerHandlerState<
                UnwrapProviders<
                    Omit<
                        ValidatedProviders<
                            {
                                ask: TurnControllerProvider;
                                canIHaveThat: CanIHaveThatControllerProvider;
                                deck: DeckControllerProvider;
                                hand: HandsControllerProvider;
                                melds: MeldControllerProvider;
                                score: PointsControllerProvider;
                                turn: TurnControllerProvider;
                            } & ControllersProviders<TypedDefaultControllers>,
                        >,
                        DefaultControllerKeys,
                    >,
                > & TypedDefaultControllers & DefaultControllers<
                    GameParams,
                    { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                    ResponseMessage,
                    GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
                >,
            >,
            ResponseMessage,
        >[],
        params: GameParams,
        names: string[],
        state?: ControllerState<Controllers>,
    ): GameDriver<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
        UnwrapProviders<
            Omit<
                ValidatedProviders<
                    {
                        ask: TurnControllerProvider;
                        canIHaveThat: CanIHaveThatControllerProvider;
                        deck: DeckControllerProvider;
                        hand: HandsControllerProvider;
                        melds: MeldControllerProvider;
                        score: PointsControllerProvider;
                        turn: TurnControllerProvider;
                    } & ControllersProviders<TypedDefaultControllers>,
                >,
                DefaultControllerKeys,
            >,
        > & TypedDefaultControllers & DefaultControllers<
            GameParams,
            { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
            ResponseMessage,
            GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        >,
        ResponseMessage,
        EventHandlerInterface<Controllers, ResponseMessage>,
    >

    Creates a new driver using elements from this game factory

    Parameters

    • players: HandlerChain<
          GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
          ControllerHandlerState<
              UnwrapProviders<
                  Omit<
                      ValidatedProviders<
                          {
                              ask: TurnControllerProvider;
                              canIHaveThat: CanIHaveThatControllerProvider;
                              deck: DeckControllerProvider;
                              hand: HandsControllerProvider;
                              melds: MeldControllerProvider;
                              score: PointsControllerProvider;
                              turn: TurnControllerProvider;
                          } & ControllersProviders<TypedDefaultControllers>,
                      >,
                      DefaultControllerKeys,
                  >,
              > & TypedDefaultControllers & DefaultControllers<
                  GameParams,
                  { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                  ResponseMessage,
                  GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
              >,
          >,
          ResponseMessage,
      >[]

      the players in the game
    • params: GameParams

      the params to run this game under
    • names: string[]

      the initial names of the players
    • Optionalstate: ControllerState<Controllers>

      the state to wrap

    Returns GameDriver<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
        UnwrapProviders<
            Omit<
                ValidatedProviders<
                    {
                        ask: TurnControllerProvider;
                        canIHaveThat: CanIHaveThatControllerProvider;
                        deck: DeckControllerProvider;
                        hand: HandsControllerProvider;
                        melds: MeldControllerProvider;
                        score: PointsControllerProvider;
                        turn: TurnControllerProvider;
                    } & ControllersProviders<TypedDefaultControllers>,
                >,
                DefaultControllerKeys,
            >,
        > & TypedDefaultControllers & DefaultControllers<
            GameParams,
            { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
            ResponseMessage,
            GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        >,
        ResponseMessage,
        EventHandlerInterface<Controllers, ResponseMessage>,
    >

• getGameSetup: function

  • getGameSetup(): GenericGameSetup<GameParams>

    Returns GenericGameSetup<GameParams>

• getIntermediaryHandler: function

  • getIntermediaryHandler(
        intermediary: Intermediary,
    ): Handler<
        GameHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

    Parameters

    • intermediary: Intermediary

    Returns Handler<
        GameHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

• getIntermediaryHandlerChain: function

  • getIntermediaryHandlerChain(
        intermediary: Intermediary,
    ): HandlerChain<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

    Creates a new handler chain containing the intermediary handler and the system intermediary handler

    Parameters

    • intermediary: Intermediary

    Returns HandlerChain<
        GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
        ControllerHandlerState<
            UnwrapProviders<
                Omit<
                    ValidatedProviders<
                        {
                            ask: TurnControllerProvider;
                            canIHaveThat: CanIHaveThatControllerProvider;
                            deck: DeckControllerProvider;
                            hand: HandsControllerProvider;
                            melds: MeldControllerProvider;
                            score: PointsControllerProvider;
                            turn: TurnControllerProvider;
                        } & ControllersProviders<TypedDefaultControllers>,
                    >,
                    DefaultControllerKeys,
                >,
            > & TypedDefaultControllers & DefaultControllers<
                GameParams,
                { END_GAME: "END_GAME"; START_GAME: "START_GAME" },
                ResponseMessage,
                GameHandlerParams & MessageHandlerParams & WaitingHandlerParams,
            >,
        >,
        ResponseMessage,
    >

• getProviders: function

  • getProviders(): Omit<ControllersProviders<Controllers>, DefaultControllerKeys>

    Returns Omit<ControllersProviders<Controllers>, DefaultControllerKeys>