view API/Commands/AbstractReplaceUnitEquipmentCommand.cs @ 337:3c4a6403a88c

* Fix capitalisation so that new files are in the namespace no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sun, 03 Apr 2011 18:50:32 +0000
parents
children
line wrap: on
line source

// This file (AbstractReplaceUnitEquipmentCommand.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.Commands;
using IBBoard.Lang;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API.Commands
{
	/// <summary>
	/// An abstract implementation of the core method for replacing one equipment item with another
	/// </summary>
	public abstract class AbstractReplaceUnitEquipmentCommand : Command
	{
		private SetUnitEquipmentNumericAmountCommand removeOldCommand;
		private AbstractSetUnitEquipmentAmountCommand addNewCommand;

		public AbstractReplaceUnitEquipmentCommand(Unit unit, UnitEquipmentItem oldItem, AbstractSetUnitEquipmentAmountCommand addNewEquipmentCommand)
		{
			//We can get away with a numeric amount here even if it is a ratio item because we're setting it to 0
			removeOldCommand = new SetUnitEquipmentNumericAmountCommand(unit, oldItem, 0);
			addNewCommand = addNewEquipmentCommand;
		}

		public override bool CanExecute()
		{
			return removeOldCommand.CanExecute() && addNewCommand.CanExecute();
		}

		public override string Description
		{
			get
			{
				return Translation.GetTranslation("replaceUnitEquipmentCommandDescription", "replace {0} with {1} for {2}", removeOldCommand.EquipItem.Name, addNewCommand.EquipItem.Name, removeOldCommand.Unit.Name);
			}
		}

		public override string UndoDescription
		{
			get
			{
				return Translation.GetTranslation("replaceUnitEquipmentCommandUndoDescription", "replace {0} with {1} for {2}", addNewCommand.EquipItem.Name, removeOldCommand.EquipItem.Name, removeOldCommand.Unit.Name);
			}
		}

		public override bool Execute()
		{
			this.Redo();
			return true;
		}

		public override void Redo()
		{
			removeOldCommand.Redo();
			addNewCommand.Redo();
		}

		public override void Undo()
		{
			addNewCommand.Undo();
			removeOldCommand.Undo();
		}

		public override string Name
		{
			get
			{
				return "Replace required equipment";
			}
		}
	}
}