#region Arthea License

/***********************************************************************
*  Arthea MUD by R. Jennings (2007)      http://arthea.googlecode.com/ *
*  By using this code you comply with the Artistic and GPLv2 Licenses. *
***********************************************************************/

#endregion

using System;
using System.Text;
using System.Xml.Serialization;
using Arthea.Continents.Areas.Rooms;

namespace Arthea.Continents.Areas.Resets
{
    /// <summary>
    /// Implements a room reset
    /// </summary>
    [Serializable]
    [XmlInclude(typeof (ItemReset))]
    [XmlInclude(typeof (CharReset))]
    [XmlInclude(typeof (ContainerReset))]
    [XmlInclude(typeof (EquipReset))]
    public abstract class RoomReset : Reset
    {
        #region [rgn] Fields (1)

        private byte count;

        #endregion [rgn]

        #region [rgn] Constructors (2)

        /// <summary>
        /// Initializes a new instance of the <see cref="RoomReset"/> class.
        /// </summary>
        /// <param name="room">The room.</param>
        /// <param name="count">The count.</param>
        public RoomReset(Room room, byte count)
            : base(room)
        {
            this.count = count;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="RoomReset"/> class.
        /// </summary>
        public RoomReset()
        {
        }

        #endregion [rgn]

        #region [rgn] Properties (1)

        /// <summary>
        /// Gets or sets the count.
        /// </summary>
        /// <value>The count.</value>
        public byte Count
        {
            get { return count; }
            set { count = value; }
        }

        #endregion [rgn]

        #region [rgn] Methods (1)

        // [rgn] Public Methods (1)

        /// <summary>
        /// Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
        /// </returns>
        public override string ToString()
        {
            StringBuilder buf = new StringBuilder(base.ToString());

            buf.Append(" - Maximum in room: ").AppendLine(count.ToString());

            return buf.ToString();
        }

        #endregion [rgn]
    }
}