/*
 * Util.MiniGameInfo.cs
 * Authors: Adam Nabinger
 * Copyright (c) 2007-2008 Cornell University

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using System;

namespace Util
{
	/// <summary>
	/// An Information class, for the ColonySim to find out about any and all minigames that are available to it.
	/// More features will be added as needed.
	/// </summary>
	public abstract class MiniGameInfo : IComparable
	{
		#region Fields

		/// <summary>
		/// Represents the score that was received during the play of a mini-game
		/// </summary>
		public static MiniGameReward Reward = new MiniGameReward();

		/// <summary>
		/// Represents the score that was received during the play of a mini-game
		/// </summary>
		public static int ScoreValue = 0;

		/// <summary>
		/// Whether a mini-game has been played recently or not
		/// </summary>
		public static bool HasPlayed = true;

		/// <summary>
		/// The root directory of the mini game
		/// </summary>
		internal string RootDirectory = ProjectInfo.HomeDirectory;

		// The number of times this mini game has been prompted.
        private int mNumPrompts;

		// The number of times this mini game has been rejected.
		private int mNumRejects;
        
		// The number of times this mini game has been played.
		private int mNumPlayed;

		// The strings for the name of the icons to be used for the game
		protected string mIconUp = null;
		protected string mIconDown = null;

		// Whether the project should ever be visible in the colony sim or not
		protected bool mCSPlayable = false;

        // Some games should be flagged as lower priority than others
        protected bool mIsLowPriority = false;

		#endregion

		#region Properties

		/// <summary>
		/// The number of times this mini game has been prompted.
		/// </summary>
        public int NumPrompts
        {
            get { return mNumPrompts; }
            set { mNumPrompts = value; }
        }

		/// <summary>
		/// The number of times this mini game has been rejected.
		/// </summary>
        public int NumRejects
        {
            get { return mNumRejects; }
            set { mNumRejects = value; }
        }

		/// <summary>
		/// The number of times this mini game has been played.
		/// </summary>
        public int NumPlayed
        {
            get { return mNumPlayed; }
            set { mNumPlayed = value; }
        }

		/// <summary>
		/// The up icon for display in the colony sim for the mini game.
		/// </summary>
		public string IconUp
		{
			get { return mIconUp; }
		}

		/// <summary>
		/// The down icon for display in the colony sim for the mini game.
		/// </summary>
		public string IconDown
		{
			get { return mIconDown; }
		}

		/// <summary>
		/// Whether the game can be played in the Colony Sim or not.
		/// </summary>
		public bool CSPlayable
		{
			get { return mCSPlayable; }
		}

		/// <summary>
		/// The name that is displayed about the mini-game.
		/// </summary>
		public string DisplayName { get { return GetDisplayName(); } }

		/// <summary>
		/// Gets a reference to a new GameScreen which can be used to start
		/// a new instance of the mini-game.
		/// </summary>
		public GameScreen GameScreen
		{
			get
			{
				GameScreen game = GetGameScreen();
				game.RootDirectory = RootDirectory;
				return game;
			}
		}

        /// <summary>
        /// This data can be used in groupings of game lists when some items should be less prominent or a lower priority
        /// </summary>
        public bool IsLowPriority { get { return mIsLowPriority; } }

		#endregion

		#region Getters

		/// <summary>
		/// Returns the display name of the mini game this contains.
		/// </summary>
		/// <returns>The name of the mini game.</returns>
		protected abstract string GetDisplayName();

		/// <summary>
		/// Returns the game screen associated with this game info.
		/// </summary>
		/// <returns>The game screen.</returns>
		protected abstract GameScreen GetGameScreen();

		#endregion

        #region Comparison

        /// <summary>
        /// Used by List.Sort
        /// </summary>
        /// <param name="o"></param>
        /// <returns></returns>
        public int CompareTo(object o)
        {
            MiniGameInfo that = (MiniGameInfo)o;
            
            // Sort by priority, then alphabetically
            if (this.IsLowPriority != that.IsLowPriority)
            {
                return IsLowPriority ? 1 : -1;
            }
            else
            {
                return this.DisplayName.CompareTo(that.DisplayName);
            }
        }


        #endregion
    }
}