CommandNode

Namespace Mc.Scripting.Commands · Kind class (sealed)

public sealed class CommandNode

A node of a command tree under construction: a literal word or a typed argument, with children, an executor, requirements and suggestions. Build trees with Command.Literal / Command.Argument and register them with CommandRegistry.Register.

Properties

Member	Description
`bool IsLiteral { get; }`	Whether this is a literal word.
`string Name { get; }`	The literal word or the argument name.
`ArgType? Type { get; }`	The argument type, null for a literal.

`IsLiteral`

public bool IsLiteral { get; }

Whether this is a literal word.

`Name`

public string Name { get; }

The literal word or the argument name.

`Type`

public ArgType? Type { get; }

The argument type, null for a literal.

Methods

Member	Description
`CommandNode Executes(CommandExecutor executor)`	Runs `executor` when the command line ends at this node.
`CommandNode Executes(Action<CommandContext> action)`	Runs `action` when the command line ends at this node; the result is `CommandContext.Result` (default 1).
`CommandNode OpLevel(int level)`	Requires a vanilla operator level (0-4) for this node.
`CommandNode Permission(string node)`	Requires a permission node (see `Mc.Scripting.Permissions`) to see and use this node.
`CommandNode Requires(Func<CommandSource, bool> requirement)`	Requires an arbitrary condition of the command source.
`CommandNode Suggests(SuggestionProvider provider)`	Provides tab-completion suggestions for this argument (server-side, on the tick thread).
`CommandNode Suggests(Func<CommandContext, IEnumerable<string>> provider)`	Provides suggestions from a list computed on the tick thread.
`CommandNode SuggestsAsync(AsyncSuggestionProvider provider)`	Provides suggestions asynchronously (the client waits until the task completes).
`CommandNode Then(CommandNode child)`	Adds a child node.

`Executes`

public CommandNode Executes(CommandExecutor executor)

Runs executor when the command line ends at this node.

Parameters

Name	Type	Description
`executor`	`CommandExecutor`	Returns the command result (1 = success).