view api/Requirements/UnitRequirementItem.cs @ 46:a5855fcd75ab

Re #11 - Document classes and methods * Document methods in UnitType and Category classes
author IBBoard <dev@ibboard.co.uk>
date Mon, 23 Mar 2009 20:57:07 +0000
parents 306558904c2a
children 3ea0ab04352b
line wrap: on
line source

// This file (UnitRequirementItem.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 IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Requirements
{
	/// <summary>
	/// Summary description for UnitRequirementItem.
	/// </summary>
	public class UnitRequirementItem
	{
		private UnitType type;
		private int requiredNum;

		public UnitRequirementItem(UnitType unitType, int reqNumber)
		{
			type = unitType;
			requiredNum = reqNumber;
		}

		public UnitRequirementItem(UnitType type) : this(type, 1) { }

		public UnitType UnitType
		{
			get { return type; }
		}

		public int Amount
		{
			get { return requiredNum; }
		}
	}
}