Package io.github.projectunified.unidialog.paper

Class PaperDialogManager

java.lang.Object

io.github.projectunified.unidialog.paper.PaperDialogManager

All Implemented Interfaces:

DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>, org.bukkit.event.Listener

public class PaperDialogManager
extends Object
implements DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>, org.bukkit.event.Listener

Constructor Summary

Constructors

Constructor	Description
PaperDialogManager(org.bukkit.plugin.Plugin plugin)	Constructor for PaperDialogManager that uses the plugin's name as the default namespace.
PaperDialogManager(org.bukkit.plugin.Plugin plugin, String defaultNamespace)	Constructor for PaperDialogManager.
PaperDialogManager(org.bukkit.plugin.Plugin plugin, String defaultNamespace, Function<String,net.kyori.adventure.text.Component> componentDeserializer)	Constructor for PaperDialogManager
PaperDialogManager(org.bukkit.plugin.Plugin plugin, Function<String,net.kyori.adventure.text.Component> componentDeserializer)	Constructor for PaperDialogManager that uses the plugin's name as the default namespace.

Method Summary

Modifier and Type	Method	Description
boolean	clearDialog(UUID uuid)	Clear the current dialog associated with the given player UUID.
PaperConfirmationDialog	createConfirmationDialog()	Create a confirmation dialog
PaperDialogListDialog	createDialogListDialog()	Create a dialog list dialog
PaperMultiActionDialog	createMultiActionDialog()	Create a multi-action dialog
PaperNoticeDialog	createNoticeDialog()	Create a notice dialog
PaperServerLinksDialog	createServerLinksDialog()	Create a server links dialog
void	onCustomClick(io.papermc.paper.event.player.PlayerCustomClickEvent event)
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.
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

PaperDialogManager

public PaperDialogManager(org.bukkit.plugin.Plugin plugin,
 String defaultNamespace,
 Function<String,net.kyori.adventure.text.Component> componentDeserializer)

Constructor for PaperDialogManager

Parameters:

plugin - the plugin instance

defaultNamespace - the default namespace, used by DialogManager.registerCustomAction(String, BiConsumer) and DialogActionBuilder.dynamicCustom(String)

componentDeserializer - a function to deserialize components from strings

PaperDialogManager

public PaperDialogManager(org.bukkit.plugin.Plugin plugin,
 String defaultNamespace)

Constructor for PaperDialogManager. Uses LegacyComponentSerializer.legacySection() to deserialize components.

Parameters:

plugin - the plugin instance

defaultNamespace - the default namespace, used by DialogManager.registerCustomAction(String, BiConsumer) and DialogActionBuilder.dynamicCustom(String)

PaperDialogManager

public PaperDialogManager(org.bukkit.plugin.Plugin plugin,
 Function<String,net.kyori.adventure.text.Component> componentDeserializer)

Constructor for PaperDialogManager that uses the plugin's name as the default namespace.

Parameters:

plugin - the plugin instance

componentDeserializer - a function to deserialize components from strings

PaperDialogManager

public PaperDialogManager(org.bukkit.plugin.Plugin plugin)

Constructor for PaperDialogManager that uses the plugin's name as the default namespace. Uses LegacyComponentSerializer.legacySection() to deserialize components.

Parameters:

plugin - the plugin instance

Method Details

createConfirmationDialog

public PaperConfirmationDialog createConfirmationDialog()

Description copied from interface: DialogManager

Create a confirmation dialog

Specified by:

createConfirmationDialog in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Returns:

a new instance of ConfirmationDialog

createMultiActionDialog

public PaperMultiActionDialog createMultiActionDialog()

Description copied from interface: DialogManager

Create a multi-action dialog

Specified by:

createMultiActionDialog in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Returns:

a new instance of MultiActionDialog

createServerLinksDialog

public PaperServerLinksDialog createServerLinksDialog()

Description copied from interface: DialogManager

Create a server links dialog

Specified by:

createServerLinksDialog in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Returns:

a new instance of ServerLinksDialog

createNoticeDialog

public PaperNoticeDialog createNoticeDialog()

Description copied from interface: DialogManager

Create a notice dialog

Specified by:

createNoticeDialog in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Returns:

a new instance of NoticeDialog

createDialogListDialog

public PaperDialogListDialog createDialogListDialog()

Description copied from interface: DialogManager

Create a dialog list dialog

Specified by:

createDialogListDialog in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

unregister

public void unregister()

Description copied from interface: DialogManager

Unregister the dialog manager

Specified by:

unregister in interface DialogManager<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

onCustomClick

public void onCustomClick(io.papermc.paper.event.player.PlayerCustomClickEvent event)

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

id - the unique identifier for the custom action

action - the action to be executed, taking a payload

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<org.bukkit.inventory.ItemStack,PaperDialogBodyBuilder,PaperDialogInputBuilder,PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

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

Returns:

true if the dialog was successfully cleared, false otherwise