Mercurial > repos > IBBoard.WarFoundry.API

annotate API/Factories/Requirement/UnitRequiresAtLeastNUnitsRequirementFactory.cs @ 427:3882b533d99d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #27: Define unit requirements * Add ID to requirements so that it isn't just defined in factories * Make factory use ID from requirement class to avoid duplication and possible mismatch
author IBBoard <dev@ibboard.co.uk>
date Sun, 30 Oct 2011 20:31:43 +0000
parents 04f4c2fea356
children 7b9ff7b1df24
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
371
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (UnitRequiresAtLeastNUnitsRequirementFactory.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
bfdb95906075 Re #351: Add extensible requirement handling method
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.
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4 using System;
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using IBBoard.WarFoundry.API.Objects;
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.WarFoundry.API.Objects.Requirement;
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 namespace IBBoard.WarFoundry.API.Factories.Requirement
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 {
427
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
10 /// <summary>
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
11 /// Factory for creating instances of <see cref="UnitRequiresAtLeastNUnitsRequirement" />. Data must be in the format:
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
12 ///
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
13 /// <code>unitID[:count][|unitID[:count][|...]]</code>
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
14 ///
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
15 /// e.g.:
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
16 ///
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
17 /// <code>Swordsmen:2|Bowmen</code>
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
18 ///
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
19 /// would generate a requirement to allow any number of the unit type after 1 unit with ID Bowmen or 2 units with ID Swordsmen were added.
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
20 /// </summary>
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
21 /// <exception cref='InvalidRequirementException'>
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
22 /// Is thrown when the invalid requirement exception.
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
23 /// </exception>
379
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
24 public class UnitRequiresAtLeastNUnitsRequirementFactory : IRequirementFactory
371
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 {
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26 public UnitRequiresAtLeastNUnitsRequirementFactory()
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 {
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28 //Do nothing special
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 }
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30
379
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
31 public string AppliesToID {
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
32 get {
427
3882b533d99d Re #27: Define unit requirements
IBBoard <dev@ibboard.co.uk>
parents: 379
diff changeset
33 return UnitRequiresAtLeastNUnitsRequirement.REQUIREMENT_ID;
379
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
34 }
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
35 }
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
36
04f4c2fea356 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 377
diff changeset
37 public IRequirement CreateRequirement<SOURCE_FILE_TYPE, ENTRY_TYPE>(UnitType type, string data, IRaceFactory<SOURCE_FILE_TYPE, ENTRY_TYPE> raceFactory)
371
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38 {
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
39 UnitRequiresAtLeastNUnitsRequirement req = new UnitRequiresAtLeastNUnitsRequirement(type);
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
40 Race race = type.Race;
377
c3b0b28bad48 Re #353: Handle unloaded units being referenced outside factory
IBBoard <dev@ibboard.co.uk>
parents: 376
diff changeset
41 AddRequirements(req, race, data, raceFactory);
371
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42 return req;
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 }
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
44
377
c3b0b28bad48 Re #353: Handle unloaded units being referenced outside factory
IBBoard <dev@ibboard.co.uk>
parents: 376
diff changeset
45 private void AddRequirements<SOURCE_FILE_TYPE, ENTRY_TYPE>(UnitRequiresAtLeastNUnitsRequirement req, Race race, string data, IRaceFactory<SOURCE_FILE_TYPE, ENTRY_TYPE> raceFactory)
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
46 {
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
47 foreach (string requirement in data.Split('|'))
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
48 {
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
49 string[] requirementParts = requirement.Split(':');
375
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
50 string unitID = requirementParts[0];
377
c3b0b28bad48 Re #353: Handle unloaded units being referenced outside factory
IBBoard <dev@ibboard.co.uk>
parents: 376
diff changeset
51 UnitType unitType = raceFactory.GetUnitType(unitID, race);
374
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
52
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
53 if (unitType == null)
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
54 {
375
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
55 throw new InvalidRequirementException(String.Format("Invalid unit type '{0}' for 'Requires at least N units' requirement", unitID));
374
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
56 }
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
57
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
58 if (requirementParts.Length == 2)
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
59 {
375
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
60 string amount = requirementParts[1];
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
61
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
62 try
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
63 {
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
64 req.AddUnitTypeRequirement(unitType, Int32.Parse(amount));
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
65 }
376
e50682387d63 Re #353: Handle unloaded units being referenced outside factory
IBBoard <dev@ibboard.co.uk>
parents: 375
diff changeset
66 catch (FormatException)
375
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
67 {
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
68 throw new InvalidRequirementException(String.Format("Invalid amount '{0}' for unit type '{1}' for 'Requires at least N units' requirement", amount, unitID));
d9bf78a8f517 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 374
diff changeset
69 }
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
70 }
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
71 else
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
72 {
374
13793f3a2a2e Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 373
diff changeset
73 req.AddUnitTypeRequirement(unitType);
373
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
74 }
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
75 }
e10630f39ec2 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents: 372
diff changeset
76 }
371
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
77 }
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
78 }
bfdb95906075 Re #351: Add extensible requirement handling method
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79