MonoGame.Samples/CardsStarterKit/Framework/Game/CardsGame.cs

//-----------------------------------------------------------------------------
// Cardsgame.cs
//
// Microsoft XNA Community Game Platform
// Copyright (C) Microsoft Corporation. All rights reserved.
//-----------------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;

namespace CardsFramework
{
    /// <summary>
    /// A cards-game handler
    /// </summary>
    /// <remarks>
    /// Use a singleton of a class that derives from class to empower a cards-game, while making sure
    /// to call the various methods in order to allow the implementing instance to run the game.
    /// </remarks>
    public abstract class CardsGame
    {
        protected List<GameRule> rules;
        protected List<Player> players;
        protected CardPacket dealer;

        public int MinimumPlayers { get; protected set; }
        public int MaximumPlayers { get; protected set; }

        public string Theme { get; protected set; }
        protected internal Dictionary<string, Texture2D> cardsAssets;
        public GameTable GameTable { get; protected set; }
        public SpriteFont Font { get; set; }
        public SpriteBatch SpriteBatch { get; set; }
        public Game Game { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="CardsGame"/> class.
        /// </summary>
        /// <param name="decks">The amount of decks in the game.</param>
        /// <param name="jokersInDeck">The amount of jokers in each deck.</param>
        /// <param name="suits">The suits which will appear in each deck. Multiple 
        /// values can be supplied using flags.</param>
        /// <param name="cardValues">The card values which will appear in each deck. 
        /// Multiple values can be supplied using flags.</param>
        /// <param name="minimumPlayers">The minimal amount of players 
        /// for the game.</param>
        /// <param name="maximumPlayers">The maximal amount of players 
        /// for the game.</param>
        /// <param name="tableBounds">The table bounds.</param>
        /// <param name="dealerPosition">The dealer position.</param>
        /// <param name="placeOrder">A function which translates a player's index to
        /// his rendering location on the game table.</param>
        /// <param name="theme">The name of the theme to use for the 
        /// game's assets.</param>
        /// <param name="game">The associated game object.</param>
        public CardsGame(int decks, int jokersInDeck, CardSuit suits, CardValue cardValues,
            int minimumPlayers, int maximumPlayers, GameTable gameTable, string theme, Game game)
        {
            rules = new List<GameRule>();
            players = new List<Player>();
            dealer = new CardPacket(decks, jokersInDeck, suits, cardValues);

            Game = game;
            MinimumPlayers = minimumPlayers;
            MaximumPlayers = maximumPlayers;

            this.Theme = theme;
            cardsAssets = new Dictionary<string, Texture2D>();
            GameTable = gameTable;
            GameTable.DrawOrder = -10000;
            game.Components.Add(GameTable);
        }

        /// <summary>
        /// Checks which of the game's rules need to be fired.
        /// </summary>
        public virtual void CheckRules()
        {
            for (int ruleIndex = 0; ruleIndex < rules.Count; ruleIndex++)
            {
                rules[ruleIndex].Check();
            }
        }

        /// <summary>
        /// Returns a card's value in the scope of the game.
        /// </summary>
        /// <param name="card">The card for which to return the value.</param>
        /// <returns>The card's value.</returns>        
        public virtual int CardValue(TraditionalCard card)
        {
            switch (card.Value)
            {
                case CardsFramework.CardValue.Ace:
                    return 1;
                case CardsFramework.CardValue.Two:
                    return 2;
                case CardsFramework.CardValue.Three:
                    return 3;
                case CardsFramework.CardValue.Four:
                    return 4;
                case CardsFramework.CardValue.Five:
                    return 5;
                case CardsFramework.CardValue.Six:
                    return 6;
                case CardsFramework.CardValue.Seven:
                    return 7;
                case CardsFramework.CardValue.Eight:
                    return 8;
                case CardsFramework.CardValue.Nine:
                    return 9;
                case CardsFramework.CardValue.Ten:
                    return 10;
                case CardsFramework.CardValue.Jack:
                    return 11;
                case CardsFramework.CardValue.Queen:
                    return 12;
                case CardsFramework.CardValue.King:
                    return 13;
                default:
                    throw new ArgumentException("Ambigous card value");
            }
        }

        /// <summary>
        /// Adds a player to the game.
        /// </summary>
        /// <param name="player">The player to add to the game.</param>
        public abstract void AddPlayer(Player player);

        /// <summary>
        /// Gets the player who is currently taking his turn.
        /// </summary>
        /// <returns>The currently active player.</returns>
        public abstract Player GetCurrentPlayer();

        /// <summary>
        /// Deals cards to the participating players.
        /// </summary>
        public abstract void Deal();

        /// <summary>
        /// Initializes the game lets the players start playing.
        /// </summary>
        public abstract void StartPlaying();

        /// <summary>
        /// Load the basic contents for a card game (the card assets)
        /// </summary>
        public void LoadContent()
        {
            // Initialize a full deck
            CardPacket fullDeck = new CardPacket(1, 2, CardSuit.AllSuits,
                CardsFramework.CardValue.NonJokers | CardsFramework.CardValue.Jokers);
            string assetName;

            // Load all card assets
            for (int cardIndex = 0; cardIndex < 54; cardIndex++)
            {
                assetName = UIUtility.GetCardAssetName(fullDeck[cardIndex]);
                LoadUITexture("Cards", assetName);
            }
            // Load card back picture
            LoadUITexture("Cards", "CardBack_" + Theme);

            // Load the game's font
            Font = Game.Content.Load<SpriteFont>(Path.Combine("Fonts", "Regular"));

            GameTable.Initialize();
        }

        /// <summary>
        /// Loads the UI textures for the game, taking the theme into account.
        /// </summary>
        /// <param name="folder">The asset's folder under the theme folder. For example,
        /// for an asset belonging to the "Fish" theme and which sits in 
        /// "Images\Fish\Beverages\Soda" folder under the content project, use
        /// "Beverages\Soda" as this argument's value.</param>
        /// <param name="assetName">The name of the asset.</param>
        public void LoadUITexture(string folder, string assetName)
        {
            cardsAssets.Add(assetName, Game.Content.Load<Texture2D>(Path.Combine("Images", folder, assetName)));
        }
    }
}