Class MultiButtonDialogue<T, Callback>

Class used to build multi button script dialogues.

Use multiButtonScriptDialogue to initialize one.

See

multiButtonScriptDialogue

Type Parameters

T extends string
Callback = undefined

Hierarchy (View Summary)

ScriptDialogue<ButtonDialogueResponse<T, Callback>>
- MultiButtonDialogue

Index

Methods

addButton addButtons addDivider addElements addHeader addLabel open setBody

Methods

addButton

addButton<NAME extends string, ButtonCallback = undefined>(
    name: NAME,
    text: ScriptDialogueString,
    iconPath?: string,
    callback?: (selected: string) => Promise<ButtonCallback>,
): MultiButtonDialogue<NonNullable<T | NAME>, Callback | ButtonCallback>
Adds a button to the multi button script dialogue.
Type Parameters
- NAME extends string
- ButtonCallback = undefined
Parameters
- name: NAME
  name of the button
- text: ScriptDialogueString
  content of the button
- OptionaliconPath: string
  path to an icon to show in the button
- Optionalcallback: (selected: string) => Promise<ButtonCallback>
Returns MultiButtonDialogue<NonNullable<T | NAME>, Callback | ButtonCallback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:123

addButtons

addButtons<NAMES extends string, ButtonCallback = undefined>(
buttons: MultiButton<NAMES, ButtonCallback>[],
): MultiButtonDialogue<NonNullable<T | NAMES>, Callback | ButtonCallback>
Adds multiple buttons to the multi button script dialogue.
Type Parameters
- NAMES extends string
- ButtonCallback = undefined
Parameters
- buttons: MultiButton<NAMES, ButtonCallback>[]
  array of buttons
Returns MultiButtonDialogue<NonNullable<T | NAMES>, Callback | ButtonCallback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:144

addDivider

addDivider(): MultiButtonDialogue<T, Callback>
Returns MultiButtonDialogue<T, Callback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:88

addElements

addElements<NAMES extends string, ButtonCallback = undefined>(
elements: (UIElement | MultiButton<NAMES, ButtonCallback>)[],
): MultiButtonDialogue<NonNullable<T | NAMES>, Callback | ButtonCallback>
Adds multiple buttons and ui elements to the multi button script dialogue.
Type Parameters
- NAMES extends string
- ButtonCallback = undefined
Parameters
- elements: (UIElement | MultiButton<NAMES, ButtonCallback>)[]
Returns MultiButtonDialogue<NonNullable<T | NAMES>, Callback | ButtonCallback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:157

addHeader

addHeader(text: ScriptDialogueString): MultiButtonDialogue<T, Callback>
Parameters
- text: ScriptDialogueString
Returns MultiButtonDialogue<T, Callback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:97

addLabel

addLabel(text: ScriptDialogueString): MultiButtonDialogue<T, Callback>
Parameters
- text: ScriptDialogueString
Returns MultiButtonDialogue<T, Callback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:107

open

open(
    options: ShowDialogueOptions,
): Promise<
    | DialogueCanceledResponse
    | DialogueRejectedResponse
    | ButtonDialogueResponse<T, Callback>,
>
Opens the script dialogue. It requires the player as one of the options.

You can configure displaying features by setting the optional values in the options
Parameters
- options: ShowDialogueOptions
  used to configure what and how to display the script dialogue.
Returns Promise<
    | DialogueCanceledResponse
    | DialogueRejectedResponse
    | ButtonDialogueResponse<T, Callback>,
>
See
ShowDialogueOptions
Inherited from ScriptDialogue.open
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/ScriptDialogue.ts:99

setBody

setBody(body: ScriptDialogueString): MultiButtonDialogue<T, Callback>
Sets the content body of the multi button dialogue
Parameters
- body: ScriptDialogueString
Returns MultiButtonDialogue<T, Callback>
- Defined in scripts/script_dialogue/MinecraftScriptDialogue/MultiButtonScriptDialogue.ts:84