Class CommandDefinitionBase

Namespace

Shard.Modding.SDK.Command

Assembly

Shard.Modding.SDK.dll

Shared command metadata; child interfaces define execution semantics.

public abstract class CommandDefinitionBase : ICommand

Inheritance

object

CommandDefinitionBase

Implements

ICommand

Derived

AsyncCommandBase

CommandBase

CommandCollection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CommandDefinitionBase(string, string, params string[])

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

Parameters

name string

description string

aliases string[]

Properties

Aliases

public IReadOnlyList<string> Aliases { get; }

Property Value

IReadOnlyList<string>

Arguments

public IReadOnlyList<CommandArg> Arguments { get; }

Property Value

IReadOnlyList<CommandArg>

DefaultPermission

Fallback permission result when no explicit user/group node matches.

public virtual bool DefaultPermission { get; }

Property Value

bool

Description

public string Description { get; }

Property Value

string

Name

public string Name { get; }

Property Value

string

Permission

Permission node required to run the command, e.g. hytale.command.stop.

public virtual string Permission { get; }

Property Value

string

Usage

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

public virtual string Usage { get; }

Property Value

string

Methods

WithDefaultArg<T>(string, CommandArgumentParser<T>, T, string?)

protected DefaultArg<T> WithDefaultArg<T>(string name, CommandArgumentParser<T> parser, T defaultValue, string? description = null)

Parameters

name string

parser CommandArgumentParser<T>

defaultValue T

description string

Returns

DefaultArg<T>

Type Parameters

T

WithFlagArg(string, string?, params string[])

protected FlagArg WithFlagArg(string name, string? description, params string[] aliases)

Parameters

name string

description string

aliases string[]

Returns

FlagArg

WithFlagArg(string, params string[])

protected FlagArg WithFlagArg(string name, params string[] aliases)

Parameters

name string

aliases string[]

Returns

FlagArg

WithOptionalArg<T>(string, CommandArgumentParser<T>, string?)

protected OptionalArg<T> WithOptionalArg<T>(string name, CommandArgumentParser<T> parser, string? description = null)

Parameters

name string

parser CommandArgumentParser<T>

description string

Returns

OptionalArg<T>

Type Parameters

T

WithRequiredArg<T>(string, CommandArgumentParser<T>, string?)

protected RequiredArg<T> WithRequiredArg<T>(string name, CommandArgumentParser<T> parser, string? description = null)

Parameters

name string

parser CommandArgumentParser<T>

description string

Returns

RequiredArg<T>

Type Parameters

T