annotate API/Objects/Requirement/UnitRequiresAtLeastNUnitsRequirement.cs @ 458:680db2462e34

Re #379: * Move GetObjectCountFromArmy(Army, OBJECT_TYPE) to top level and implement * Fix army validation for appropriate "NA" returns * Make basic "Requires..." requirements abstract so that we always need to make specific versions (e.g. UnitRequires... that knows how to check amount of units)
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Feb 2012 20:16:33 +0000
parents afc6410e4efc
children f48c49b53738
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
1 // This file (UnitRequiresAtLeastNUnitsRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
2 //
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
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.
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
4 using System;
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
5 using System.Collections.Generic;
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
6 using IBBoard.WarFoundry.API.Objects;
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
7
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
8 namespace IBBoard.WarFoundry.API.Objects.Requirement
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
9 {
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
10 /// <summary>
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
11 /// A requirement where a UnitType requires at least N units of one or more unit types before any number of that object can be taken in an army.
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
12 /// </summary>
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 454
diff changeset
13 public class UnitRequiresAtLeastNUnitsRequirement : RequiresAtLeastNUnitsRequirement<UnitType>
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
14 {
455
afc6410e4efc Re #379: Fix validation of requirements to check for unit
IBBoard <dev@ibboard.co.uk>
parents: 454
diff changeset
15 public UnitRequiresAtLeastNUnitsRequirement(UnitType requirementOn) : base(requirementOn)
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
16 {
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
17 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
18
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
19 public override Validation AllowsAdding(IWarFoundryObject wfObject, Army toArmy)
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
20 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
21 return IsApplicable(wfObject, toArmy) ? base.AllowsAdding(wfObject, toArmy) : Validation.NotApplicable;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
22 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
23
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
24 protected override bool IsApplicable(IWarFoundryObject toObject, Army toArmy)
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
25 {
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
26 return IsApplicable(toObject) || IsApplicableForRequiredType(toObject, toArmy);
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
27 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
28
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
29 protected override bool IsApplicable(IWarFoundryObject toObject)
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
30 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
31 return AllowedObject.Equals(toObject) || (toObject is Unit && AllowedObject.Equals(((Unit)toObject).UnitType));
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
32 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
33
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
34 private bool IsApplicableForRequiredType(IWarFoundryObject toObject, Army toArmy)
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
35 {
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
36 bool isApplicable = false;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
37 UnitType addedType = toObject as UnitType;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
38
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
39 if (addedType == null)
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
40 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
41 addedType = (toObject is Unit) ? ((Unit)toObject).UnitType : null;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
42 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
43
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
44 if (addedType != null && toArmy.GetUnitTypeCount(AllowedObject) > 0)
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
45 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
46 foreach (UnitCountRequirementData limit in ConstraintTypes)
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
47 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
48 if (Arrays.Contains(limit.UnitTypes, addedType))
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
49 {
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
50 isApplicable = true;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
51 break;
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
52 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
53 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
54 }
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
55
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
56 return isApplicable;
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
57 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
58
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
59 protected override int GetObjectCountFromArmy(Army toArmy, UnitType obj)
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
60 {
458
680db2462e34 Re #379:
IBBoard <dev@ibboard.co.uk>
parents: 455
diff changeset
61 return toArmy.GetUnitTypeCount(obj);
360
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
62 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
63 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
64 }
777725613edb Re #345: Add failure message to requirements
IBBoard <dev@ibboard.co.uk>
parents: 350
diff changeset
65