Mercurial > repos > IBBoard.WarFoundry.API
annotate API/Objects/Requirement/RequiresAtLeastNUnitsRequirement.cs @ 457:8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
* Rename public accessor for unit types to ConstraintTypes so that "no more than" requirements don't work with "required types"
* Remove class level version of ConstraintTypes to fall back to abstract class version
* Make sure we cascade allowedObject up through RequiresNoMoreThanNOfUnitTypeRequirement
* Rebuild UnitRequiresNoMoreThanNOfUnitTypeRequirement "IsApplicable" so that we don't get applicable for unrelated types, even if the requirement is currently in a failure state
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 26 Feb 2012 15:14:01 +0000 |
| parents | 52baffdd2ab9 |
| children | 680db2462e34 |
| rev | line source |
|---|---|
| 357 | 1 // This file (UnitRequiresAtLeastNUnitsRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
2 // |
|
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
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. |
| 357 | 4 using System; |
| 5 using System.Collections.Generic; | |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
6 using IBBoard.WarFoundry.API.Objects; |
|
359
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
7 using System.Text; |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
8 |
|
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
9 namespace IBBoard.WarFoundry.API.Objects.Requirement |
| 357 | 10 { |
| 11 /// <summary> | |
|
427
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
12 /// A requirement where a WarFoundryObject requires at least N units of any of the specified unit types before any number of that object can be taken in an army. |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
13 /// |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
14 /// The definition for how this requirement is built from a data file is defined in the <see cref="UnitRequiresAtLeastNUnitsRequirementFactory"/> class. |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
15 /// </summary> |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
16 public class RequiresAtLeastNUnitsRequirement<OBJECT_TYPE> : AbstractUnitRequirement<OBJECT_TYPE> where OBJECT_TYPE : IWarFoundryObject |
| 357 | 17 { |
|
427
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
18 public static readonly string REQUIREMENT_ID = "RequiresAtLeastNUnits"; |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
19 |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
20 public RequiresAtLeastNUnitsRequirement(OBJECT_TYPE requirementOn, params UnitType[] requiredUnitTypes) : base(requirementOn, requiredUnitTypes) |
| 357 | 21 { |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
22 //Do nothing |
| 357 | 23 } |
| 24 | |
|
427
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
25 public override string RequirementID |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
26 { |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
27 get |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
28 { |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
29 return REQUIREMENT_ID; |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
30 } |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
31 } |
|
3882b533d99d
Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
419
diff
changeset
|
32 |
|
452
b671085871b7
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
427
diff
changeset
|
33 protected override bool TypeEquals(object obj) |
| 357 | 34 { |
|
456
52baffdd2ab9
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
455
diff
changeset
|
35 RequiresAtLeastNUnitsRequirement<OBJECT_TYPE> otherReq = obj as RequiresAtLeastNUnitsRequirement<OBJECT_TYPE>; |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
36 if (!Collections.Collections.AreEqual(ConstraintTypes, otherReq.ConstraintTypes)) |
| 357 | 37 { |
| 38 return false; | |
| 39 } | |
| 40 else | |
| 41 { | |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
42 return true; |
| 357 | 43 } |
| 44 } | |
| 45 | |
| 419 | 46 public override int GetHashCode() |
| 47 { | |
| 48 int hash = 0; | |
| 49 | |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
50 foreach (UnitCountRequirementData req in ConstraintTypes) |
| 419 | 51 { |
| 52 hash += req.UnitType.GetHashCode(); | |
| 53 } | |
| 54 | |
| 55 return hash; | |
| 56 } | |
| 57 | |
| 357 | 58 /// <summary> |
| 59 /// Checks whether the supplied WarFoundryObject can be added to the supplied army. | |
| 60 /// </summary> | |
| 61 /// <returns> | |
| 62 /// A <code>Validation</code> enum to show the result of the validation | |
| 63 /// </returns> | |
| 64 /// <param name='wfObject'> | |
| 65 /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement | |
| 66 /// </param> | |
| 67 /// <param name='toArmy'> | |
| 68 /// The army to add the object to. | |
| 69 /// </param> | |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
70 public override Validation AllowsAdding(IWarFoundryObject wfObject, Army toArmy) |
| 357 | 71 { |
| 72 return IsApplicable(wfObject, toArmy) ? CheckAllowsAdding(wfObject, toArmy) : Validation.NotApplicable; | |
| 73 } | |
| 74 | |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
75 protected override bool IsApplicable(Army toArmy) |
| 357 | 76 { |
| 77 return false; | |
| 78 } | |
| 79 | |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
80 protected override bool IsApplicable(IWarFoundryObject toObject) |
| 357 | 81 { |
| 82 bool isApplicable = false; | |
| 83 UnitType unitType = GetUnitTypeFromObject(toObject); | |
| 84 | |
| 85 if (unitType != null) | |
| 86 { | |
| 87 isApplicable = IsApplicable(unitType); | |
| 88 } | |
| 89 | |
| 90 return isApplicable; | |
| 91 } | |
| 92 | |
|
452
b671085871b7
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
427
diff
changeset
|
93 private bool IsApplicable(UnitType unitType) |
| 357 | 94 { |
| 95 bool isApplicable = false; | |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
96 foreach (UnitCountRequirementData requirement in ConstraintTypes) |
| 357 | 97 { |
| 98 if (requirement.UnitType.Equals(unitType)) | |
| 99 { | |
| 100 isApplicable = true; | |
| 101 break; | |
| 102 } | |
| 103 } | |
| 104 return isApplicable; | |
| 105 } | |
| 106 | |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
107 private Validation CheckAllowsAdding(IWarFoundryObject wfObject, Army toArmy) |
| 357 | 108 { |
| 109 Validation isValid = Validation.Passed; | |
| 110 | |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
111 foreach (UnitCountRequirementData requirement in ConstraintTypes) |
| 357 | 112 { |
| 113 if (GetUnitTypeCount(toArmy, requirement.UnitType, wfObject) < requirement.Count) | |
| 114 { | |
| 115 isValid = Validation.Failed; | |
| 116 break; | |
| 117 } | |
| 118 } | |
| 119 | |
| 120 return isValid; | |
| 121 } | |
| 122 | |
| 123 /// <summary> | |
| 124 /// Adds a requirement for there to be at least minCount of a given UnitType | |
| 125 /// </summary> | |
| 126 /// <param name='unitType'> | |
| 127 /// The unit type to require. | |
| 128 /// </param> | |
| 129 /// <param name='minCount'> | |
| 130 /// The minimum number of that type that must exist. | |
| 131 /// </param> | |
| 132 public void AddUnitTypeRequirement(UnitType unitType, int minCount) | |
| 133 { | |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
134 ConstraintTypes.Add(new UnitCountRequirementData(unitType, minCount)); |
| 357 | 135 } |
| 136 | |
| 137 /// <summary> | |
| 138 /// Adds a requirement for there to be one or more of a given UnitType | |
| 139 /// </summary> | |
| 140 /// <param name='unitType'> | |
| 141 /// The unit type to require. | |
| 142 /// </param> | |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
143 public override void AddUnitTypeRequirement(UnitType unitType) |
| 357 | 144 { |
| 145 AddUnitTypeRequirement(unitType, 1); | |
| 146 } | |
| 147 | |
| 148 /// <summary> | |
| 149 /// Checks whether the supplied army is currently valid according to this requirement. | |
| 150 /// </summary> | |
| 151 /// <returns> | |
| 152 /// A <code>Validation</code> enum to show the result of the validation | |
| 153 /// </returns> | |
| 154 /// <param name='toValidate'> | |
| 155 /// The army to validate | |
| 156 /// </param> | |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
157 public override Validation ValidatesArmy(Army toValidate) |
| 357 | 158 { |
| 159 Validation isValid = Validation.Passed; | |
| 160 | |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
161 foreach (UnitCountRequirementData requirement in ConstraintTypes) |
| 357 | 162 { |
| 163 if (toValidate.GetUnitTypeCount(requirement.UnitType) < requirement.Count) | |
| 164 { | |
| 165 isValid = Validation.Failed; | |
| 166 break; | |
| 167 } | |
| 168 } | |
| 169 | |
| 170 return isValid; | |
| 171 } | |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
172 |
|
453
dace3b7779ca
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
452
diff
changeset
|
173 protected override string GetFailedRequirementsString(Army army) |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
174 { |
|
453
dace3b7779ca
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
452
diff
changeset
|
175 return String.Join("; ", GetFailedRequirements(army).ToArray()); |
|
359
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
176 } |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
177 |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
178 private List<string> GetFailedRequirements(Army army) |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
179 { |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
180 List<string> failures = new List<string>(); |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
181 |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
182 foreach (UnitCountRequirementData requirement in ConstraintTypes) |
|
359
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
183 { |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
184 int unitCount = army.GetUnitTypeCount(requirement.UnitType); |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
185 |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
186 if (unitCount < requirement.Count) |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
187 { |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
188 failures.Add(requirement.Count + " × " + requirement.UnitType.Name + " (have " + unitCount + ")"); |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
189 } |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
190 } |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
191 |
|
2a9c046be55a
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
358
diff
changeset
|
192 return failures; |
|
358
dbe7ccb1e557
Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
357
diff
changeset
|
193 } |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
194 |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
195 protected override string GetFailedAddingRequirementsString(IWarFoundryObject toAdd, Army toArmy) |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
196 { |
|
453
dace3b7779ca
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
452
diff
changeset
|
197 return String.Join("; ", GetFailedAddingRequirements(toAdd, toArmy).ToArray()); |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
198 } |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
199 |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
200 private List<string> GetFailedAddingRequirements(IWarFoundryObject toAdd, Army army) |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
201 { |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
202 List<string> failures = new List<string>(); |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
203 |
|
457
8e01c3174cc3
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
456
diff
changeset
|
204 foreach (UnitCountRequirementData requirement in ConstraintTypes) |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
205 { |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
206 int unitCount = GetUnitTypeCount(army, requirement.UnitType, toAdd); |
|
364
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
207 |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
208 if (unitCount < requirement.Count) |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
209 { |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
210 failures.Add(requirement.Count + " × " + requirement.UnitType.Name + " (would have " + unitCount + ")"); |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
211 } |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
212 } |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
213 |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
214 return failures; |
|
0dd8dbe8afe9
Fixes #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents:
360
diff
changeset
|
215 } |
|
455
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
216 |
|
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
217 protected override int GetObjectCountFromArmy(Army toArmy) |
|
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
218 { |
|
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
219 return 0; |
|
afc6410e4efc
Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents:
453
diff
changeset
|
220 } |
|
337
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
221 } |
|
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
222 } |
|
3c4a6403a88c
* Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff
changeset
|
223 |