API reference / @jsprismarine/brigadier / Suggestion

Class: Suggestion

Defined in: suggestion/Suggestion.ts:5

Constructors

Constructor

new Suggestion(range, text, tooltip?): Suggestion

Defined in: suggestion/Suggestion.ts:10

Parameters

range

StringRange

text

string

tooltip?

Message | null = null

Returns

Suggestion

Methods

apply()

apply(input): string

Defined in: suggestion/Suggestion.ts:28

Parameters

input

string

Returns

string

---

compareTo()

compareTo(o): number

Defined in: suggestion/Suggestion.ts:68

Parameters

o

Suggestion

Returns

number

---

compareToIgnoreCase()

compareToIgnoreCase(b): number

Defined in: suggestion/Suggestion.ts:72

Parameters

b

Suggestion

Returns

number

---

equals()

equals(o): boolean

Defined in: suggestion/Suggestion.ts:46

Parameters

o

object

Returns

boolean

---

expand()

expand(command, range): Suggestion

Defined in: suggestion/Suggestion.ts:76

Parameters

command

string

range

StringRange

Returns

Suggestion

---

getRange()

getRange(): StringRange

Defined in: suggestion/Suggestion.ts:16

Returns

StringRange

---

getText()

getText(): string

Defined in: suggestion/Suggestion.ts:20

Returns

string

---

getTooltip()

getTooltip(): Message | null

Defined in: suggestion/Suggestion.ts:24

Returns

Message | null

---

toString()

toString(): String

Defined in: suggestion/Suggestion.ts:53

Returns

String