Mercurial > repos > IBBoard.WarFoundry.API

diff 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
line wrap: on
line diff
--- a/API/Objects/Requirement/IRequirement.cs	Sun Oct 30 20:31:43 2011 +0000
+++ b/API/Objects/Requirement/IRequirement.cs	Sun Oct 30 20:33:05 2011 +0000
@@ -11,6 +11,15 @@
 	public interface IRequirement
 	{
 		/// <summary>
+		/// Gets the ID of the requirement type. This is used by the requirement factories.
+		/// It may be, but is not required to be, the name of the class.
+		/// </summary>
+		/// <value>
+		/// The ID of the requirement type.
+		/// </value>
+		string RequirementID { get; }
+
+		/// <summary>
 		/// Checks whether the supplied WarFoundryObject can be added to the supplied army.
 		/// </summary>
 		/// <returns>