JSPrismarine

API reference / @jsprismarine/brigadier / LiteralArgumentBuilder

Class: LiteralArgumentBuilder<S> ​

Defined in: tree/LiteralCommandNode.ts:115

Extends ​

  • ArgumentBuilder<S, LiteralArgumentBuilder<S>>

Type Parameters ​

S ​

S

Constructors ​

Constructor ​

new LiteralArgumentBuilder<S>(literal): LiteralArgumentBuilder<S>

Defined in: tree/LiteralCommandNode.ts:118

Parameters ​

literal ​

string

Returns ​

LiteralArgumentBuilder<S>

Overrides ​

ArgumentBuilder<S, LiteralArgumentBuilder<S>>.constructor

Methods ​

build() ​

build(): LiteralCommandNode<S>

Defined in: tree/LiteralCommandNode.ts:135

Returns ​

LiteralCommandNode<S>

Overrides ​

ArgumentBuilder.build

executes() ​

executes(command): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:39

Parameters ​

command ​

Command<S>

Returns ​

LiteralArgumentBuilder

Inherited from ​

ArgumentBuilder.executes

fork() ​

fork(target, modifier): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:65

Parameters ​

target ​

CommandNode<S>

modifier ​

RedirectModifier<S>

Returns ​

LiteralArgumentBuilder

Inherited from ​

ArgumentBuilder.fork

forward() ​

forward(target, modifier, fork): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:69

Parameters ​

target ​

CommandNode<S>

modifier ​

RedirectModifier<S> | null

fork ​

boolean

Returns ​

LiteralArgumentBuilder

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

getLiteral() ​

getLiteral(): string

Defined in: tree/LiteralCommandNode.ts:131

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

getThis() ​

getThis(): LiteralArgumentBuilder<S>

Defined in: tree/LiteralCommandNode.ts:127

Returns ​

LiteralArgumentBuilder<S>

Overrides ​

ArgumentBuilder.getThis

isFork() ​

isFork(): boolean

Defined in: builder/ArgumentBuilder.ts:88

Returns ​

boolean

Inherited from ​

ArgumentBuilder.isFork

redirect() ​

redirect(target, modifier?): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:57

Parameters ​

target ​

CommandNode<S>

modifier? ​

SingleRedirectModifier<S>

Returns ​

LiteralArgumentBuilder

Inherited from ​

ArgumentBuilder.redirect

requires() ​

requires(requirement): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:48

Parameters ​

requirement ​

Predicate<S>

Returns ​

LiteralArgumentBuilder

Inherited from ​

ArgumentBuilder.requires

then() ​

then(arg): LiteralArgumentBuilder

Defined in: builder/ArgumentBuilder.ts:24

Parameters ​

arg ​

CommandNode<S> | ArgumentBuilder<S, any>

Returns ​

LiteralArgumentBuilder

Inherited from ​

ArgumentBuilder.then

literal() ​

static literal<S>(name): LiteralArgumentBuilder<S>

Defined in: tree/LiteralCommandNode.ts:123

Type Parameters ​

S ​

S

Parameters ​

name ​

string

Returns ​

LiteralArgumentBuilder<S>