Wolfringo Wolfringo
Wolfringo Wolfringo
Wolfringo (c) 2020 TehGM
DocFX, DiscordFX theme.
Search Results for

    Class HelpOrderAttribute

    Specifies command's help order.

    Inheritance
    System.Object
    System.Attribute
    HelpOrderAttribute
    Implements
    System.IEquatable<HelpOrderAttribute>
    System.IComparable<HelpOrderAttribute>
    Namespace: TehGM.Wolfringo.Commands
    Assembly: Wolfringo.Commands.dll
    Syntax
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
    public class HelpOrderAttribute : Attribute, IEquatable<HelpOrderAttribute>, IComparable<HelpOrderAttribute>
    Remarks

    Commands with higher order value will appear in help command earlier than commands with lower value.

    This attribute takes precedence over PriorityAttribute when constructing help command output.

    Command help order will be taken from HelpOrderAttribute present on the method. If the method doesn't have the attribute, it'll be taken from HelpOrderAttribute present on the handler type. If the handler type also doesn't specify the help order, PriorityAttribute will be checked. If PriorityAttribute is also not specified, default value of 0 will be used.

    Constructors

    | Improve this Doc View Source

    HelpOrderAttribute(Int32)

    Creates a new help order attribute.

    Declaration
    public HelpOrderAttribute(int order)
    Parameters
    Type Name Description
    System.Int32 order

    Command's help order.

    Remarks

    See HelpOrderAttribute for more information about command help order.

    Properties

    | Improve this Doc View Source

    Order

    Order at which the command will be listed in help command.

    Declaration
    public int Order { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    See HelpOrderAttribute for more information about command help order.

    Methods

    | Improve this Doc View Source

    CompareTo(HelpOrderAttribute)

    Declaration
    public int CompareTo(HelpOrderAttribute other)
    Parameters
    Type Name Description
    HelpOrderAttribute other
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Attribute.Equals(System.Object)
    | Improve this Doc View Source

    Equals(HelpOrderAttribute)

    Declaration
    public bool Equals(HelpOrderAttribute other)
    Parameters
    Type Name Description
    HelpOrderAttribute other
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Attribute.GetHashCode()

    Operators

    | Improve this Doc View Source

    Equality(HelpOrderAttribute, HelpOrderAttribute)

    Declaration
    public static bool operator ==(HelpOrderAttribute left, HelpOrderAttribute right)
    Parameters
    Type Name Description
    HelpOrderAttribute left
    HelpOrderAttribute right
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Inequality(HelpOrderAttribute, HelpOrderAttribute)

    Declaration
    public static bool operator !=(HelpOrderAttribute left, HelpOrderAttribute right)
    Parameters
    Type Name Description
    HelpOrderAttribute left
    HelpOrderAttribute right
    Returns
    Type Description
    System.Boolean

    Implements

    System.IEquatable<T>
    System.IComparable<T>