Class LiteralCommandNode<S>

Type Parameters

Hierarchy

CommandNode<S>
- LiteralCommandNode

Constructors

constructor

new LiteralCommandNode<S>(
    literal: string,
    command: Command<S>,
    requirement: Predicate<S>,
    redirect: null | CommandNode<S>,
    modifier: null | RedirectModifier<S>,
    forks: boolean,
): LiteralCommandNode<S>
Type Parameters
- S
Parameters
- literal: string
- command: Command<S>
- requirement: Predicate<S>
- redirect: null | CommandNode<S>
- modifier: null | RedirectModifier<S>
- forks: boolean
Returns LiteralCommandNode<S>
Overrides CommandNode<S>.constructor
- Defined in packages/brigadier/src/tree/LiteralCommandNode.ts:17

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(): LiteralArgumentBuilder<S>
Returns LiteralArgumentBuilder<S>
Overrides CommandNode.createBuilder
- Defined in packages/brigadier/src/tree/LiteralCommandNode.ts:93

equals

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

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/LiteralCommandNode.ts:106

getLiteral

getLiteral(): string
Returns string
- Defined in packages/brigadier/src/tree/LiteralCommandNode.ts:33

getName

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

getNodeType

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

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/LiteralCommandNode.ts:102

getUsageText

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

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/LiteralCommandNode.ts:76

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/LiteralCommandNode.ts:68

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/LiteralCommandNode.ts:41

toString

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

Returns string
- Defined in packages/brigadier/src/tree/LiteralCommandNode.ts:110

Class LiteralCommandNode<S>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LiteralCommandNode<S>

Methods

addChild

Parameters

Returns void

canUse

Parameters

Returns boolean

compareTo

Parameters

Returns number

createBuilder

Returns LiteralArgumentBuilder<S>

equals

Parameters

Returns boolean

findAmbiguities

Parameters

Returns void

getChild

Parameters

Returns undefined | CommandNode<S>

getChildren

Returns IterableIterator<CommandNode<S>>

getChildrenCount

Returns number

getCommand

Returns null | Command<S>

getExamples

Returns Iterable<string>

getLiteral

Returns string

getName

Returns string

getNodeType

Returns string

getRedirect

Returns null | CommandNode<S>

getRedirectModifier

Returns null | RedirectModifier<S>

getRelevantNodes

Parameters

Returns Iterable<CommandNode<S>>

getRequirement

Returns Predicate<S>

getSortedKey

Returns string

getUsageText

Returns string

isFork

Returns boolean

isValidInput

Parameters

Returns boolean

listSuggestions

Parameters

Returns Promise<Suggestions>

parse

Parameters

Returns void

toString

Returns string

Settings

On This Page