@runox-game/game-engine/lib/commands/command.service.d.ts

RunoX game engine

import { IGameState } from '../models/game-state.model';
import { IPlayer } from '../models/player.model';
import { ICard } from '../models/card.model';
import { GameModes } from '../models/game-modes';
import { Observable } from 'rxjs';
/**
 * Class that serves as an entry point for invoking commands within the game
 */
export declare class CommandService {
    /**
     * Class that serves as an entry point for invoking commands within the game
     */
    constructor();
    /**
     * Invokes the necessary commands to start the game
     *
     * @param currentState - current game state
     * @param gameModes - different game modes
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    startGame(currentState: IGameState, gameModes?: GameModes): Observable<void>;
    /**
     * Invokes the necessary commands to reset the game
     *
     * @param currentState - current game state
     * @param gameModes - different game modes
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    resetGame(currentState: IGameState, gameModes?: GameModes): Observable<void>;
    /**
     * Invokes the necessary commands to add players to the game
     *
     * @param currentState - current game state
     * @param players - players to add into the game
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    addPlayers(currentState: IGameState, players: IPlayer[]): Observable<void>;
    /**
     * Invokes the necessary commands to remove a player from the game
     *
     * @param currentState - current game state
     * @param player - player to remove from the game
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    removePlayer(currentState: IGameState, player: IPlayer): Observable<void>;
    /**
     * Invokes the necessary commands to play a card
     *
     * @param currentState - current game state
     * @param playerId - identifier of the player who wants to play a card
     * @param card - card to be played
     * @param toPlayerId - identifier of the player who will receive the card
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    playCard(currentState: IGameState, playerId: string, card: ICard, toPlayerId?: string): Observable<void>;
    /**
     * Invokes the necessary commands to take a card from the deck
     *
     * @param currentState - current game state
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    takeCard(currentState: IGameState): Observable<void>;
    /**
     * Invokes the necessary commands to take a card from the deck and assign it to a random player
     *
     * @param currentState - current game state
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    takeCardToRandomPlayer(currentState: IGameState): Observable<void>;
    /**
     * Invokes the necessary commands to yell Uno
     *
     * @param currentState - current game state
     * @param playerId - identifier of the player who wants to yell Uno
     * @returns observable with the intention of being able to track the success or failure
     * of the command group invocation
     */
    yellUno(currentState: IGameState, yellerId?: string): Observable<void>;
    /**
     *  Invokes the necessary commands to switch ahdnhands between players
     * @param currentState  - current game state
     * @param player1 - player to switch his hand
     * @param player2 - player to switch his hand
     */
    switchHands(currentState: IGameState, player1: IPlayer, player2: IPlayer): Observable<void>;
}