Class CommandCollection

Namespace

Shard.Modding.SDK.Command

Assembly

Shard.Modding.SDK.dll

Routes the next argument to a registered child command, /module enable Network.

public abstract class CommandCollection : CommandDefinitionBase, ICommandCollection, ISyncCommand, ICommand

Inheritance

object

CommandDefinitionBase

CommandCollection

Implements

ICommandCollection

ISyncCommand

ICommand

Derived

PermCommand

PermGroupCommand

PermUserCommand

OpCommand

Inherited Members

CommandDefinitionBase.Name

CommandDefinitionBase.Description

CommandDefinitionBase.Aliases

CommandDefinitionBase.Arguments

CommandDefinitionBase.Permission

CommandDefinitionBase.DefaultPermission

CommandDefinitionBase.WithRequiredArg<T>(string, CommandArgumentParser<T>, string)

CommandDefinitionBase.WithDefaultArg<T>(string, CommandArgumentParser<T>, T, string)

CommandDefinitionBase.WithOptionalArg<T>(string, CommandArgumentParser<T>, string)

CommandDefinitionBase.WithFlagArg(string, params string[])

CommandDefinitionBase.WithFlagArg(string, string, params string[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CommandCollection(string, string, params string[])

Routes the next argument to a registered child command, /module enable Network.

protected CommandCollection(string name, string description, params string[] aliases)

Parameters

name string

description string

aliases string[]

Properties

SubCommands

The distinct sub-commands, in insertion order.

public IEnumerable<ICommand> SubCommands { get; }

Property Value

IEnumerable<ICommand>

Usage

Argument syntax shown in help/usage errors, e.g. "<player> [amount]".

public override string Usage { get; }

Property Value

string

Methods

AddSubCommand(ICommand)

protected void AddSubCommand(ICommand command)

Parameters

command ICommand

ExecuteBare(CommandContext)

Bare collection calls show usage; subcommand calls are routed by the dispatcher first.

protected virtual void ExecuteBare(CommandContext context)

Parameters

context CommandContext

TryGetSubCommand(string, out ICommand?)

public bool TryGetSubCommand(string name, out ICommand? command)

Parameters

name string

command ICommand

Returns

bool