// This file (UnitRequiresAtLeastNUnitsRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
// 
// The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
using System;
using System.Collections.Generic;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Objects
{
	/// <summary>
	/// A requirement where a Unit requires at least N units of one or more unit types before it can be taken.
	/// </summary>
	public class UnitRequiresAtLeastNUnitsRequirement
	{
		private List<UnitType> requiredTypes;

		public UnitRequiresAtLeastNUnitsRequirement(params UnitType[] requiredUnitTypes)
		{
			requiredTypes = new List<UnitType>(requiredUnitTypes);
		}

		/// <summary>
		/// Checks whether the supplied WarFoundryObject can be added to the supplied army.
		/// </summary>
		/// <returns>
		/// <c>true</c> if the object can be added, else <c>false</c>
		/// </returns>
		/// <param name='wfObject'>
		/// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement
		/// </param>
		/// <param name='toArmy'>
		/// The army to add the object to.
		/// </param>
		public bool AllowsAdding(WarFoundryObject wfObject, Army toArmy)
		{
			bool canAdd = true;

			foreach (UnitType type in requiredTypes)
			{
				if (toArmy.GetUnitTypeCount(type) < 1)
				{
					canAdd = false;
					break;
				}
			}

			return canAdd;
		}
	}
}