diff API/Objects/UnitMemberType.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 diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/API/Objects/UnitMemberType.cs	Sun Apr 03 18:50:32 2011 +0000
@@ -0,0 +1,53 @@
+//  This file (UnitMember.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2010 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
+{
+	/// <summary>
+	/// A container object for representations of different unit member types, such as "Infantry", "Elite Infantry" and "Commoner".
+	/// The idea of the UnitMemberType is to define not just the <see>UnitType</see>s, but also the types of type, as Archer and Swordsmen
+	/// are often just differently equipped versions of the same member type (Infantry).
+	/// </summary>
+	public class UnitMemberType : WarFoundryObject
+	{
+		private Stats stats;
+		
+		public UnitMemberType(string typeID, string typeName, Stats typeStats) : base(typeID, typeName)
+		{
+			stats = typeStats;
+		}
+		
+		public string StatsID
+		{
+			get 
+			{
+				return stats.StatsID;
+			}
+		}
+
+		/// <value>
+		/// The set of <see cref="Stat"/>s for the unit member type in a format that is valid for the game system.
+		/// </value>
+		public Stat[] StatsArray
+		{
+			get 
+			{				
+				return stats.StatsArray;
+			}
+		}
+		
+		public Stat[] StatsArrayWithName
+		{
+			get
+			{
+				Stat[] extendedStats = new Stat[stats.StatCount+1];
+				extendedStats[0] = new Stat(new StatSlot("name"), Name);
+				stats.StatsArray.CopyTo(extendedStats, 1);
+				return extendedStats;
+			}
+		}
+	}
+}