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

    Class CommandContextOptions

    Computed options for a single execution of command.

    Inheritance
    System.Object
    CommandContextOptions
    Implements
    ICommandOptions
    Namespace: TehGM.Wolfringo.Commands.Parsing
    Assembly: Wolfringo.Commands.dll
    Syntax
    public class CommandContextOptions : ICommandOptions

    Constructors

    | Improve this Doc View Source

    CommandContextOptions(String, PrefixRequirement, Boolean)

    Creates a new options instance for command execution context.

    Declaration
    public CommandContextOptions(string prefix, PrefixRequirement requirePrefix, bool caseSensitivity)
    Parameters
    Type Name Description
    System.String prefix

    Prefix of the executing command.

    PrefixRequirement requirePrefix

    Prefix requirement of the executing command.

    System.Boolean caseSensitivity

    Case sensitivity of the executing command.

    Properties

    | Improve this Doc View Source

    CaseSensitivity

    Case sensitivity of the executing command.

    Declaration
    public bool CaseSensitivity { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    This setting can be overwritten per command using CaseSensitivityAttribute.

    See Also
    CaseSensitivityAttribute
    | Improve this Doc View Source

    Prefix

    Prefix of the executing command.

    Declaration
    public string Prefix { get; }
    Property Value
    Type Description
    System.String
    Remarks

    The actual requirement for command to have a prefix is specified by RequirePrefix.

    See Also
    RequirePrefix
    | Improve this Doc View Source

    RequirePrefix

    Prefix requirement of the executing command.

    Declaration
    public PrefixRequirement RequirePrefix { get; }
    Property Value
    Type Description
    PrefixRequirement
    Remarks

    Prefix value can be set using Prefix

    See Also
    Prefix

    Methods

    | Improve this Doc View Source

    Build(ICommandOptions, ICommandInstanceDescriptor)

    Builds options for command exection context from base options and descriptor with overrides.

    Declaration
    public static CommandContextOptions Build(ICommandOptions originalOptions, ICommandInstanceDescriptor descriptor)
    Parameters
    Type Name Description
    ICommandOptions originalOptions

    Base options.

    ICommandInstanceDescriptor descriptor

    Command descriptor that overrides options.

    Returns
    Type Description
    CommandContextOptions

    A new options instance for command execution context.

    Implements

    ICommandOptions