Mercurial > repos > IBDev-IBBoard.WarFoundry.API
view API/Objects/Requirement/IRequirement.cs @ 364:0dd8dbe8afe9
Fixes #345: Add failure message to requirements
* Add implementation of failure messages for "allows adding"
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sun, 01 May 2011 19:17:40 +0000 |
parents | dbe7ccb1e557 |
children | 8f5125740316 |
line wrap: on
line source
// This file (Requirement.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; namespace IBBoard.WarFoundry.API.Objects.Requirement { /// <summary> /// Base interface for a Requirement that constrains the units/equipment that can be taken in an army /// </summary> public interface IRequirement { /// <summary> /// Checks whether the supplied WarFoundryObject can be added to the supplied army. /// </summary> /// <returns> /// A <code>Validation</code> enum to show the result of the validation /// </returns> /// <param name='wfObject'> /// The object that we want to add. This may be involved in the check, or it may not affect the evaluation of the requirement /// </param> /// <param name='toArmy'> /// The army to add the object to. /// </param> Validation AllowsAdding(WarFoundryObject wfObject, Army toArmy); /// <summary> /// Checks whether the supplied army is currently valid according to this requirement. /// </summary> /// <returns> /// A <code>Validation</code> enum to show the result of the validation /// </returns> /// <param name='toValidate'> /// The army to validate /// </param> Validation ValidatesArmy(Army army); /// <summary> /// Gets the validation message from validating the army /// </summary> /// <returns> /// A validation message, if the validation fails, else an empty string. /// </returns> /// <param name='army'> /// The army to validate. /// </param> string GetValidationMessage(Army army); /// <summary> /// Gets the validation message for adding a unit to the army /// </summary> /// <returns> /// A validation message, if the type cannot be added, else an empty string. /// </returns> /// <param name='toAdd'> /// The unit type to try to add /// </param> /// <param name='toArmy'> /// The army the unit will be added to /// </param> string GetAllowsAddingMessage(UnitType toAdd, Army toArmy); } }