Package io.github.projectunified.unidialog.viaversion

Class ViaVersionDialogManager

java.lang.Object

io.github.projectunified.unidialog.viaversion.ViaVersionDialogManager

All Implemented Interfaces:

DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

public class ViaVersionDialogManager
extends Object
implements DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

A ViaVersion-based implementation of DialogManager that manages dialogs for players. It provides dialog creation, custom action registration, and dialog clearing.

Constructor Summary

Constructors

Constructor	Description
ViaVersionDialogManager(String defaultNamespace)	Constructor for ViaVersionDialogManager, using ViaDialogTagBuilder.deserializeLegacy(java.lang.String) as the component deserializer
ViaVersionDialogManager(String defaultNamespace, Function<String,com.viaversion.viaversion.libs.mcstructs.text.TextComponent> componentDeserializer)	Constructor for ViaVersionDialogManager

Method Summary

Modifier and Type	Method	Description
boolean	clearDialog(com.viaversion.viaversion.api.connection.UserConnection connection)	Clear the dialog for a user connection, automatically determining if it is a configuration dialog.
boolean	clearDialog(com.viaversion.viaversion.api.connection.UserConnection connection, boolean configuration)	Clear the dialog for a user connection, optionally specifying if it is a configuration dialog.
boolean	clearDialog(UUID uuid)	Clear the current dialog associated with the given player UUID.
ViaConfirmationDialog	createConfirmationDialog()	Create a confirmation dialog
ViaDialogListDialog	createDialogListDialog()	Create a dialog list dialog
ViaMultiActionDialog	createMultiActionDialog()	Create a multi-action dialog
ViaNoticeDialog	createNoticeDialog()	Create a notice dialog
ViaServerLinksDialog	createServerLinksDialog()	Create a server links dialog
void	register()	Register the dialog manager
void	registerCustomAction(String namespace, String id, Consumer<DialogPayload> action)	Register a custom action with a unique identifier.
void	registerCustomAction(String id, Consumer<DialogPayload> action)	Register a custom action with a unique identifier.
static boolean	supportsDialog(@Nullable com.viaversion.viaversion.api.connection.UserConnection connection)	Check if a user connection supports dialogs
static boolean	supportsDialog(@Nullable UUID uuid)	Check if a player supports dialogs
void	unregister()	Unregister the dialog manager
void	unregisterAllCustomActions()	Unregister all custom actions.
void	unregisterCustomAction(String id)	Unregister a custom action by its unique identifier.
void	unregisterCustomAction(String namespace, String id)	Unregister a custom action by its namespace and unique identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.projectunified.unidialog.core.DialogManager

registerCustomAction, registerCustomAction

Constructor Details

ViaVersionDialogManager

public ViaVersionDialogManager(String defaultNamespace)

Constructor for ViaVersionDialogManager, using ViaDialogTagBuilder.deserializeLegacy(java.lang.String) as the component deserializer

Parameters:

defaultNamespace - the default namespace

ViaVersionDialogManager

public ViaVersionDialogManager(String defaultNamespace,
 Function<String,com.viaversion.viaversion.libs.mcstructs.text.TextComponent> componentDeserializer)

Constructor for ViaVersionDialogManager

Parameters:

defaultNamespace - the default namespace

componentDeserializer - a function to deserialize components from strings

Method Details

supportsDialog

public static boolean supportsDialog(@Nullable
 @Nullable com.viaversion.viaversion.api.connection.UserConnection connection)

Check if a user connection supports dialogs

Parameters:

connection - the user connection, may be null

Returns:

true if the connection supports dialogs

supportsDialog

public static boolean supportsDialog(@Nullable
 @Nullable UUID uuid)

Check if a player supports dialogs

Parameters:

uuid - the player's UUID, may be null

Returns:

true if the player supports dialogs

createConfirmationDialog

public ViaConfirmationDialog createConfirmationDialog()

Description copied from interface: DialogManager

Create a confirmation dialog

Specified by:

createConfirmationDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Returns:

a new instance of ConfirmationDialog

createMultiActionDialog

public ViaMultiActionDialog createMultiActionDialog()

Description copied from interface: DialogManager

Create a multi-action dialog

Specified by:

createMultiActionDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Returns:

a new instance of MultiActionDialog

createServerLinksDialog

public ViaServerLinksDialog createServerLinksDialog()

Description copied from interface: DialogManager

Create a server links dialog

Specified by:

createServerLinksDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Returns:

a new instance of ServerLinksDialog

createNoticeDialog

public ViaNoticeDialog createNoticeDialog()

Description copied from interface: DialogManager

Create a notice dialog

Specified by:

createNoticeDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Returns:

a new instance of NoticeDialog

createDialogListDialog

public ViaDialogListDialog createDialogListDialog()

Description copied from interface: DialogManager

Create a dialog list dialog

Specified by:

createDialogListDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Returns:

a new instance of DialogListDialog

register

public void register()

Description copied from interface: DialogManager

Register the dialog manager

Specified by:

register in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

unregister

public void unregister()

Description copied from interface: DialogManager

Unregister the dialog manager

Specified by:

unregister in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

registerCustomAction

public void registerCustomAction(String id,
 Consumer<DialogPayload> action)

Description copied from interface: DialogManager

Register a custom action with a unique identifier.

Specified by:

registerCustomAction in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

id - the unique identifier for the custom action

action - the action to be executed, taking a payload

registerCustomAction

public void registerCustomAction(String namespace,
 String id,
 Consumer<DialogPayload> action)

Description copied from interface: DialogManager

Register a custom action with a unique identifier.

Specified by:

registerCustomAction in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

namespace - the namespace for the custom action

id - the unique identifier for the custom action

action - the action to be executed, taking a payload

unregisterCustomAction

public void unregisterCustomAction(String id)

Description copied from interface: DialogManager

Unregister a custom action by its unique identifier.

Specified by:

unregisterCustomAction in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

id - the unique identifier of the custom action to be unregistered

unregisterCustomAction

public void unregisterCustomAction(String namespace,
 String id)

Description copied from interface: DialogManager

Unregister a custom action by its namespace and unique identifier.

Specified by:

unregisterCustomAction in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

namespace - the namespace of the custom action

id - the unique identifier of the custom action to be unregistered

unregisterAllCustomActions

public void unregisterAllCustomActions()

Description copied from interface: DialogManager

Unregister all custom actions.

Specified by:

unregisterAllCustomActions in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

clearDialog

public boolean clearDialog(com.viaversion.viaversion.api.connection.UserConnection connection,
 boolean configuration)

Clear the dialog for a user connection, optionally specifying if it is a configuration dialog.

Parameters:

connection - the user connection to clear the dialog for

configuration - if true, clears as a configuration dialog; if false, clears as a play dialog

Returns:

true if the clear packet was sent, false otherwise

clearDialog

public boolean clearDialog(com.viaversion.viaversion.api.connection.UserConnection connection)

Clear the dialog for a user connection, automatically determining if it is a configuration dialog.

Parameters:

connection - the user connection to clear the dialog for

Returns:

true if the clear packet was sent, false otherwise

clearDialog

public boolean clearDialog(UUID uuid)

Description copied from interface: DialogManager

Clear the current dialog associated with the given player UUID.

Specified by:

clearDialog in interface DialogManager<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

uuid - the unique identifier of the player whose dialog should be cleared

Returns:

true if the dialog was successfully cleared, false otherwise