Package net.minestom.server.dialog

Interface Dialog

All Superinterfaces:

DialogLike, Holder<Dialog>, Holder.Direct<Dialog>

All Known Implementing Classes:

Dialog.Confirmation, Dialog.DialogList, Dialog.MultiAction, Dialog.Notice, Dialog.ServerLinks

public sealed interface Dialog
extends Holder.Direct<Dialog>, DialogLike
permits Dialog.Notice, Dialog.ServerLinks, Dialog.DialogList, Dialog.MultiAction, Dialog.Confirmation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	Dialog.Confirmation
static final record	Dialog.DialogList
static final record	Dialog.MultiAction
static final record	Dialog.Notice
static final record	Dialog.ServerLinks

Nested classes/interfaces inherited from interface net.minestom.server.registry.Holder

Holder.Direct<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull Codec<Holder<Dialog>>	CODEC
static final NetworkBuffer.Type<Holder<Dialog>>	NETWORK_TYPE
static final @NotNull Registry<StructCodec<? extends Dialog>>	REGISTRY
static final @NotNull Codec<Dialog>	REGISTRY_CODEC
static final NetworkBuffer.Type<Dialog>	REGISTRY_NETWORK_TYPE

Method Summary

Modifier and Type	Method	Description
@NotNull StructCodec<? extends Dialog>	codec()
static @NotNull DynamicRegistry<Dialog>	createDefaultRegistry(@NotNull Registries registries)	Creates a new registry for dialogs, loading the vanilla dialogs.
static @NotNull DialogLike	forKey(@NotNull RegistryKey<Dialog> key)	Creates a new adventure DialogLike for the dialog at the given key.
@NotNull DialogMetadata	metadata()
static @NotNull Holder<Dialog>	unwrap(@NotNull DialogLike dialog)
static @NotNull DialogLike	wrap(@NotNull Holder<Dialog> dialog)

Methods inherited from interface net.minestom.server.registry.Holder

asKey, asValue, isDirect, resolve, unwrap

Field Details

REGISTRY

@NotNull
static final @NotNull Registry<StructCodec<? extends Dialog>> REGISTRY

REGISTRY_CODEC

@NotNull
static final @NotNull Codec<Dialog> REGISTRY_CODEC

REGISTRY_NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<Dialog> REGISTRY_NETWORK_TYPE

NETWORK_TYPE

@NotNull
static final NetworkBuffer.Type<Holder<Dialog>> NETWORK_TYPE

CODEC

@NotNull
static final @NotNull Codec<Holder<Dialog>> CODEC

Method Details

forKey

@NotNull
static @NotNull DialogLike forKey(@NotNull
 @NotNull RegistryKey<Dialog> key)

Creates a new adventure DialogLike for the dialog at the given key.

Useful for sending a dialog which has been pre-sent to the client in the Dialog registry.

Parameters:

key - the key of the dialog (must be registered)

Returns:

a new DialogLike for the dialog at the given key

wrap

@Internal
@NotNull
static @NotNull DialogLike wrap(@NotNull
 @NotNull Holder<Dialog> dialog)

unwrap

@Internal
@NotNull
static @NotNull Holder<Dialog> unwrap(@NotNull
 @NotNull DialogLike dialog)

createDefaultRegistry

@Internal
@NotNull
static @NotNull DynamicRegistry<Dialog> createDefaultRegistry(@NotNull
 @NotNull Registries registries)

Creates a new registry for dialogs, loading the vanilla dialogs.

See Also:

• to get an existing instance of the registry

metadata

@NotNull
@NotNull DialogMetadata metadata()

codec

@NotNull
@NotNull StructCodec<? extends Dialog> codec()