Skip to content

API reference / @jsprismarine/brigadier / SuggestionsBuilder

Class: SuggestionsBuilder ​

Defined in: suggestion/SuggestionsBuilder.ts:7

Constructors ​

Constructor ​

new SuggestionsBuilder(input, start): SuggestionsBuilder

Defined in: suggestion/SuggestionsBuilder.ts:16

Parameters ​

input ​

string

start ​

number

Returns ​

SuggestionsBuilder

Methods ​

add() ​

add(other): SuggestionsBuilder

Defined in: suggestion/SuggestionsBuilder.ts:54

Parameters ​

other ​

SuggestionsBuilder

Returns ​

SuggestionsBuilder


build() ​

build(): Suggestions

Defined in: suggestion/SuggestionsBuilder.ts:34

Returns ​

Suggestions


buildPromise() ​

buildPromise(): Promise<Suggestions>

Defined in: suggestion/SuggestionsBuilder.ts:38

Returns ​

Promise<Suggestions>


createOffset() ​

createOffset(start?): SuggestionsBuilder

Defined in: suggestion/SuggestionsBuilder.ts:59

Parameters ​

start? ​

number = ...

Returns ​

SuggestionsBuilder


getInput() ​

getInput(): String

Defined in: suggestion/SuggestionsBuilder.ts:22

Returns ​

String


getRemaining() ​

getRemaining(): string

Defined in: suggestion/SuggestionsBuilder.ts:30

Returns ​

string


getStart() ​

getStart(): number

Defined in: suggestion/SuggestionsBuilder.ts:26

Returns ​

number


restart() ​

restart(): SuggestionsBuilder

Defined in: suggestion/SuggestionsBuilder.ts:63

Returns ​

SuggestionsBuilder


suggest() ​

suggest(text, tooltip?): SuggestionsBuilder

Defined in: suggestion/SuggestionsBuilder.ts:42

Parameters ​

text ​

string | number

tooltip? ​

Message | null = null

Returns ​

SuggestionsBuilder