Mercurial > repos > IBBoard.WarFoundry.API

annotate API/Objects/Requirement/RequiresNoMoreThanNOfUnitTypeRequirement.cs @ 343:acd390dba551

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #27: Unit requirements * First draft of "Unit requires no more than X" requirement
author IBBoard <dev@ibboard.co.uk>
date Wed, 06 Apr 2011 20:05:46 +0000
parents 407757e597f9
children 8585dfacac3b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (RequiresNoMoreThanNOfUnitTypeRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
2 //
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
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.
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4 using System;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using IBBoard.WarFoundry.API.Objects;
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
6 using System.Collections.Generic;
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
7
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
8 namespace IBBoard.WarFoundry.API.Objects.Requirement
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// A requirement where a WarFoundryObject cannot be taken in an army if more than N of a UnitType will be in the army.
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
12 /// </summary>
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
13 public class RequiresNoMoreThanNOfUnitTypeRequirement
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 private List<UnitCountRequirementData> limitedTypes;
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
16
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
17 public RequiresNoMoreThanNOfUnitTypeRequirement(params UnitType[] limitedUnitTypes)
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 limitedTypes = new List<UnitCountRequirementData>();
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 foreach (UnitType unitType in limitedUnitTypes)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 {
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
23 AddUnitTypeRequirement(unitType);
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
24 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 /// <summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28 /// Checks whether the supplied WarFoundryObject can be added to the supplied army.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30 /// <returns>
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
31 /// A <code>Validation</code> enum to show the result of the validation
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
32 /// </returns>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
33 /// <param name='wfObject'>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
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
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
35 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
36 /// <param name='toArmy'>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
37 /// The army to add the object to.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38 /// </param>
343
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 342
diff changeset
39 public virtual Validation AllowsAdding(WarFoundryObject wfObject, Army toArmy)
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40 {
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
41 Validation canAdd = Validation.Passed;
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
42
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 foreach (UnitCountRequirementData limit in limitedTypes)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45 if (toArmy.GetUnitTypeCount(limit.UnitType) > limit.Count)
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46 {
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
47 canAdd = Validation.Failed;
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 break;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50 }
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
51
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
52 return canAdd;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
53 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
54
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55 /// <summary>
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
56 /// Adds a requirement for there to be no more than maxCount of a given UnitType
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
57 /// </summary>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58 /// <param name='unitType'>
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
59 /// The unit type to limit.
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
60 /// </param>
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
61 /// <param name='minCount'>
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
62 /// The maximum number of that type that must exist.
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
63 /// </param>
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
64 public void AddUnitTypeRequirement(UnitType unitType, int maxCount)
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
65 {
342
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
66 limitedTypes.Add(new UnitCountRequirementData(unitType, maxCount));
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
67 }
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
68
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
69 /// <summary>
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
70 /// Adds a requirement for there to be none of a given UnitType
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
71 /// </summary>
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
72 /// <param name='unitType'>
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
73 /// The unit type to limit.
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
74 /// </param>
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
75 public void AddUnitTypeRequirement(UnitType unitType)
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
76 {
407757e597f9 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 341
diff changeset
77 AddUnitTypeRequirement(unitType, 0);
341
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
78 }
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
79 }
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
80 }
5f94b8a40876 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 337
diff changeset
81