using System;

namespace axXez.TS3.Bot
{
    /// <summary>Marks a method as a bot command and configures its keyword, description, parameters, role, and scope.</summary>
    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
    public class CommandAttribute : Attribute
    {
        /// <summary>The command keyword without the leading <c>!</c>. Use spaces for sub-commands, e.g. <c>"bot status"</c>.</summary>
        public string Keyword { get; set; }

        /// <summary>Short description shown in <c>!help</c> output.</summary>
        public string Description { get; set; }

        /// <summary>Overrides the auto-generated parameter signature in help output, e.g. <c>"&lt;name&gt; [seconds]"</c>. Leave null to auto-generate from the method signature.</summary>
        public string Parameters { get; set; }

        /// <summary>Minimum role required to invoke this command. Defaults to <see cref="CommandRole.User"/>.</summary>
        public CommandRole Role { get; set; } = CommandRole.User;

        /// <summary>Which chat scopes this command responds to. Defaults to <see cref="CommandScope.Private"/>.</summary>
        public CommandScope Scope { get; set; } = CommandScope.Private;

        /// <summary>Initializes the attribute with the given command keyword.</summary>
        public CommandAttribute(string keyword)
        {
            Keyword = keyword;
        }
    }
}