Class LiteralArgumentBuilder<S>

Type Parameters

S

Hierarchy

ArgumentBuilder<S, LiteralArgumentBuilder<S>>
- LiteralArgumentBuilder

Index

Constructors

Methods

build executes fork forward getArguments getCommand getLiteral getRedirect getRedirectModifier getRequirement getThis isFork redirect requires then literal

Constructors

constructor

new LiteralArgumentBuilder<S>(literal: string): LiteralArgumentBuilder<S>
Type Parameters
- S
Parameters
- literal: string
Returns LiteralArgumentBuilder<S>
Overrides ArgumentBuilder<S, LiteralArgumentBuilder<S>>.constructor
- Defined in packages/brigadier/src/builder/LiteralArgumentBuilder.ts:7

Methods

build

build(): LiteralCommandNode<S>
Returns LiteralCommandNode<S>
Overrides ArgumentBuilder.build
- Defined in packages/brigadier/src/builder/LiteralArgumentBuilder.ts:24

executes

executes(command: Command<S>): LiteralArgumentBuilder
Parameters
- command: Command<S>
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.executes
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:39

fork

fork(
target: CommandNode<S>,
modifier: RedirectModifier<S>,
): LiteralArgumentBuilder
Parameters
- target: CommandNode<S>
- modifier: RedirectModifier<S>
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.fork
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:61

forward

forward(
    target: CommandNode<S>,
    modifier: null | RedirectModifier<S>,
    fork: boolean,
): LiteralArgumentBuilder
Parameters
- target: CommandNode<S>
- modifier: null | RedirectModifier<S>
- fork: boolean
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.forward
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:65

getArguments

getArguments(): Iterable<CommandNode<S>>
Returns Iterable<CommandNode<S>>
Inherited from ArgumentBuilder.getArguments
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:35

getCommand

getCommand(): Command<S>
Returns Command<S>
Inherited from ArgumentBuilder.getCommand
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:44

getLiteral

getLiteral(): string
Returns string
- Defined in packages/brigadier/src/builder/LiteralArgumentBuilder.ts:20

getRedirect

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

getRedirectModifier

getRedirectModifier(): null | RedirectModifier<S>
Returns null | RedirectModifier<S>
Inherited from ArgumentBuilder.getRedirectModifier
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:80

getRequirement

getRequirement(): Predicate<S>
Returns Predicate<S>
Inherited from ArgumentBuilder.getRequirement
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:53

getThis

getThis(): LiteralArgumentBuilder<S>
Returns LiteralArgumentBuilder<S>
Overrides ArgumentBuilder.getThis
- Defined in packages/brigadier/src/builder/LiteralArgumentBuilder.ts:16

isFork

isFork(): boolean
Returns boolean
Inherited from ArgumentBuilder.isFork
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:84

redirect

redirect(
target: CommandNode<S>,
modifier?: SingleRedirectModifier<S>,
): LiteralArgumentBuilder
Parameters
- target: CommandNode<S>
- Optionalmodifier: SingleRedirectModifier<S>
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.redirect
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:57

requires

requires(requirement: Predicate<S>): LiteralArgumentBuilder
Parameters
- requirement: Predicate<S>
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.requires
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:48

then

then(arg: CommandNode<S> | ArgumentBuilder<S, any>): LiteralArgumentBuilder
Parameters
- arg: CommandNode<S> | ArgumentBuilder<S, any>
Returns LiteralArgumentBuilder
Inherited from ArgumentBuilder.then
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:24

`Static`literal

literal<S>(name: string): LiteralArgumentBuilder<S>
Type Parameters
- S
Parameters
- name: string
Returns LiteralArgumentBuilder<S>
- Defined in packages/brigadier/src/builder/LiteralArgumentBuilder.ts:12