//  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;
			}
		}
	}
}