Mercurial > repos > IBBoard.WarFoundry.API
diff 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 diff
--- a/API/Objects/Requirement/IRequirement.cs Sun May 01 19:16:23 2011 +0000 +++ b/API/Objects/Requirement/IRequirement.cs Sun May 01 19:17:40 2011 +0000 @@ -45,6 +45,20 @@ /// 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); } }