Mercurial > repos > IBDev-IBBoard.WarFoundry.API
view API/Objects/Requirement/RequiresNoMoreThanNOfUnitTypeRequirement.cs @ 341:5f94b8a40876
Re #27: Unit requirements
* Switch remaining unit requirement to using enum
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Mon, 04 Apr 2011 19:28:44 +0000 |
parents | 3c4a6403a88c |
children | 407757e597f9 |
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> /// A <code>Validation</code> enum to show the result of the validation /// </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 Validation AllowsAdding(WarFoundryObject wfObject, Army toArmy) { Validation canAdd = Validation.Passed; foreach (UnitCountRequirementData limit in limitedTypes) { if (toArmy.GetUnitTypeCount(limit.UnitType) > limit.Count) { canAdd = Validation.Failed; 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)); } } }