annotate api/Objects/UnitType.cs @ 253:79943fcf4de2

Re #268: Restructure stats for re-use * Add multi-stat properties to unit types * Deprecate single versions and make them return just the first stat line (since we guarantee at least one line)
author IBBoard <dev@ibboard.co.uk>
date Mon, 26 Apr 2010 19:49:51 +0000
parents a54da5a8b5bb
children cdda78975be1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
104
2f3cafb69799 Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents: 93
diff changeset
1 // This file (UnitType.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard.
15
306558904c2a Re #1 - LGPL license all code
IBBoard <dev@ibboard.co.uk>
parents: 12
diff changeset
2 //
104
2f3cafb69799 Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents: 93
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.
15
306558904c2a Re #1 - LGPL license all code
IBBoard <dev@ibboard.co.uk>
parents: 12
diff changeset
4
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
5 using System;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
6 using System.Collections.Generic;
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 using System.Xml;
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
8 using IBBoard.Limits;
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 using IBBoard.Logging;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
10 using IBBoard.WarFoundry.API.Requirements;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
11
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
12 namespace IBBoard.WarFoundry.API.Objects
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
13 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
14 /// <summary>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
15 /// A UnitType is a type for a <see cref=" Unit"/>, normally relating to an entry in an army list. The UnitType defines the name, cost, minimum and maximum limits of a unit, and the equipment units of the type can take.
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
16 /// </summary>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
17 public class UnitType : WarFoundryObject
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 {
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
19 private Category mainCat;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
20 private Race race;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
21 private int min, max, baseSize = 0;
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
22 private int minSize, maxSize;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
23 private double baseUnitCost;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
24 private double costPerTrooper;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
25 private Stats stats;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
26 private List<UnitRequirement> requirements = new List<UnitRequirement>();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
27 private Dictionary<string, UnitEquipmentItem> equipment = new Dictionary<string, UnitEquipmentItem>();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
28 private Dictionary<string, List<UnitEquipmentItem>> equipmentExclusionGroups = new Dictionary<string, List<UnitEquipmentItem>>();
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
29 private List<string> equipmentKeyOrder = new List<string>();
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
30 private Dictionary<string, Ability> requiredAbilities = new Dictionary<string, Ability>();
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
31 private Dictionary<string, Ability> optionalAbilities = new Dictionary<string, Ability>();
69
91cf8efbea0b Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 68
diff changeset
32 private String notes = "";
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
33 private List<UnitType> containedTypes = new List<UnitType>();
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
34 private Dictionary<string, string> extraData = new Dictionary<string, string>();
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
35 private Dictionary<string, AbstractLimit> slotLimits = new Dictionary<string, AbstractLimit>();
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
36 private Dictionary<string, UnitMemberType> unitMemberTypes = new Dictionary<string, UnitMemberType>();
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
37
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
38 public UnitType(string id, string typeName, Race parentRace) : base(id, typeName)
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
39 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
40 race = parentRace;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
41 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
42
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
43 [Obsolete("Use three parameter constructor and setters")]
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
44 public UnitType(string id, string typeName, string mainCategoryID, string[] allCategoryIDs, int minNum, int maxNum, int minimumSize, int maximumSize, double unitCost, double trooperCost, Stats unitStats, UnitRequirement[] unitRequirements, Race parentRace) : this (id, typeName, parentRace)
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45 {
34
b28be912adab Re #32 - Migrate to schema
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
46 mainCat = race.GetCategory(mainCategoryID);
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
47 MinNumber = minNum;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
48 MaxNumber = maxNum;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
49 MinSize = minimumSize;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
50 MaxSize = maximumSize;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
51 BaseUnitCost = unitCost;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
52 CostPerTrooper = trooperCost;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
53 SetUnitStats(unitStats);
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
54
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
55 foreach (UnitRequirement requirement in requirements)
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
56 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
57 AddRequirement(requirement);
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
59 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
60
68
10d14a7051d5 Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 67
diff changeset
61 public GameSystem GameSystem
10d14a7051d5 Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 67
diff changeset
62 {
10d14a7051d5 Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 67
diff changeset
63 get { return Race.GameSystem; }
10d14a7051d5 Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 67
diff changeset
64 }
10d14a7051d5 Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 67
diff changeset
65
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
66 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
67 /// Gets the <see cref=" Race"/> that this unit belongs to.
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
68 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
69 public Race Race
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
70 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
71 get { return race; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
72 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
73
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
74 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
75 /// Gets or sets the <see cref=" Category"/> that this unit type is a member of.
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
76 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
77 public virtual Category MainCategory
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
78 {
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79 get
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
80 {
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
81 return mainCat;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
82 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
83 set
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
84 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
85 mainCat = value;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
86 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
87 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
88
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
89 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
90 /// Gets or sets the minimum size of each unit of this type. Note: This should be set AFTER MaxSize, otherwise an unintended default value may be set for the minimum
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
91 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
92 public int MinSize
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
93 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
94 get { return minSize; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
95 set
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
96 {
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
97 minSize = (value >= 0 ? value : 0);
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
98 CheckMinimumSize();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
99 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
100 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
101
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
102 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
103 /// Gets or sets the maximum size of each unit of this type. Note: This should be set BEFORE MinSize, otherwise an unintended default value may be set for the minimum
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
104 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
105 public int MaxSize
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
106 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
107 get { return maxSize; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
108 set
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
109 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
110 maxSize = (value >= 0 ? value : WarFoundryCore.INFINITY);
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
111 CheckMinimumSize();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
112 }
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
113 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
114
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
115 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
116 /// Gets or sets the minimum number of units of this type that must be taken in an army. Note: This should be set AFTER MaxNumber, otherwise an unintended default value may be set for the minimum
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
117 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
118 public int MinNumber
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
119 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
120 get { return min; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
121 set
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
122 {
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
123 min = (value >= 0 ? value : 0);
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
124 CheckMinimumNumber();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
125 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
126 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
127
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
128 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
129 /// Gets or sets the maximum number of units of this type that can be taken in an army. Note: This should be set BEFORE MinNumber, otherwise an unintended default value may be set for the minimum
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
130 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
131 public int MaxNumber
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
132 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
133 get { return max; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
134 set
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
135 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
136 max = (value >= 0 ? value : WarFoundryCore.INFINITY);
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
137 CheckMinimumNumber();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
138 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
139 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
140
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
141 /// <summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
142 /// Makes sure that the minimum number isn't more than the maximum number, hence the warning on the properties
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
143 /// </summary>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
144 private void CheckMinimumNumber()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
145 {
38
548cfc776f54 Fixes #34 - Remove "Choices" and "Base/Increment" from Category
IBBoard <dev@ibboard.co.uk>
parents: 34
diff changeset
146 if (MinNumber > MaxNumber && MaxNumber!=WarFoundryCore.INFINITY)
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
147 {
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
148 MinNumber = MaxNumber;
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
149 LogNotifier.WarnFormat(GetType(), "Unit type {0} ({1}) had a minimum number greater than their maximum number.", Name, ID);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
150 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
151 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
152
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
153 /// <summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
154 /// Makes sure that the minimum unit size isn't more than the maximum unit size, hence the warning on the properties
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
155 /// </summary>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
156 private void CheckMinimumSize()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
157 {
38
548cfc776f54 Fixes #34 - Remove "Choices" and "Base/Increment" from Category
IBBoard <dev@ibboard.co.uk>
parents: 34
diff changeset
158 if (MinSize > MaxSize && MaxSize!=WarFoundryCore.INFINITY)
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
159 {
34
b28be912adab Re #32 - Migrate to schema
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
160 MinSize = MaxSize;
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
161 LogNotifier.WarnFormat(GetType(), "Unit type {0} ({1}) had a minimum size greater than their maximum size.", Name, ID);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
162 }
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
163 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
164
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
165 //// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
166 /// Gets or sets the "base size" of a unit, which is the number of troopers the unit has in it for its "base cost". For a lot of units this value will be 0 as the cost is worked out based on the total number of members.
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
167 /// </value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
168 public int BaseSize
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
169 {
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
170 get { return baseSize; }
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
171 set { baseSize = (value >= 0 ? value : 0); }
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
172 }
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
173
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
174 /// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
175 /// The number of points that a "base unit" of <code>BaseSize</code> models costs. Additional models are charged at <code>CostPerTrooper</code> each.
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
176 /// </value>
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
177 public double BaseUnitCost
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
178 {
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
179 get { return baseUnitCost; }
12
ac232763858b Re #9 - Make WarFoundry API use smaller methods
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
180 set { baseUnitCost = (value >= 0 ? value : 0); }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
181 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
182
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
183 //// <value>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
184 /// The cost of an individual trooper. This value is the cost for a basic trooper without weapons, which are added on top of the cost before calculating a unit cost.
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
185 /// </value>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
186 public double CostPerTrooper
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
187 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
188 get { return costPerTrooper; }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
189 set { costPerTrooper = (value >= 0 ? value : 0); }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
190 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
191
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
192 protected override string DefaultName()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
193 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
194 throw new InvalidOperationException("Unit type with id "+id+" did not have a name specified");
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
195 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
196
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
197 /// <value>
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
198 /// The first of the <see cref="Stat"/>s lines for the unit.
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
199 /// </value>
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
200 [Obsolete("Use UnitStatsArrays instead")]
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
201 public Stat[] UnitStatsArray
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
202 {
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
203 get
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
204 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
205 return UnitStatsArrays[0];
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
206 }
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
207 }
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
208
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
209 //// <value>
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
210 /// The first ot the <see cref="Stat"/>s lines for the unit including an additional column that contains the unit type name
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
211 /// </value>
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
212 [Obsolete("Use UnitStatsArrays instead")]
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
213 public Stat[] UnitStatsArrayWithName
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
214 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
215 get
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
216 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
217 return UnitStatsArraysWithName[0];
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
218 }
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
219 }
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
220
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
221 /// <value>
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
222 /// The array of <see cref="Stat"/>s for each of the unit's stat lines
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
223 /// </value>
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
224 public Stat[][] UnitStatsArrays
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
225 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
226 get
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
227 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
228 Stat[][] statsArray = null;
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
229
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
230 if (stats != null)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
231 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
232 statsArray = new Stat[][]{ stats.StatsArray };
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
233 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
234 else if (unitMemberTypes.Count > 0)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
235 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
236 int memTypeCount = unitMemberTypes.Count;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
237 statsArray = new Stat[memTypeCount][];
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
238 int i = 0;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
239
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
240 foreach (UnitMemberType memType in unitMemberTypes.Values)
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
241 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
242 statsArray[i] = memType.StatsArray;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
243 i++;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
244 }
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
245 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
246 else
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
247 {
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
248 SystemStats systemStats = GameSystem.StandardSystemStats;
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
249 Stats tempStats = new Stats(systemStats);
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
250 statsArray = new Stat[][]{ tempStats.StatsArray };
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
251 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
253 return statsArray;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
254 }
81
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
255 }
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
256
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
257 //// <value>
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
258 /// The array of <see cref="Stat"/>s for each of the unit's stat lines including an additional column that contains the unit type name
81
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
259 /// </value>
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
260 public Stat[][] UnitStatsArraysWithName
81
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
261 {
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
262 get
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
263 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
264 Stat[][] statsArray;
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
265
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
266 if (stats != null)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
267 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
268 statsArray = new Stat[][]{ ExtendStatsArrayWithName(stats.StatsArray) };
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
269 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
270 else if (unitMemberTypes.Count > 0)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
271 {
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
272 int memTypeCount = unitMemberTypes.Count;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
273 statsArray = new Stat[memTypeCount][];
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
274 int i = 0;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
275
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
276 foreach (UnitMemberType memType in unitMemberTypes.Values)
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
277 {
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
278 statsArray[i] = memType.StatsArrayWithName;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
279 i++;
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
280 }
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
281 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
282 else
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
283 {
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
284 SystemStats systemStats = GameSystem.StandardSystemStats;
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
285 Stats tempStats = new Stats(systemStats);
253
79943fcf4de2 Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 252
diff changeset
286 statsArray = new Stat[][]{ ExtendStatsArrayWithName(tempStats.StatsArray) };
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
287 }
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
288
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
289 return statsArray;
81
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
290 }
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
291 }
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
292
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
293 public Stat[] ExtendStatsArrayWithName(Stat[] statsArray)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
294 {
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
295 Stat[] extendedStats = new Stat[statsArray.Length+1];
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
296 extendedStats[0] = new Stat(new StatSlot("name"), Name);
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
297 statsArray.CopyTo(extendedStats, 1);
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
298 return extendedStats;
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
299 }
81
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
300
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
301 public void SetUnitStats(Stats newStats)
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
302 {
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
303 stats = newStats;
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
304 }
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
305
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
306 public string GetStatValue(string statName)
032b174fc17a Re #10 - Refactoring for readability
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
307 {
181
8c6f55d289b0 Fixes #200: Stats names should be case-insensitive
IBBoard <dev@ibboard.co.uk>
parents: 176
diff changeset
308 return stats.GetStatValue(statName.ToLower());
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
309 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
310
92
729d9e54162c Re #111: "Replace" button doesn't always enable
IBBoard <dev@ibboard.co.uk>
parents: 85
diff changeset
311 internal void AddEquipmentItem(UnitEquipmentItem item)
93
789dfab13449 * Remove debugging Console.WriteLine call
IBBoard <dev@ibboard.co.uk>
parents: 92
diff changeset
312 {
85
46ad6f478203 Re #50: Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
313 if (!equipment.ContainsKey(item.ID))
46ad6f478203 Re #50: Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
314 {
46ad6f478203 Re #50: Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
315 equipment.Add(item.ID, item);
46ad6f478203 Re #50: Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
316 equipmentKeyOrder.Add(item.ID);
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
317 AddToMutexGroups(item);
85
46ad6f478203 Re #50: Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
318 }
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
319 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
320
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
321 private void AddToMutexGroups(UnitEquipmentItem item)
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
322 {
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
323 string[] mutexGroups = item.MutexGroups;
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
324
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
325 foreach (string mutexGroup in mutexGroups)
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
326 {
66
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
327 List<UnitEquipmentItem> items = DictionaryUtils.GetValue(equipmentExclusionGroups, mutexGroup);
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
328
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
329 if (items == null)
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
330 {
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
331 items = new List<UnitEquipmentItem>();
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
332 equipmentExclusionGroups.Add(mutexGroup, items);
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
333 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
334
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
335 items.Add(item);
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
336 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
337 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
338
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
339 /// <summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
340 /// Gets a <see cref="UnitEquipmentItem"/> for the given ID string, or <code>null</code> if nothing exists for that ID
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
341 /// </summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
342 /// <param name="id">
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
343 /// The ID of the UnitEquipmentItem to get
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
344 /// </param>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
345 /// <returns>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
346 /// The <see cref="UnitEquipmentItem"/> for the given ID string, or <code>null</code> if nothing exists for that ID
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
347 /// </returns>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
348 public UnitEquipmentItem GetEquipmentItem(string id)
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
349 {
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
350 return DictionaryUtils.GetValue(equipment, id);
64
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
351 }
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
352
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
353 /// <summary>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
354 /// Gets a <see cref=" UnitEquipmentItem"/> for the given <see cref=" EquipmentItem"/>, or <code>null</code> if the unit can't take that <code>EquipmentItem</code>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
355 /// </summary>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
356 /// <param name="item">
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
357 /// The <see cref="EquipmentItem"/> to get the <see cref=" UnitEquipmentItem"/>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
358 /// </param>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
359 /// <returns>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
360 /// The <see cref="UnitEquipmentItem"/> that definies the UnitType's restrictions for taking the <see cref=" EquipmentItem"/>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
361 /// </returns>
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
362 public UnitEquipmentItem GetEquipmentItem(EquipmentItem item)
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
363 {
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
364 return GetEquipmentItem(item.ID);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
365 }
46
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
366
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
367 /// <summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
368 /// Gets an array of all available <see cref="UnitEquipmentItem"/>s for this UnitType
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
369 /// </summary>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
370 /// <returns>
a5855fcd75ab Re #11 - Document classes and methods
IBBoard <dev@ibboard.co.uk>
parents: 38
diff changeset
371 /// An array of all available <see cref="UnitEquipmentItem"/>s for this UnitType
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
372 /// </returns>
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
373 public UnitEquipmentItem[] GetEquipmentItems()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
374 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
375 return DictionaryUtils.ToArray<string, UnitEquipmentItem>(equipment);
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
376 }
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
377
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
378 public UnitEquipmentItem[] GetEquipmentItemsByExclusionGroup(string group)
154
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
379 {
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
380 return GetEquipmentItemsByExclusionGroups(new string[] { group });
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
381 }
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
382
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
383 public UnitEquipmentItem[] GetEquipmentItemsByExclusionGroups(string[] groups)
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
384 {
154
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
385 List<UnitEquipmentItem> list = new List<UnitEquipmentItem>();
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
386
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
387 foreach (string group in groups)
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
388 {
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
389 List<UnitEquipmentItem> groupList = DictionaryUtils.GetValue(equipmentExclusionGroups, group);
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
390
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
391 if (groupList != null)
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
392 {
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
393 list.AddRange(groupList);
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
394 }
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
395 }
4a02c07278e7 Re #185: Problems with decimals in race definitions
IBBoard <dev@ibboard.co.uk>
parents: 152
diff changeset
396
152
0c0e14f03785 Re #180: Add multiple mutex groups
IBBoard <dev@ibboard.co.uk>
parents: 131
diff changeset
397 return list.ToArray();
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
398 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
399
64
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
400 public bool IsRatioLimitedEquipmentItem(EquipmentItem item)
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
401 {
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
402 UnitEquipmentItem equip = GetEquipmentItem(item);
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
403 return equip != null && equip.IsRatioLimit;
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
404 }
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
405
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
406 public bool IsAbsoluteLimitedEquipmentItem(EquipmentItem item)
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
407 {
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
408 UnitEquipmentItem equip = GetEquipmentItem(item);
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
409 return equip != null && !equip.IsRatioLimit;
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
410 }
2094bd0ba652 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 61
diff changeset
411
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
412 public ICollection<Ability> GetRequiredAbilities()
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
413 {
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
414 return requiredAbilities.Values;
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
415 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
416
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
417 public ICollection<Ability> GetOptionalAbilities()
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
418 {
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
419 return optionalAbilities.Values;
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
420 }
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
421
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
422 public void AddAbility(Ability ability, bool isRequired)
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
423 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
424 string id = ability.ID;
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
425
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
426 if (!requiredAbilities.ContainsKey(id) && !optionalAbilities.ContainsKey(id))
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
427 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
428 if (isRequired)
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
429 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
430 requiredAbilities[id] = ability;
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
431 }
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
432 else
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
433 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
434 optionalAbilities[id] = ability;
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
435 }
56
9561ef46c6fb Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 46
diff changeset
436 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
437 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
438
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
439 public void AddRequirement(UnitRequirement requirement)
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
440 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
441 requirements.Add(requirement);
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
442 }
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
443
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
444 public UnitRequirement[] Requirements
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
445 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
446 get { return requirements.ToArray(); }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
447 }
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
448
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
449 public List<FailedUnitRequirement> CanAddToArmy(Army army)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
450 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
451 List<FailedUnitRequirement> failures = new List<FailedUnitRequirement>();
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
452
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
453 if (requirements!=null && requirements.Count > 0)
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
454 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
455 foreach (UnitRequirement requirement in requirements)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
456 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
457 FailedUnitRequirement failure = (FailedUnitRequirement)requirement.CanAddToWarFoundryObject(army);
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
458
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
459 if (failure!=null)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
460 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
461 failures.Add(failure);
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
462 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
463 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
464 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
465
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
466 return failures;
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
467 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
468
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
469 public List<FailedUnitRequirement> CanRemoveFromArmy(Army army)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
470 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
471 List<FailedUnitRequirement> failures = new List<FailedUnitRequirement>();
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
472
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
473 if (requirements!=null && requirements.Count > 0)
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
474 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
475 foreach (UnitRequirement requirement in requirements)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
476 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
477 FailedUnitRequirement failure = (FailedUnitRequirement)requirement.CanRemoveFromWarFoundryObject(army);
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
478
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
479 if (failure!=null)
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
480 {
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
481 failures.Add(failure);
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
482 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
483 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
484 }
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
485
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
486 return failures;
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
487 }
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
488
69
91cf8efbea0b Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 68
diff changeset
489 public string Notes
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
490 {
69
91cf8efbea0b Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 68
diff changeset
491 get { return notes; }
91cf8efbea0b Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 68
diff changeset
492 set { notes = value; }
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
493 }
69
91cf8efbea0b Re #50 - Complete core loading of WarFoundry XML files
IBBoard <dev@ibboard.co.uk>
parents: 68
diff changeset
494
61
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
495 public bool CanContainUnit(Unit unit)
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
496 {
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
497 return CanContainUnitType(unit.UnitType);
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
498 }
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
499
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
500 public bool CanContainUnitType(UnitType unitType)
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
501 {
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
502 return containedTypes.Contains(unitType);
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
503 }
3c77722a02b5 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 57
diff changeset
504
57
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
505 public UnitType[] ContainedUnitTypes
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
506 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
507 get { return containedTypes.ToArray(); }
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
508 }
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
509
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
510 public void AddContainedUnitType(UnitType containedType)
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
511 {
e0ce5578e7c2 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 56
diff changeset
512 containedTypes.Add(containedType);
66
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
513 }
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
514
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
515 public void AddExtraData(string id, string data)
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
516 {
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
517 extraData[id] = data;
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
518 }
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
519
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
520 public string GetExtraData(string id)
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
521 {
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
522 return DictionaryUtils.GetValue(extraData, id);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
523 }
131
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
524
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
525 public string StatsID
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
526 {
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
527 get
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
528 {
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
529 return stats.StatsID;
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
530 }
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
531 }
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
532
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
533 public void AddEquipmentSlot(string slotName, AbstractLimit slotLimit)
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
534 {
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
535 slotLimits.Add(slotName, slotLimit);
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
536 }
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
537
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
538 public bool HasEquipmentSlot(string slotName)
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
539 {
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
540 return slotLimits.ContainsKey(slotName);
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
541 }
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
542
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
543 /// <summary>
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
544 /// Gets the maximum limit on the number of items allowed in a single slot
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
545 /// </summary>
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
546 /// <param name="slotName">The name of the equipment slot to get the limit for</param>
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
547 /// <returns>The limit of the number of items allowed in a slot, or an infinite limit if the slot is the default one or has not been specified</returns>
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
548 public AbstractLimit GetEquipmentSlotLimit(string slotName)
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
549 {
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
550 AbstractLimit slotLimit = null;
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
551
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
552 if (HasEquipmentSlot(slotName))
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
553 {
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
554 slotLimit = DictionaryUtils.GetValue(slotLimits, slotName);
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
555 }
176
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
556
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
557 if (slotLimit == null)
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
558 {
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
559 slotLimit = new UnlimitedLimit();
22429737cd77 Re #198: Add slots with counts to units
IBBoard <dev@ibboard.co.uk>
parents: 170
diff changeset
560 }
170
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
561
3045a168714a * Line ending clean-up
IBBoard <dev@ibboard.co.uk>
parents: 167
diff changeset
562 return slotLimit;
131
5145b7c61ae0 Re #68: Add "export army list" function
IBBoard <dev@ibboard.co.uk>
parents: 104
diff changeset
563 }
252
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
564
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
565 public void AddUnitMemberType(UnitMemberType unitMemberType)
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
566 {
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
567 unitMemberTypes.Add(unitMemberType.ID, unitMemberType);
a54da5a8b5bb Re #268: Restructure stats for re-use
IBBoard <dev@ibboard.co.uk>
parents: 181
diff changeset
568 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 81
diff changeset
569 }
66
d100ca4bd0c1 Re #61 - Update classes to match schema
IBBoard <dev@ibboard.co.uk>
parents: 64
diff changeset
570 }