Class CommandDispatcher

Namespace: Void.Minecraft.Commands.Brigadier
Assembly: Void.Minecraft.dll

public record CommandDispatcher : ICommandDispatcher, IEquatable<CommandDispatcher>

Inheritance

object ← CommandDispatcher

Implements

ICommandDispatcher, IEquatable<CommandDispatcher>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

CommandDispatcher(RootCommandNode)

public CommandDispatcher(RootCommandNode Root)

Parameters

Root RootCommandNode

CommandDispatcher()

public CommandDispatcher()

Fields

ArgumentSeparator

public const char ArgumentSeparator = ' '

Field Value

char

Properties

Consumer

public ResultConsumer Consumer { get; set; }

Property Value

ResultConsumer

Root

public RootCommandNode Root { get; init; }

Property Value

RootCommandNode

Methods

Add(ICommandNode)

public void Add(ICommandNode node)

Parameters

node ICommandNode

All(CommandNode?)

public IEnumerable<CommandNode> All(CommandNode? root = null)

Parameters

root CommandNode?

Returns

IEnumerable<CommandNode>

ExecuteAsync(string, ICommandSource, CancellationToken)

public ValueTask<int> ExecuteAsync(string input, ICommandSource source, CancellationToken cancellationToken)

Parameters

input string

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<int>

ExecuteAsync(StringReader, ICommandSource, CancellationToken)

public ValueTask<int> ExecuteAsync(StringReader input, ICommandSource source, CancellationToken cancellationToken)

Parameters

input StringReader

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<int>

ExecuteAsync(ParseResults, CancellationToken)

public ValueTask<int> ExecuteAsync(ParseResults parse, CancellationToken cancellationToken)

Parameters

parse ParseResults

cancellationToken CancellationToken

Returns

ValueTask<int>

FindNode(List<string>)

public CommandNode? FindNode(List<string> path)

Parameters

path List<string>

Returns

CommandNode?

GetAllUsageAsync(CommandNode, ICommandSource, bool, CancellationToken)

public ValueTask<string[]> GetAllUsageAsync(CommandNode node, ICommandSource source, bool restricted, CancellationToken cancellationToken)

Parameters

node CommandNode

source ICommandSource

restricted bool

cancellationToken CancellationToken

Returns

ValueTask<string[]>

GetCompletionSuggestions(ParseResults, CancellationToken)

public static ValueTask<Suggestions> GetCompletionSuggestions(ParseResults parse, CancellationToken cancellationToken)

Parameters

parse ParseResults

cancellationToken CancellationToken

Returns

ValueTask<Suggestions>

GetCompletionSuggestions(ParseResults, int, CancellationToken)

public static ValueTask<Suggestions> GetCompletionSuggestions(ParseResults parse, int cursor, CancellationToken cancellationToken)

Parameters

parse ParseResults

cursor int

cancellationToken CancellationToken

Returns

ValueTask<Suggestions>

GetPath(CommandNode)

public List<string> GetPath(CommandNode target)

Parameters

target CommandNode

Returns

List<string>

GetSmartUsageAsync(CommandNode, ICommandSource, CancellationToken)

public ValueTask<Dictionary<CommandNode, string>> GetSmartUsageAsync(CommandNode node, ICommandSource source, CancellationToken cancellationToken)

Parameters

node CommandNode

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<Dictionary<CommandNode, string>>

Parse(string, ICommandSource, CancellationToken)

public ValueTask<ParseResults> Parse(string command, ICommandSource source, CancellationToken cancellationToken)

Parameters

command string

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<ParseResults>

ParseAsync(StringReader, ICommandSource, CancellationToken)

public ValueTask<ParseResults> ParseAsync(StringReader command, ICommandSource source, CancellationToken cancellationToken)

Parameters

command StringReader

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<ParseResults>

Register(LiteralArgumentBuilder)

public LiteralCommandNode Register(LiteralArgumentBuilder command)

Parameters

command LiteralArgumentBuilder

Returns

LiteralCommandNode

Register(Func<IArgumentContext, LiteralArgumentBuilder>)

public LiteralCommandNode Register(Func<IArgumentContext, LiteralArgumentBuilder> command)

Parameters

command Func<IArgumentContext, LiteralArgumentBuilder>

Returns

LiteralCommandNode

SuggestAsync(string, ICommandSource, CancellationToken)

public ValueTask<Suggestions> SuggestAsync(string input, ICommandSource source, CancellationToken cancellationToken)

Parameters

input string

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<Suggestions>

SuggestAsync(StringReader, ICommandSource, CancellationToken)

public ValueTask<Suggestions> SuggestAsync(StringReader input, ICommandSource source, CancellationToken cancellationToken)

Parameters

input StringReader

source ICommandSource

cancellationToken CancellationToken

Returns

ValueTask<Suggestions>