IBBoard.WarFoundry.API: api/Objects/UnitType.cs comparison

comparison api/Objects/UnitType.cs @ 56:9561ef46c6fb

Re #61 - Complete structure of WarFoundry API objects * Add adding of abilities and equipment to UnitType * Add getting of all, required and optional abilities * Add UnitAbility class to store UnitType's reference to Ability object Also: * Convert UnitType to using Genericed collections * Reduce visibility of properties to private

author	IBBoard <dev@ibboard.co.uk>
date	Sun, 05 Apr 2009 19:57:32 +0000
parents	a5855fcd75ab
children	e0ce5578e7c2

comparison

equal deleted inserted replaced

-:9080366031c0
+:9561ef46c6fb
 // This file (UnitType.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard.
 //
 // The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license.
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Xml;
 using IBBoard.Logging;
 using IBBoard.WarFoundry.API.Requirements;
 	/// <summary>
 	/// 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.
 	/// </summary>
 	public class UnitType : WarFoundryObject
 	{
-		protected Category mainCat;
+		private Category mainCat;
-		protected Race race;
+		private Race race;
-		protected int min, max, baseSize = 0;
+		private int min, max, baseSize = 0;
-		protected int minSize, maxSize;
+		private int minSize, maxSize;
-		protected double baseUnitCost;
+		private double baseUnitCost;
-		protected double costPerTrooper;
+		private double costPerTrooper;
-		protected Stats stats;
+		private Stats stats;
-		protected List<UnitRequirement> requirements = new List<UnitRequirement>();
+		private List<UnitRequirement> requirements = new List<UnitRequirement>();
-		protected Hashtable equipment = new Hashtable();
+		private Dictionary<string, UnitEquipmentItem> equipment = new Dictionary<string, UnitEquipmentItem>();
-		protected Hashtable equipmentExclusionGroups = new Hashtable();
+		private Dictionary<string, List<UnitEquipmentItem>> equipmentExclusionGroups = new Dictionary<string, List<UnitEquipmentItem>>();
-		protected ArrayList equipmentKeyOrder = new ArrayList();
+		private List<string> equipmentKeyOrder = new List<string>();
+		private Dictionary<string, UnitAbility> abilities = new Dictionary<string, UnitAbility>();
 		public UnitType(string id, string typeName, Race parentRace) : base(id, typeName)
 		{
 			race = parentRace;
 		}
 		[Obsolete("Use three parameter constructor and setters")]
-		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) : base(id, typeName)
+		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)
 		{
-			race = parentRace;
 			mainCat = race.GetCategory(mainCategoryID);
 			MinNumber = minNum;
 			MaxNumber = maxNum;
 			MinSize = minimumSize;
 			MaxSize = maximumSize;
 			{
 				if (value!=null)
 				{
 					stats = value;
 				}
+			}
+		}
+		public void AddEquipmentItem(UnitEquipmentItem item)
+		{
+			equipment.Add(item.ID, item);
+			equipmentKeyOrder.Add(item.ID);
+			AddToMutexGroup(item);
+		}
+		private void AddToMutexGroup(UnitEquipmentItem item)
+		{
+			string mutexGroup = item.MutexGroup;
+			if (mutexGroup!="" && mutexGroup!=null)
+			{
+				List<UnitEquipmentItem> items = null;
+				equipmentExclusionGroups.TryGetValue(mutexGroup, out items);
+				if (items == null)
+				{
+					items = new List<UnitEquipmentItem>();
+					equipmentExclusionGroups.Add(mutexGroup, items);
+				}
+				items.Add(item);
 			}
 		}
 		/// <summary>
 		/// Gets a <see cref="UnitEquipmentItem"/> for the given ID string, or <code>null</code> if nothing exists for that ID
 		/// <returns>
 		/// The <see cref="UnitEquipmentItem"/> for the given ID string, or <code>null</code> if nothing exists for that ID
 		/// </returns>
 		public UnitEquipmentItem GetEquipmentItem(string id)
 		{
-			return (UnitEquipmentItem)equipment[id];
+			UnitEquipmentItem equipItem = null;
+			equipment.TryGetValue(id, out equipItem);
+			return equipItem;
 		}
 		/// <summary>
 		/// Gets an array of all available <see cref="UnitEquipmentItem"/>s for this UnitType
 		/// </summary>
 			UnitEquipmentItem[] items = new UnitEquipmentItem[equipment.Count];
 			int i = 0;
 			foreach (string itemID in equipmentKeyOrder)
 			{
-				items[i++] = (UnitEquipmentItem)equipment[itemID];
+				items[i++] = equipment[itemID];
 			}
 			return items;
+		}
+		public ICollection<Ability> GetAbilities()
+		{
+			ICollection<Ability> abilitiesList = new List<Ability>();
+			foreach (UnitAbility ability in abilities.Values)
+			{
+				abilitiesList.Add(ability.Ability);
+			}
+			return abilitiesList;
+		}
+		public ICollection<Ability> GetRequiredAbilities()
+		{
+			ICollection<Ability> requiredAbilities = new List<Ability>();
+			foreach (UnitAbility ability in abilities.Values)
+			{
+				if (ability.IsRequired)
+				{
+					requiredAbilities.Add(ability.Ability);
+				}
+			}
+			return requiredAbilities;
+		}
+		public ICollection<Ability> GetOptionalAbilities()
+		{
+			ICollection<Ability> optionalAbilities = new List<Ability>();
+			foreach (UnitAbility ability in abilities.Values)
+			{
+				if (!ability.IsRequired)
+				{
+					optionalAbilities.Add(ability.Ability);
+				}
+			}
+			return optionalAbilities;
+		}
+		public void AddAbility(Ability ability)
+		{
+			if (!abilities.ContainsKey(ability.ID))
+			{
+				UnitAbility unitAbility = new UnitAbility(ability);
+				abilities[ability.ID] = unitAbility;
+			}
 		}
 		public void AddRequirement(UnitRequirement requirement)
 		{
 			requirements.Add(requirement);
 			return failures;
 		}
 		public UnitEquipmentItem[] GetEquipmentItemsByExclusionGroup(string group)
 		{
-			ArrayList list = (ArrayList)equipmentExclusionGroups[group];
+			List<UnitEquipmentItem> list = null;
+			equipmentExclusionGroups.TryGetValue(group, out list);
 			if (list == null)
 			{
 				return new UnitEquipmentItem[0];
 			}
 			else
 			{
-				return (UnitEquipmentItem[])list.ToArray(typeof(UnitEquipmentItem));
+				return list.ToArray();
 			}
 		}
 	}
 }

Mercurial > repos > IBBoard.WarFoundry.API

comparison api/Objects/UnitType.cs @ 56:9561ef46c6fb