JSPrismarine

API reference / @jsprismarine/brigadier / RequiredArgumentBuilder

Class: RequiredArgumentBuilder<S, T> ​

Defined in: tree/ArgumentCommandNode.ts:131

Extends ​

  • ArgumentBuilder<S, RequiredArgumentBuilder<S, T>>

Type Parameters ​

S ​

S

T ​

T

Methods ​

build() ​

build(): ArgumentCommandNode<S, T>

Defined in: tree/ArgumentCommandNode.ts:167

Returns ​

ArgumentCommandNode<S, T>

Overrides ​

ArgumentBuilder.build

executes() ​

executes(command): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:39

Parameters ​

command ​

Command<S>

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.executes

fork() ​

fork(target, modifier): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:65

Parameters ​

target ​

CommandNode<S>

modifier ​

RedirectModifier<S>

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.fork

forward() ​

forward(target, modifier, fork): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:69

Parameters ​

target ​

CommandNode<S>

modifier ​

RedirectModifier<S> | null

fork ​

boolean

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.forward

getArguments() ​

getArguments(): Iterable<CommandNode<S>>

Defined in: builder/ArgumentBuilder.ts:35

Returns ​

Iterable<CommandNode<S>>

Inherited from ​

ArgumentBuilder.getArguments

getCommand() ​

getCommand(): Command<S>

Defined in: builder/ArgumentBuilder.ts:44

Returns ​

Command<S>

Inherited from ​

ArgumentBuilder.getCommand

getName() ​

getName(): string

Defined in: tree/ArgumentCommandNode.ts:163

Returns ​

string

getRedirect() ​

getRedirect(): CommandNode<S> | null

Defined in: builder/ArgumentBuilder.ts:80

Returns ​

CommandNode<S> | null

Inherited from ​

ArgumentBuilder.getRedirect

getRedirectModifier() ​

getRedirectModifier(): RedirectModifier<S> | null

Defined in: builder/ArgumentBuilder.ts:84

Returns ​

RedirectModifier<S> | null

Inherited from ​

ArgumentBuilder.getRedirectModifier

getRequirement() ​

getRequirement(): Predicate<S>

Defined in: builder/ArgumentBuilder.ts:53

Returns ​

Predicate<S>

Inherited from ​

ArgumentBuilder.getRequirement

getSuggestionsProvider() ​

getSuggestionsProvider(): SuggestionProvider<S>

Defined in: tree/ArgumentCommandNode.ts:151

Returns ​

SuggestionProvider<S>

getThis() ​

getThis(): RequiredArgumentBuilder<S, T>

Defined in: tree/ArgumentCommandNode.ts:155

Returns ​

RequiredArgumentBuilder<S, T>

Overrides ​

ArgumentBuilder.getThis

getType() ​

getType(): ArgumentType<T>

Defined in: tree/ArgumentCommandNode.ts:159

Returns ​

ArgumentType<T>

isFork() ​

isFork(): boolean

Defined in: builder/ArgumentBuilder.ts:88

Returns ​

boolean

Inherited from ​

ArgumentBuilder.isFork

redirect() ​

redirect(target, modifier?): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:57

Parameters ​

target ​

CommandNode<S>

modifier? ​

SingleRedirectModifier<S>

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.redirect

requires() ​

requires(requirement): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:48

Parameters ​

requirement ​

Predicate<S>

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.requires

suggests() ​

suggests(provider): RequiredArgumentBuilder<S, T>

Defined in: tree/ArgumentCommandNode.ts:146

Parameters ​

provider ​

SuggestionProvider<S>

Returns ​

RequiredArgumentBuilder<S, T>

then() ​

then(arg): RequiredArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:24

Parameters ​

arg ​

CommandNode<S> | ArgumentBuilder<S, any>

Returns ​

RequiredArgumentBuilder

Inherited from ​

ArgumentBuilder.then

argument() ​

static argument<S, T>(name, type): RequiredArgumentBuilder<S, T>

Defined in: tree/ArgumentCommandNode.ts:142

Type Parameters ​

S ​

S

T ​

T

Parameters ​

name ​

string

type ​

ArgumentType<T>

Returns ​

RequiredArgumentBuilder<S, T>