view api/Objects/UnitEquipmentRatioSelection.cs @ 297:349e521785c1

Re #338: WarFoundry.API - Save System Data Created IWarFoundryGameSystemSaver Created WarFoundryXmlGameSystemSaver Updated WarFoundrySaver Created GetGameSystemSaver Created SetGameSystemSaver
author Tsudico
date Fri, 07 Jan 2011 03:35:50 +0000
parents ece26f6a62f3
children 92d10b06ab0f
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;
using IBBoard.CustomMath;
using IBBoard.Limits;
using IBBoard.WarFoundry.API.Util;

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, ((IPercentageLimit)item.MinLimit).Percentage)
		{
		}
					
		public override int NumberTaken
		{
			get
			{
				return CalculateNumberTaken (EquipmentForUnit, EquipmentItem, AmountTaken);
			}
		}

		internal static int CalculateNumberTaken (Unit unit, UnitEquipmentItem item, double ratioTaken)
		{
			double exactNumberTaken = (ratioTaken / 100) * unit.Size;
			int wholeNumberTaken = (int)IBBMath.Round (exactNumberTaken, item.RoundNumberUp);
			int maxTaken = UnitEquipmentUtil.GetMaxEquipmentCount (unit, item);
			int minTaken = UnitEquipmentUtil.GetMinEquipmentCount (unit, item);
			return Math.Min (Math.Max (wholeNumberTaken, minTaken), maxTaken);
		}

		[Obsolete("Implementation is down to the UI")]
		public override string GetEquipmentAmountString ()
		{
			return GetEquipmentAmountString(AmountTaken);
		}

		[Obsolete("Implementation is down to the UI")]
		public static string GetEquipmentAmountString(double amount)
		{
			string amountString;
			
			if (amount == 100)
			{
				amountString = "all";
			}
			else
			{
				amountString = amount  + "%";
			}

			return amountString;
		}

	}
}