Interface IPluginCommandDefinition

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Describes a command, its aliases, invocation, and completion behavior.

public interface IPluginCommandDefinition

Properties

Aliases

Other words the same command answers to; empty for none.

IReadOnlyList<string> Aliases { get; }

Property Value

IReadOnlyList<string>

Description

One line saying what the command does, used for help.

string Description { get; }

Property Value

string

Verb

The command word, without a leading slash.

string Verb { get; }

Property Value

string

Methods

Complete(PluginCommand)

Offers completions for a partially typed command.

IReadOnlyList<PluginCommandCompletion> Complete(PluginCommand command)

Parameters

command PluginCommand

What the player has typed so far.

Returns

IReadOnlyList<PluginCommandCompletion>

The candidates, best first; empty for none.

Invoke(PluginCommand)

Carries the command out.

PluginCommandResult Invoke(PluginCommand command)

Parameters

command PluginCommand

What the player typed.

Returns

PluginCommandResult

Whether it was carried out, and what to tell the player.