view api/Objects/Requirement/RequiresNoMoreThanNOfUnitTypeRequirement.cs @ 334:f56254f50ce5

Re #27: Define unit requirements * Make use of default value in "Requires at least N" * Add initial implementation of "No more than N"
author IBBoard <dev@ibboard.co.uk>
date Wed, 30 Mar 2011 19:09:28 +0000
parents
children
line wrap: on
line source

// This file (RequiresNoMoreThanNOfUnitTypeRequirement.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 IBBoard.WarFoundry.API.Objects;
using System.Collections.Generic;

namespace IBBoard.WarFoundry.API.Objects.Requirement
{
	/// <summary>
	/// A requirement where a WarFoundryObject cannot be taken in an army if more than N of a UnitType will be in the army.
	/// </summary>
	public class RequiresNoMoreThanNOfUnitTypeRequirement
	{
		private List<UnitCountRequirementData> limitedTypes;

		public RequiresNoMoreThanNOfUnitTypeRequirement(params UnitType[] limitedUnitTypes)
		{
			limitedTypes = new List<UnitCountRequirementData>();

			foreach (UnitType unitType in limitedUnitTypes)
			{
				AddUnitTypeRequirement(unitType, 0);
			}
		}

		/// <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 (UnitCountRequirementData limit in limitedTypes)
			{
				if (toArmy.GetUnitTypeCount(limit.UnitType) > limit.Count)
				{
					canAdd = false;
					break;
				}
			}

			return canAdd;
		}

		/// <summary>
		/// Adds a requirement for there to be at least minCount of a given UnitType
		/// </summary>
		/// <param name='unitType'>
		/// The unit type to require.
		/// </param>
		/// <param name='minCount'>
		/// The minimum number of that type that must exist.
		/// </param>
		public void AddUnitTypeRequirement(UnitType unitType, int minCount)
		{
			limitedTypes.Add(new UnitCountRequirementData(unitType, minCount));
		}
	}
}