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

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
children c19e61262400
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
343
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (UnitRequiresAtLeastNUnitsRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
acd390dba551 Re #27: Unit requirements
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.
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4 using System;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System.Collections.Generic;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.WarFoundry.API.Objects;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 namespace IBBoard.WarFoundry.API.Objects.Requirement
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 /// <summary>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// A requirement where a UnitType can only be taken if there are no more than N units of one or more unit in an army.
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 /// </summary>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 public class UnitRequiresNoMoreThanNOfUnitTypeRequirement : RequiresNoMoreThanNOfUnitTypeRequirement
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 private UnitType requirementOnType;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 public UnitRequiresNoMoreThanNOfUnitTypeRequirement(UnitType requirementOn) : base()
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 requirementOnType = requirementOn;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 /// <summary>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 /// Checks whether the supplied WarFoundryObject can be added to the supplied army.
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 /// </summary>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 /// <returns>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26 /// A <code>Validation</code> enum to show the result of the validation
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 /// </returns>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28 /// <param name='wfObject'>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30 /// </param>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
31 /// <param name='toArmy'>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
32 /// The army to add the object to.
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
33 /// </param>
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
34 public override Validation AllowsAdding(WarFoundryObject wfObject, Army toArmy)
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
35 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
36 return IsApplicable(wfObject, toArmy) ? base.AllowsAdding(wfObject, toArmy) : Validation.NotApplicable;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
37 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
39
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40 private bool IsApplicable(WarFoundryObject toObject, Army toArmy)
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
41 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42 return IsApplicable(toArmy) || IsApplicable(toObject);
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46 private bool IsApplicable(Army toArmy)
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
47 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 return toArmy.GetUnitTypeCount(requirementOnType) > 0;
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
51
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
52 private bool IsApplicable(WarFoundryObject toObject)
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
53 {
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
54 return requirementOnType.Equals(toObject) || (toObject is Unit && requirementOnType.Equals(((Unit)toObject).UnitType));
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
56 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
57 }
acd390dba551 Re #27: Unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58