view API/Factories/Requirement/UnitRequiresAtLeastNUnitsRequirementFactory.cs @ 465:7b9ff7b1df24

Re #394: Make requirements (or factory) more closely match Rollcall methods * Make UnitRequiresAtLeastNUnitsRequirementFactory handle "alternatives" (Rollcall's "-1,X|Y" notation) * Make RequiresAtLeastNUnitsRequirement handle alternatives/multiple unit types in one limit * Move some useful code up the classes
author IBBoard <dev@ibboard.co.uk>
date Sat, 24 Mar 2012 20:33:11 +0000
parents 3882b533d99d
children
line wrap: on
line source

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

namespace IBBoard.WarFoundry.API.Factories.Requirement
{
	/// <summary>
	/// Factory for creating instances of <see cref="UnitRequiresAtLeastNUnitsRequirement" />. Data must be in the format:
	///
	/// <code>unitID[:count][|unitID[:count][|...]]</code>
	///
	/// e.g.:
	///
	/// <code>Swordsmen:2|Bowmen</code>
	///
	/// would generate a requirement to allow any number of the unit type after 1 unit with ID Bowmen or 2 units with ID Swordsmen were added.
	/// </summary>
	/// <exception cref='InvalidRequirementException'>
	/// Is thrown when the invalid requirement exception.
	/// </exception>
	public class UnitRequiresAtLeastNUnitsRequirementFactory : IRequirementFactory
	{
		public UnitRequiresAtLeastNUnitsRequirementFactory()
		{
			//Do nothing special
		}

		public string AppliesToID
		{
			get
			{
				return UnitRequiresAtLeastNUnitsRequirement.REQUIREMENT_ID;
			}
		}

		public IRequirement CreateRequirement<SOURCE_FILE_TYPE, ENTRY_TYPE>(UnitType type, string data, IRaceFactory<SOURCE_FILE_TYPE, ENTRY_TYPE> raceFactory)
		{
			UnitRequiresAtLeastNUnitsRequirement req = new UnitRequiresAtLeastNUnitsRequirement(type);
			Race race = type.Race;
			AddRequirements(req, race, data, raceFactory);
			return req;
		}

		private void AddRequirements<SOURCE_FILE_TYPE, ENTRY_TYPE>(UnitRequiresAtLeastNUnitsRequirement req, Race race, string data, IRaceFactory<SOURCE_FILE_TYPE, ENTRY_TYPE> raceFactory)
		{
			foreach (string requirement in data.Split('|'))
			{
				string[] requirementParts = requirement.Split(':');
				string unitIDs = requirementParts[0];
				UnitType[] unitTypes = GetUnitTypes(unitIDs, race, raceFactory);

				if (requirementParts.Length == 2)
				{
					string amount = requirementParts[1];

					try
					{
						req.AddUnitTypeRequirement(Int32.Parse(amount), unitTypes);
					}
					catch (FormatException)
					{
						throw new InvalidRequirementException(String.Format("Invalid amount '{0}' for unit types '{1}' for 'Requires at least N units' requirement", amount, unitIDs));
					}
				}
				else
				{
					req.AddUnitTypeRequirement(unitTypes);
				}
			}
		}

		private UnitType[] GetUnitTypes<SOURCE_FILE_TYPE, ENTRY_TYPE>(string data, Race race, IRaceFactory<SOURCE_FILE_TYPE, ENTRY_TYPE> raceFactory)
		{
			List<UnitType> unitTypes = new List<UnitType>();

			foreach (string unitID in data.Split(';'))
			{
				UnitType unitType = raceFactory.GetUnitType(unitID, race);
	
				if (unitType == null)
				{
					throw new InvalidRequirementException(String.Format("Invalid unit type '{0}' for 'Requires at least N units' requirement", unitID));
				}

				unitTypes.Add(unitType);
			}

			return unitTypes.ToArray();
		}
	}
}