Package io.papermc.paper.dialog

Interface Dialog

All Superinterfaces:

net.kyori.adventure.dialog.DialogLike, net.kyori.adventure.key.Keyed, Keyed

@NonExtendable
public interface Dialog
extends Keyed, net.kyori.adventure.dialog.DialogLike

Represents a dialog. Can be created during normal server operation via create(Consumer). Can also be created during bootstrap via RegistryEvents.DIALOG.

Field Summary

Fields

Modifier and Type	Field	Description
static final Dialog	CUSTOM_OPTIONS
static final Dialog	QUICK_ACTIONS
static final Dialog	SERVER_LINKS

Method Summary

Modifier and Type	Method	Description
static Dialog	create(Consumer<RegistryBuilderFactory<Dialog,? extends DialogRegistryEntry.Builder>> value)	Creates a new dialog using the provided builder.
NamespacedKey	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.DIALOG.
default net.kyori.adventure.key.Key	key()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.DIALOG.

Field Details

CUSTOM_OPTIONS

static final Dialog CUSTOM_OPTIONS

QUICK_ACTIONS

static final Dialog QUICK_ACTIONS

SERVER_LINKS

static final Dialog SERVER_LINKS

Method Details

create

@Experimental
static Dialog create(Consumer<RegistryBuilderFactory<Dialog,? extends DialogRegistryEntry.Builder>> value)

Creates a new dialog using the provided builder.

Parameters:

value - the builder to use for creating the dialog

Returns:

a new dialog instance

getKey

@Deprecated(since="1.21.8",
            forRemoval=true)
NamespacedKey getKey()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.DIALOG. Dialogs can exist without a key.

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

key

@Deprecated(since="1.21.8",
            forRemoval=true)
default net.kyori.adventure.key.Key key()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.DIALOG. Dialogs can exist without a key.

Description copied from interface: Keyed

Returns the unique identifier for this object.

Specified by:

key in interface net.kyori.adventure.key.Keyed

Specified by:

key in interface Keyed

Returns:

this object's key