Class RequiredArgumentBuilder<S, T>

Type Parameters

S
T

Hierarchy

ArgumentBuilder<S, RequiredArgumentBuilder<S, T>>
- RequiredArgumentBuilder

Index

Methods

build executes fork forward getArguments getCommand getName getRedirect getRedirectModifier getRequirement getSuggestionsProvider getThis getType isFork redirect requires suggests then argument

Methods

build

build(): ArgumentCommandNode<S, T>
Returns ArgumentCommandNode<S, T>
Overrides ArgumentBuilder.build
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:42

executes

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

fork

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

forward

forward(
    target: CommandNode<S>,
    modifier: null | RedirectModifier<S>,
    fork: boolean,
): RequiredArgumentBuilder
Parameters
- target: CommandNode<S>
- modifier: null | RedirectModifier<S>
- fork: boolean
Returns RequiredArgumentBuilder
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

getName

getName(): string
Returns string
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:38

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

getSuggestionsProvider

getSuggestionsProvider(): SuggestionProvider<S>
Returns SuggestionProvider<S>
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:26

getThis

getThis(): RequiredArgumentBuilder<S, T>
Returns RequiredArgumentBuilder<S, T>
Overrides ArgumentBuilder.getThis
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:30

getType

getType(): ArgumentType<T>
Returns ArgumentType<T>
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:34

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>,
): RequiredArgumentBuilder
Parameters
- target: CommandNode<S>
- Optionalmodifier: SingleRedirectModifier<S>
Returns RequiredArgumentBuilder
Inherited from ArgumentBuilder.redirect
- Defined in packages/brigadier/src/builder/ArgumentBuilder.ts:57

requires

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

suggests

suggests(provider: SuggestionProvider<S>): RequiredArgumentBuilder<S, T>
Parameters
- provider: SuggestionProvider<S>
Returns RequiredArgumentBuilder<S, T>
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:21

then

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

`Static`argument

argument<S, T>(
name: string,
type: ArgumentType<T>,
): RequiredArgumentBuilder<S, T>
Type Parameters
- S
- T
Parameters
- name: string
- type: ArgumentType<T>
Returns RequiredArgumentBuilder<S, T>
- Defined in packages/brigadier/src/builder/RequiredArgumentBuilder.ts:17