view api/Objects/UnitEquipmentItem.cs @ 85:46ad6f478203

Re #50: Complete core loading of WarFoundry XML files * Start loading of UnitEquipmentItems * Fix XPath queries for equipment items and abilities * Allow UnitEquipmentItem to be created without a UnitType * Make adding UnitEquipmentItem to UnitType set UnitType of UnitEquipmentItem * Make loading of abilities and equipment items add the item to the race Also: * Code cleanup (line endings) * Make method to get equipment by ID return null instead of throwing "no such key" exception
author IBBoard <dev@ibboard.co.uk>
date Sat, 01 Aug 2009 16:06:25 +0000
parents 3ea0ab04352b
children 729d9e54162c
line wrap: on
line source

// This file (UnitEquipmentItem.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.Xml;
using IBBoard.Lang;

namespace IBBoard.WarFoundry.API.Objects
{
	/// <summary>
	/// Summary description for UnitEquipmentItem.
	/// </summary>
	public class UnitEquipmentItem : WarFoundryObject
	{
		private EquipmentItem item;
		private bool required;
		private bool roundUp;
		private int minNum;
		private int maxNum;
		private double minPercentage;
		private double maxPercentage;
		private double costMultiplier;
		private RoundType roundType;
		private string mutexGroup;
		private UnitType unitType;

		public UnitEquipmentItem(EquipmentItem equipmentItem)
		{
			item = equipmentItem;
		}
		
		public override string Name
		{
			get {
				return item.Name;
			}
			set {
				base.Name = value;
			}
		}
		
		public string EquipmentItemID
		{
			get { return item.ID; }
		}

        public double Cost
        {
            get
			{
				return IBBMath.Round(EquipmentItem.Cost * CostMultiplier, CostRoundType);
			}
        }

		public double CostMultiplier
		{
			get { return costMultiplier; }
			set
			{
				costMultiplier = value;
			}
		}

		public RoundType CostRoundType
		{
			get { return roundType; }
			set
			{
				roundType = value;
			}	
		}

		public bool IsRequired
		{
			get { return required; }
			set { required = value; }
		}

		public bool RoundNumberUp
		{
			get { return roundUp; }
			set { roundUp = value; }
		}

		public string MutexGroup
		{
			get { return mutexGroup; }
			set { mutexGroup = (value == null ? "" : value.Trim()); }
		}

		public UnitType EquipmentForUnit
		{
			get { return unitType; }
			set 
			{ 
				if (value != null)
				{
					unitType = value;
					unitType.AddEquipmentItem(this);
				}
			}
		}
		
		public bool IsRatioLimit
		{
			get { return minPercentage!=100 || maxPercentage!=100; }
		}
		
		public int MinNumber
		{
			get { return minNum; }
			set
			{
				if (value >=0 || value == WarFoundryCore.INFINITY)
				{
					minNum = value;
				}
				//TODO: Check Min<Max
			}
		}
		
		public int MaxNumber
		{
			get { return maxNum; }
			set
			{
				if (value >=0 || value == WarFoundryCore.INFINITY)
				{
					maxNum = value;
				}
				//TODO: Check Min<Max
			}
		}
		
		public double MinPercentage
		{
			get { return minPercentage; }
			set
			{
				if (value >=0 && value <= 100)
				{
					minPercentage = value;
				}
				//TODO: Check Min<Max
			}
		}
		
		public double MaxPercentage
		{
			get { return maxPercentage; }
			set
			{
				if (value >=0 && value <= 100)
				{
					maxPercentage = value;
				}
				//TODO: Check Min<Max
			}
		}

		public EquipmentItem EquipmentItem
		{
			get { return item; }
		}

		public override string ToString()
		{
			return EquipmentItem.Name+ " ("+EquipmentItem.Cost+"pts each)";
		}

		public bool HasAlternatives()
		{
			if (MutexGroup=="")
			{
				return false;
			}
			else if (EquipmentForUnit == null)
			{
				return false;
			}
			else
			{
				//If the number of items in the MutEx group is greater than one then it must be this item plus another
				return EquipmentForUnit.GetEquipmentItemsByExclusionGroup(MutexGroup).Length > 1;
			}
		}

		public ArmourType ItemArmourType
		{
			get { return EquipmentItem.ItemArmourType; }
		}
		
		public string Description
		{
			get { return EquipmentItem.Description; }
		}
		
		public Race EquipmentForRace
		{
			get { return EquipmentItem.EquipmentForRace; }
		}

		public bool CanBeUsedWithItem(EquipmentItem item)
		{
			return EquipmentItem.CanBeUsedWithItem(item);
		}

		public bool CanBeUsedWithArmourType(ArmourType otherItemType)
		{
			return EquipmentItem.CanBeUsedWithArmourType(otherItemType);
		}
		
		public static string FormatEquipmentAmount(UnitEquipmentItem item, double amount)
		{
			if (item.IsRatioLimit)
			{
				return Math.Round(amount * 100) + "%";
			}
			else
			{
				if (amount == WarFoundryCore.INFINITY)
				{
					return "all";
				}
				else
				{
					return amount.ToString();
				}
			}
		}
	}
}