view api/Objects/Requirement/UnitRequiresAtLeastNUnitsRequirement.cs @ 335:36be56d9b9c4

Re #27: Define unit requirements * Copy and paste first requirement that does "requirement for unit type"
author IBBoard <dev@ibboard.co.uk>
date Sat, 02 Apr 2011 20:06:50 +0000
parents
children
line wrap: on
line source

// 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.Requirement
{
	/// <summary>
	/// A requirement where a UnitType requires at least N units of one or more unit types before any number of that object can be taken in an army.
	/// </summary>
	public class UnitRequiresAtLeastNUnitsRequirement : RequiresAtLeastNUnitsRequirement
	{
		private UnitType requirementOnType;

		public UnitRequiresAtLeastNUnitsRequirement(UnitType requirementOn) : base()
		{
			requirementOnType = requirementOn;
		}

		/// <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 override bool AllowsAdding(WarFoundryObject wfObject, Army toArmy)
		{
			return IsApplicable(wfObject, toArmy) ? base.ValidatesArmy(toArmy) : true;
		}

		public bool IsApplicable (WarFoundryObject wfObject, Army toArmy)
		{
			return toArmy.GetUnitTypeCount(requirementOnType) > 0 || requirementOnType.Equals(wfObject) || (wfObject is Unit && requirementOnType.Equals(((Unit)wfObject).UnitType));
		}
	}
}