API reference / @jsprismarine/brigadier / CommandDispatcher

Class: CommandDispatcher<S>

Defined in: CommandDispatcher.ts:23

Type Parameters

S

S

Constructors

Constructor

new CommandDispatcher<S>(root?): CommandDispatcher<S>

Defined in: CommandDispatcher.ts:30

Parameters

root?

RootCommandNode<S> | null = null

Returns

CommandDispatcher<S>

Methods

execute()

execute(input, source?): any

Defined in: CommandDispatcher.ts:44

Parameters

input

string | StringReader | ParseResults<S>

source?

S | null = null

Returns

any

---

findAmbiguities()

findAmbiguities(consumer, context): void

Defined in: CommandDispatcher.ts:393

Parameters

consumer

AmbiguityConsumer<S>

context

any

Returns

void

---

findNode()

findNode(path): CommandNode<S> | null

Defined in: CommandDispatcher.ts:384

Parameters

path

string[]

Returns

CommandNode<S> | null

---

getAllUsage()

getAllUsage(node, source, restricted): string[]

Defined in: CommandDispatcher.ts:224

Parameters

node

CommandNode<S>

source

S

restricted

boolean

Returns

string[]

---

getCompletionSuggestions()

getCompletionSuggestions(parse, cursor?): Promise<Suggestions>

Defined in: CommandDispatcher.ts:335

Parameters

parse

ParseResults<S>

cursor?

number = ...

Returns

Promise<Suggestions>

---

getPath()

getPath(target): string[]

Defined in: CommandDispatcher.ts:367

Parameters

target

CommandNode<S>

Returns

string[]

---

getRoot()

getRoot(): RootCommandNode<S>

Defined in: CommandDispatcher.ts:363

Returns

RootCommandNode<S>

---

getSmartUsage()

getSmartUsage(node, source): Map<CommandNode<S>, string>

Defined in: CommandDispatcher.ts:259

Parameters

node

CommandNode<S>

source

S

Returns

Map<CommandNode<S>, string>

---

parse()

parse(command, source): ParseResults<S>

Defined in: CommandDispatcher.ts:133

Parameters

command

string | StringReader

source

S

Returns

ParseResults<S>

---

register()

register(command): LiteralCommandNode<S>

Defined in: CommandDispatcher.ts:34

Parameters

command

LiteralArgumentBuilder<S>

Returns

LiteralCommandNode<S>

---

setConsumer()

setConsumer(consumer): void

Defined in: CommandDispatcher.ts:40

Parameters

consumer

ResultConsumer<S>

Returns

void