Mercurial > repos > IBBoard.WarFoundry.API

annotate api/Objects/UnitRequiresAtLeastNUnitsRequirement.cs @ 329:a5b34ca10d80

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #27: Define unit requirements * Update method name for a more "natural language" approach of "if (req.AllowsAdding(...))"
author IBBoard <dev@ibboard.co.uk>
date Sun, 27 Mar 2011 19:15:31 +0000
parents f8471453c3cb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
326
331995582990 Re #27: Define 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
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
331995582990 Re #27: Define 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.
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4 using System;
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System.Collections.Generic;
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.WarFoundry.API.Objects;
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 namespace IBBoard.WarFoundry.API.Objects
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 {
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 /// <summary>
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// A requirement where a Unit requires at least N units of one or more unit types before it can be taken.
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 /// </summary>
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 public class UnitRequiresAtLeastNUnitsRequirement
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 {
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 private List<UnitType> requiredTypes;
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 public UnitRequiresAtLeastNUnitsRequirement(params UnitType[] requiredUnitTypes)
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 {
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 requiredTypes = new List<UnitType>(requiredUnitTypes);
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 }
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21
329
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
22 /// <summary>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
23 /// Checks whether the supplied WarFoundryObject can be added to the supplied army.
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
24 /// </summary>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
25 /// <returns>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
26 /// <c>true</c> if the object can be added, else <c>false</c>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
27 /// </returns>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
28 /// <param name='wfObject'>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
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
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
30 /// </param>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
31 /// <param name='toArmy'>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
32 /// The army to add the object to.
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
33 /// </param>
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
34 public bool AllowsAdding(WarFoundryObject wfObject, Army toArmy)
326
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
35 {
327
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
36 bool canAdd = true;
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
37
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
38 foreach (UnitType type in requiredTypes)
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
39 {
329
a5b34ca10d80 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 328
diff changeset
40 if (toArmy.GetUnitTypeCount(type) < 1)
327
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
41 {
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
42 canAdd = false;
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
43 break;
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
44 }
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
45 }
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
46
1c32b8a1600e Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 326
diff changeset
47 return canAdd;
326
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 }
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 }
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50 }
331995582990 Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
51