view api/Objects/EquipmentItem.cs @ 54:3a90f70dac73

Re #61 - Complete structure of WarFoundry API objects * Remove min/max from EquipmentItem and add description * Add min/max numbers and percentages to UnitEquipmentItem * Make Race schema define min/max number without the ratio (which is the percentage) * Replace use of EquipmentItem with UnitEquipmentItem because of increased use of UnitEquipmentItem for unit-specific data * Use doubles instead of floats for equipment amounts * Distinguish between ratio and absolute limits * Delete UnitEquipmentItemObj helper class that was purely used for UI Re #9 - Use smaller methods * Deprecate long Race and EquipmentItem constructors and ensure all getters/setters exist Also: * Migrate Unit to using genericed collections * Always use GameSystem object for Race, not ID string
author IBBoard <dev@ibboard.co.uk>
date Sun, 05 Apr 2009 13:45:23 +0000
parents d0812d7de39d
children 3ea0ab04352b
line wrap: on
line source

// This file (EquipmentItem.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;

namespace IBBoard.WarFoundry.API.Objects
{
	/// <summary>
	/// Summary description for EquipmentItem.
	/// </summary>
	public class EquipmentItem : WarFoundryObject
	{
		private double cost;
		private string description;
		private ArmourType armourType;
		private Race equipForRace;
		
		public EquipmentItem(string id, string name, Race race) : base(id, name)
		{
			equipForRace = race;
			description = "";
			armourType = ArmourType.None;
		}

		[Obsolete("Use the three argument constructor and the appropriate 'set' methods")]
		public EquipmentItem(string id, string name, double itemCost, double minimum, double maximum, ArmourType itemArmourType, Race race) : this(id, name, race)
		{
			ItemArmourType = itemArmourType;
		}

		public ArmourType ItemArmourType
		{
			get { return armourType; }
			set { armourType = value; }
		}

		public double Cost
		{
			get { return cost; }
			set
			{
				if (value >= 0)
				{
					cost = value;
				}
			}
		}
		
		public string Description
		{
			get { return description; }
			set { description = (value == null ? "" : value); }
		}
		
		public Race EquipmentForRace
		{
			get { return equipForRace; }
		}

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

		public bool CanBeUsedWithArmourType(ArmourType otherItemType)
		{
			return (this.ItemArmourType & otherItemType) == 0;
		}
	}
}