Mercurial > repos > snowblizz-super-API-ideas
changeset 330:8ca5dd75d5b8
Re #27: Define unit requirements
* Rename class to match behaviour (no longer just units)
* Move to correct package
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 27 Mar 2011 19:36:54 +0000 |
| parents | a5b34ca10d80 |
| children | e1d1b81b192a |
| files | IBBoard.WarFoundry.API.csproj api/Objects/Requirement/RequiresAtLeastNUnitsRequirement.cs api/Objects/UnitRequiresAtLeastNUnitsRequirement.cs |
| diffstat | 3 files changed, 52 insertions(+), 52 deletions(-) [+] |
line wrap: on
line diff
--- a/IBBoard.WarFoundry.API.csproj Sun Mar 27 19:15:31 2011 +0000 +++ b/IBBoard.WarFoundry.API.csproj Sun Mar 27 19:36:54 2011 +0000 @@ -185,7 +185,7 @@ <Compile Include="api\Savers\Xml\WarFoundryXmlArmySaver.cs" /> <Compile Include="api\Savers\Xml\WarFoundryXmlGameSystemSaver.cs" /> <Compile Include="api\Savers\Xml\WarFoundryXmlFileSaver.cs" /> - <Compile Include="api\Objects\UnitRequiresAtLeastNUnitsRequirement.cs" /> + <Compile Include="api\Objects\Requirement\RequiresAtLeastNUnitsRequirement.cs" /> </ItemGroup> <ItemGroup> <Reference Include="System.Xml" />
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/Objects/Requirement/RequiresAtLeastNUnitsRequirement.cs Sun Mar 27 19:36:54 2011 +0000 @@ -0,0 +1,51 @@ +// 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 WarFoundryObject requires at least N units of one or more unit types before it can be taken in an army. + /// </summary> + public class RequiresAtLeastNUnitsRequirement + { + private List<UnitType> requiredTypes; + + public RequiresAtLeastNUnitsRequirement(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; + } + } +} +
--- a/api/Objects/UnitRequiresAtLeastNUnitsRequirement.cs Sun Mar 27 19:15:31 2011 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,51 +0,0 @@ -// 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; - } - } -} -