Mercurial > repos > IBBoard.WarFoundry.API

comparison API/Objects/Requirement/IRequirement.cs @ 428:8f5125740316

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #27: Define unit requirements * Move definition and documentation of ID up to interface to ensure it is everywhere
author IBBoard <dev@ibboard.co.uk>
date Sun, 30 Oct 2011 20:33:05 +0000
parents 0dd8dbe8afe9
children afc6410e4efc
comparison
equal deleted inserted replaced
427:3882b533d99d 428:8f5125740316
8 /// <summary> 8 /// <summary>
9 /// Base interface for a Requirement that constrains the units/equipment that can be taken in an army 9 /// Base interface for a Requirement that constrains the units/equipment that can be taken in an army
10 /// </summary> 10 /// </summary>
11 public interface IRequirement 11 public interface IRequirement
12 { 12 {
13 /// <summary>
14 /// Gets the ID of the requirement type. This is used by the requirement factories.
15 /// It may be, but is not required to be, the name of the class.
16 /// </summary>
17 /// <value>
18 /// The ID of the requirement type.
19 /// </value>
20 string RequirementID { get; }
21
13 /// <summary> 22 /// <summary>
14 /// Checks whether the supplied WarFoundryObject can be added to the supplied army. 23 /// Checks whether the supplied WarFoundryObject can be added to the supplied army.
15 /// </summary> 24 /// </summary>
16 /// <returns> 25 /// <returns>
17 /// A <code>Validation</code> enum to show the result of the validation 26 /// A <code>Validation</code> enum to show the result of the validation