view api/Requirements/UnitRequiresAtLeastRequirement.cs @ 235:0ebb1b80a2bd

* Change description following threat of legal action over descriptive term "army builder" to describe WarFoundry as an app that builds armies no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sat, 30 Jan 2010 17:21:15 +0000
parents d1c90159547a
children
line wrap: on
line source

// This file (UnitRequiresAtLeastRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2008, 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 System.Collections.Generic;
using System.Text;
using IBBoard.Lang;
using IBBoard.WarFoundry.API;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Requirements
{
	/// <summary>
	/// Summary description for UnitRequiresRequirement.
	/// </summary>
	public class UnitRequiresAtLeastRequirement : UnitRequirement
	{
		private UnitRequirementItem[] requiredTypes;
		private String unitList;

		public UnitRequiresAtLeastRequirement(UnitType type, UnitType requiredUnitType) : this(type, new UnitRequirementItem[]{new UnitRequirementItem(requiredUnitType)})
		{
		}
		
		public UnitRequiresAtLeastRequirement(UnitType type, UnitRequirementItem[] requiredUnitTypes) : base(type)
		{			
			requiredTypes = requiredUnitTypes;
			bool first = true;
			
			foreach (UnitRequirementItem req in requiredTypes)
			{
				string reqString = Translation.GetTranslation("requirementUnitTypeAtLeastSingle", "{1} {0}", req.UnitType.Name, req.Amount);
				
				if (first)
				{
					first = false;
					unitList = reqString;
				}
				else
				{
					unitList = Translation.GetTranslation("requirementUnitTypeAtLeastJoiner", "{0}, {1}", unitList, reqString);
				}
			}
		}

		public override string Description
		{
			get { return Translation.GetTranslation("requirementUnitTypeAtLeast", "the army must include at least the following units to include a unit of type {0}: {1}", unitType.Name, unitList); }
		}

		protected override AbstractFailedRequirement CanRemoveFromArmy(Army army, UnitType type)
		{
			return null;
		}

		protected override AbstractFailedRequirement CanAddToArmy(Army army, UnitType type)
		{
			FailedRequirement failure = null;
			
			foreach (UnitRequirementItem req in requiredTypes)
			{
				if (army.GetUnitTypeCount(req.UnitType) < req.Amount)
				{				
					failure = new FailedRequirement(this);
					break;
				}
			}
						
			return failure;
		}
	}
}