Class RootCommandNode<S>

Type Parameters

S

Hierarchy

CommandNode<S>
- RootCommandNode

Constructors

constructor

new RootCommandNode<S>(): RootCommandNode<S>
Type Parameters
- S
Returns RootCommandNode<S>
Overrides CommandNode<S>.constructor
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:10

Methods

addChild

addChild(node: CommandNode<S>): void
Parameters
- node: CommandNode<S>
Returns void
Inherited from CommandNode.addChild
- Defined in packages/brigadier/src/tree/CommandNode.ts:74

canUse

canUse(source: S): boolean
Parameters
- source: S
Returns boolean
Inherited from CommandNode.canUse
- Defined in packages/brigadier/src/tree/CommandNode.ts:70

compareTo

compareTo(o: CommandNode<S>): number
Parameters
- o: CommandNode<S>
Returns number
Inherited from CommandNode.compareTo
- Defined in packages/brigadier/src/tree/CommandNode.ts:178

createBuilder

createBuilder(): ArgumentBuilder<S, any>
Returns ArgumentBuilder<S, any>
Overrides CommandNode.createBuilder
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:49

equals

equals(o: object): boolean
Parameters
- o: object
Returns boolean
Overrides CommandNode.equals
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:42

findAmbiguities

findAmbiguities(consumer: AmbiguityConsumer<S>, context: any): void
Parameters
- consumer: AmbiguityConsumer<S>
- context: any
Returns void
Inherited from CommandNode.findAmbiguities
- Defined in packages/brigadier/src/tree/CommandNode.ts:101

getChild

getChild(name: string): undefined | CommandNode<S>
Parameters
- name: string
Returns undefined | CommandNode<S>
Inherited from CommandNode.getChild
- Defined in packages/brigadier/src/tree/CommandNode.ts:58

getChildren

getChildren(): IterableIterator<CommandNode<S>>
Returns IterableIterator<CommandNode<S>>
Inherited from CommandNode.getChildren
- Defined in packages/brigadier/src/tree/CommandNode.ts:50

getChildrenCount

getChildrenCount(): number
Returns number
Inherited from CommandNode.getChildrenCount
- Defined in packages/brigadier/src/tree/CommandNode.ts:54

getCommand

getCommand(): null | Command<S>
Returns null | Command<S>
Inherited from CommandNode.getCommand
- Defined in packages/brigadier/src/tree/CommandNode.ts:46

getExamples

getExamples(): Iterable<string>
Returns Iterable<string>
Overrides CommandNode.getExamples
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:57

getName

getName(): string
Returns string
Overrides CommandNode.getName
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:24

getNodeType

getNodeType(): string
Returns string
Overrides CommandNode.getNodeType
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:20

getRedirect

getRedirect(): null | CommandNode<S>
Returns null | CommandNode<S>
Inherited from CommandNode.getRedirect
- Defined in packages/brigadier/src/tree/CommandNode.ts:62

getRedirectModifier

getRedirectModifier(): null | RedirectModifier<S>
Returns null | RedirectModifier<S>
Inherited from CommandNode.getRedirectModifier
- Defined in packages/brigadier/src/tree/CommandNode.ts:66

getRelevantNodes

getRelevantNodes(input: StringReader): Iterable<CommandNode<S>>
Parameters
- input: StringReader
Returns Iterable<CommandNode<S>>
Inherited from CommandNode.getRelevantNodes
- Defined in packages/brigadier/src/tree/CommandNode.ts:158

getRequirement

getRequirement(): Predicate<S>
Returns Predicate<S>
Inherited from CommandNode.getRequirement
- Defined in packages/brigadier/src/tree/CommandNode.ts:142

getSortedKey

getSortedKey(): string
Returns string
Overrides CommandNode.getSortedKey
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:53

getUsageText

getUsageText(): string
Returns string
Overrides CommandNode.getUsageText
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:28

isFork

isFork(): boolean
Returns boolean
Inherited from CommandNode.isFork
- Defined in packages/brigadier/src/tree/CommandNode.ts:186

isValidInput

isValidInput(_input: String): boolean
Parameters
- _input: String
Returns boolean
Overrides CommandNode.isValidInput
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:38

listSuggestions

listSuggestions(
_context: CommandContext<S>,
_builder: SuggestionsBuilder,
): Promise<Suggestions>
Parameters
- _context: CommandContext<S>
- _builder: SuggestionsBuilder
Returns Promise<Suggestions>
Overrides CommandNode.listSuggestions
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:34

parse

parse(_reader: StringReader, _contextBuilder: CommandContextBuilder<S>): void
Parameters
- _reader: StringReader
- _contextBuilder: CommandContextBuilder<S>
Returns void
Overrides CommandNode.parse
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:32

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in packages/brigadier/src/tree/RootCommandNode.ts:61