JSPrismarine

API reference / @jsprismarine/brigadier / BoolArgumentType

Class: BoolArgumentType ​

Defined in: arguments/BoolArgumentType.ts:9

Implements ​

Methods ​

getExamples() ​

getExamples(): Iterable<string>

Defined in: arguments/BoolArgumentType.ts:36

Returns ​

Iterable<string>

Implementation of ​

ArgumentType.getExamples

listSuggestions() ​

listSuggestions<S>(_context, builder): Promise<Suggestions>

Defined in: arguments/BoolArgumentType.ts:24

Type Parameters ​

S ​

S

Parameters ​

_context ​

CommandContext<S>

builder ​

SuggestionsBuilder

Returns ​

Promise<Suggestions>

Implementation of ​

ArgumentType.listSuggestions

parse() ​

parse(reader): boolean

Defined in: arguments/BoolArgumentType.ts:20

Parameters ​

reader ​

StringReader

Returns ​

boolean

Implementation of ​

ArgumentType.parse

bool() ​

static bool(): BoolArgumentType

Defined in: arguments/BoolArgumentType.ts:12

Returns ​

BoolArgumentType

getBool() ​

static getBool<S>(context, name): boolean

Defined in: arguments/BoolArgumentType.ts:16

Type Parameters ​

S ​

S

Parameters ​

context ​

CommandContext<S>

name ​

string

Returns ​

boolean