view api/Objects/UnitEquipmentRatioSelection.cs @ 104:2f3cafb69799

Re #121: Migrate to AGPL license * Update all API files to AGPL license * Include AGPL license and remove GPL/LGPL documents * Fix copyright dates where they're known
author IBBoard <dev@ibboard.co.uk>
date Sat, 15 Aug 2009 10:36:50 +0000
parents f7b9423c2a5a
children 36adabb1c3ea
line wrap: on
line source

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

using System;

namespace IBBoard.WarFoundry.API.Objects
{	
	/// <summary>
	/// An object to hold the selection of a unit's equipment where the selection was made as a percentage or ratio
	/// of the total size of the unit
	/// </summary>
	public class UnitEquipmentRatioSelection : AbstractUnitEquipmentItemSelection
	{	
		public UnitEquipmentRatioSelection(Unit unit, UnitEquipmentItem item, double amount) : base(unit, item, amount)
		{
		}
		
		public UnitEquipmentRatioSelection(Unit unit, UnitEquipmentItem item) : base(unit, item, item.MinPercentage)
		{
		}
					
		public override int NumberTaken
		{
			get
			{
				double numberTaken = (AmountTaken / 100) * EquipmentForUnit.Size;
				return (int) (EquipmentItem.RoundNumberUp ? Math.Ceiling(numberTaken) : Math.Floor(numberTaken));
			}
		}
		
		protected override bool IsInRange (double newValue)
		{
			return (EquipmentItem.MinPercentage <= newValue) && (newValue <= EquipmentItem.MaxPercentage);
		}

		public override string GetEquipmentAmountString ()
		{
			return GetEquipmentAmountString(AmountTaken);
		}

		public static string GetEquipmentAmountString(double amount)
		{
			string amountString;
			
			if (amount == 100)
			{
				amountString = "all"; //TODO: Translate
			}
			else
			{
				amountString = amount  + "%";
			}

			return amountString;
		}

	}
}