// This file (UnitRequirementMaxNumber.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard.
//
// The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license.

using System;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Requirements
{
	public class UnitRequirementMaxNumber : UnitRequirement
	{		
		private int maxUnitCount;
		
		public UnitRequirementMaxNumber(UnitType type, int maxNumber) : base(type)
		{
			maxUnitCount = maxNumber;
		}
		
		public override string Description
		{
			get { return "You may only include up to "+maxUnitCount+" "+unitType.Name+" units in an army"; }
		}
		
		protected override AbstractFailedRequirement CanAddToArmy (Army army, UnitType type)
		{
			FailedUnitRequirement failed = null;
			
			if (army.GetUnitTypeCount(type) >= maxUnitCount)
			{
				failed = new FailedUnitRequirement(this);
			}
			
			return failed;
		}

		protected override AbstractFailedRequirement CanRemoveFromArmy (Army army, UnitType type)
		{
			return null;
		}
	}
}