JSPrismarine

API reference / @jsprismarine/brigadier / ArgumentCommandNode

Class: ArgumentCommandNode<S, T> ​

Defined in: tree/ArgumentCommandNode.ts:19

Extends ​

  • CommandNode<S>

Type Parameters ​

S ​

S

T ​

T

Constructors ​

Constructor ​

new ArgumentCommandNode<S, T>(name, type, command, requirement, redirect, modifier, forks, customSuggestions): ArgumentCommandNode<S, T>

Defined in: tree/ArgumentCommandNode.ts:24

Parameters ​

name ​

string

type ​

ArgumentType<T>

command ​

Command<S>

requirement ​

Predicate<S>

redirect ​

CommandNode<S> | null

modifier ​

RedirectModifier<S> | null

forks ​

boolean

customSuggestions ​

SuggestionProvider<S>

Returns ​

ArgumentCommandNode<S, T>

Overrides ​

CommandNode<S>.constructor

Methods ​

addChild() ​

addChild(node): void

Defined in: tree/CommandNode.ts:74

Parameters ​

node ​

CommandNode<S>

Returns ​

void

Inherited from ​

CommandNode.addChild

canUse() ​

canUse(source): boolean

Defined in: tree/CommandNode.ts:70

Parameters ​

source ​

S

Returns ​

boolean

Inherited from ​

CommandNode.canUse

compareTo() ​

compareTo(o): number

Defined in: tree/CommandNode.ts:178

Parameters ​

o ​

CommandNode<S>

Returns ​

number

Inherited from ​

CommandNode.compareTo

createBuilder() ​

createBuilder(): RequiredArgumentBuilder<S, T>

Defined in: tree/ArgumentCommandNode.ts:86

Returns ​

RequiredArgumentBuilder<S, T>

Overrides ​

CommandNode.createBuilder

equals() ​

equals(o): boolean

Defined in: tree/ArgumentCommandNode.ts:108

Parameters ​

o ​

object

Returns ​

boolean

Overrides ​

CommandNode.equals

findAmbiguities() ​

findAmbiguities(consumer, context): void

Defined in: tree/CommandNode.ts:101

Parameters ​

consumer ​

AmbiguityConsumer<S>

context ​

any

Returns ​

void

Inherited from ​

CommandNode.findAmbiguities

getChild() ​

getChild(name): CommandNode<S> | undefined

Defined in: tree/CommandNode.ts:58

Parameters ​

name ​

string

Returns ​

CommandNode<S> | undefined

Inherited from ​

CommandNode.getChild

getChildren() ​

getChildren(): MapIterator<CommandNode<S>>

Defined in: tree/CommandNode.ts:50

Returns ​

MapIterator<CommandNode<S>>

Inherited from ​

CommandNode.getChildren

getChildrenCount() ​

getChildrenCount(): number

Defined in: tree/CommandNode.ts:54

Returns ​

number

Inherited from ​

CommandNode.getChildrenCount

getCommand() ​

getCommand(): Command<S> | null

Defined in: tree/CommandNode.ts:46

Returns ​

Command<S> | null

Inherited from ​

CommandNode.getCommand

getCustomSuggestions() ​

getCustomSuggestions(): SuggestionProvider<S> | null

Defined in: tree/ArgumentCommandNode.ts:65

Returns ​

SuggestionProvider<S> | null

getExamples() ​

getExamples(): Iterable<string>

Defined in: tree/ArgumentCommandNode.ts:122

Returns ​

Iterable<string>

Overrides ​

CommandNode.getExamples

getName() ​

getName(): string

Defined in: tree/ArgumentCommandNode.ts:57

Returns ​

string

Overrides ​

CommandNode.getName

getNodeType() ​

getNodeType(): string

Defined in: tree/ArgumentCommandNode.ts:40

Returns ​

string

Overrides ​

CommandNode.getNodeType

getRedirect() ​

getRedirect(): CommandNode<S> | null

Defined in: tree/CommandNode.ts:62

Returns ​

CommandNode<S> | null

Inherited from ​

CommandNode.getRedirect

getRedirectModifier() ​

getRedirectModifier(): RedirectModifier<S> | null

Defined in: tree/CommandNode.ts:66

Returns ​

RedirectModifier<S> | null

Inherited from ​

CommandNode.getRedirectModifier

getRelevantNodes() ​

getRelevantNodes(input): Iterable<CommandNode<S>>

Defined in: tree/CommandNode.ts:158

Parameters ​

input ​

StringReader

Returns ​

Iterable<CommandNode<S>>

Inherited from ​

CommandNode.getRelevantNodes

getRequirement() ​

getRequirement(): Predicate<S>

Defined in: tree/CommandNode.ts:142

Returns ​

Predicate<S>

Inherited from ​

CommandNode.getRequirement

getSortedKey() ​

getSortedKey(): string

Defined in: tree/ArgumentCommandNode.ts:118

Returns ​

string

Overrides ​

CommandNode.getSortedKey

getType() ​

getType(): ArgumentType<T>

Defined in: tree/ArgumentCommandNode.ts:44

Returns ​

ArgumentType<T>

getUsageText() ​

getUsageText(): string

Defined in: tree/ArgumentCommandNode.ts:61

Returns ​

string

Overrides ​

CommandNode.getUsageText

isFork() ​

isFork(): boolean

Defined in: tree/CommandNode.ts:186

Returns ​

boolean

Inherited from ​

CommandNode.isFork

isValidInput() ​

isValidInput(input, context): boolean

Defined in: tree/ArgumentCommandNode.ts:98

Parameters ​

input ​

string

context ​

any

Returns ​

boolean

Overrides ​

CommandNode.isValidInput

listSuggestions() ​

listSuggestions(context, builder): Promise<Suggestions>

Defined in: tree/ArgumentCommandNode.ts:77

Parameters ​

context ​

CommandContext<S>

builder ​

SuggestionsBuilder

Returns ​

Promise<Suggestions>

Overrides ​

CommandNode.listSuggestions

parse() ​

parse(reader, contextBuilder): void

Defined in: tree/ArgumentCommandNode.ts:69

Parameters ​

reader ​

StringReader

contextBuilder ​

CommandContextBuilder<S>

Returns ​

void

Overrides ​

CommandNode.parse

setType() ​

setType(type): void

Defined in: tree/ArgumentCommandNode.ts:53

Replaces the parser while keeping this node's name, command, and children.

Parameters ​

type ​

ArgumentType<T>

The replacement parser.

Returns ​

void

toString() ​

toString(): string

Defined in: tree/ArgumentCommandNode.ts:126

Returns a string representation of an object.

Returns ​

string