Mercurial > repos > IBBoard.WarFoundry.API
annotate api/Objects/Requirement/RequiresAtLeastNUnitsRequirement.cs @ 332:2cb3bd9b11ea
Re #27: Define unit requirements
* Add new method for validating an existing army
* Refactor existing code into new method
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Mon, 28 Mar 2011 19:41:43 +0000 |
| parents | e1d1b81b192a |
| children | 17d8d357467e |
| rev | line source |
|---|---|
| 330 | 1 // This file (UnitRequiresAtLeastNUnitsRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard |
| 2 // | |
| 3 // 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. | |
| 4 using System; | |
| 5 using System.Collections.Generic; | |
| 6 using IBBoard.WarFoundry.API.Objects; | |
| 7 | |
|
331
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
8 namespace IBBoard.WarFoundry.API.Objects.Requirement |
| 330 | 9 { |
| 10 /// <summary> | |
| 11 /// A requirement where a WarFoundryObject requires at least N units of one or more unit types before it can be taken in an army. | |
| 12 /// </summary> | |
| 13 public class RequiresAtLeastNUnitsRequirement | |
| 14 { | |
|
331
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
15 private List<UnitCountRequirementData> requiredTypes; |
| 330 | 16 |
| 17 public RequiresAtLeastNUnitsRequirement(params UnitType[] requiredUnitTypes) | |
| 18 { | |
|
331
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
19 requiredTypes = new List<UnitCountRequirementData>(); |
|
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
20 |
|
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
21 foreach (UnitType unitType in requiredUnitTypes) |
|
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
22 { |
|
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
23 AddUnitTypeRequirement(unitType, 1); |
|
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
24 } |
| 330 | 25 } |
| 26 | |
| 27 /// <summary> | |
| 28 /// Checks whether the supplied WarFoundryObject can be added to the supplied army. | |
| 29 /// </summary> | |
| 30 /// <returns> | |
| 31 /// <c>true</c> if the object can be added, else <c>false</c> | |
| 32 /// </returns> | |
| 33 /// <param name='wfObject'> | |
| 34 /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement | |
| 35 /// </param> | |
| 36 /// <param name='toArmy'> | |
| 37 /// The army to add the object to. | |
| 38 /// </param> | |
| 39 public bool AllowsAdding(WarFoundryObject wfObject, Army toArmy) | |
| 40 { | |
|
332
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
41 return this.ValidatesArmy(toArmy); |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
42 } |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
43 |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
44 public void AddUnitTypeRequirement(UnitType unitType, int minCount) |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
45 { |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
46 requiredTypes.Add(new UnitCountRequirementData(unitType, minCount)); |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
47 } |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
48 |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
49 /// <summary> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
50 /// Checks whether the supplied army is currently valid according to this requirement. |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
51 /// </summary> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
52 /// <returns> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
53 /// <c>true</c> if the army is valid, else <c>false</c> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
54 /// </returns> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
55 /// <param name='toValidate'> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
56 /// The army to validate |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
57 /// </param> |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
58 public bool ValidatesArmy(Army toValidate) |
|
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
59 { |
| 330 | 60 bool canAdd = true; |
| 61 | |
|
331
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
62 foreach (UnitCountRequirementData requirement in requiredTypes) |
| 330 | 63 { |
|
332
2cb3bd9b11ea
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
331
diff
changeset
|
64 if (toValidate.GetUnitTypeCount(requirement.UnitType) < requirement.Count) |
| 330 | 65 { |
| 66 canAdd = false; | |
| 67 break; | |
| 68 } | |
| 69 } | |
| 70 | |
| 71 return canAdd; | |
|
331
e1d1b81b192a
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
330
diff
changeset
|
72 } |
| 330 | 73 } |
| 74 } | |
| 75 |