Package io.github.projectunified.unidialog.spigot

Class SpigotDialogManager

java.lang.Object

io.github.projectunified.unidialog.spigot.SpigotDialogManager

All Implemented Interfaces:

DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>, org.bukkit.event.Listener

public class SpigotDialogManager
extends Object
implements DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>, org.bukkit.event.Listener

Constructor Summary

Constructors

Constructor	Description
SpigotDialogManager(org.bukkit.plugin.Plugin plugin)
SpigotDialogManager(org.bukkit.plugin.Plugin plugin, String defaultNamespace)

Method Summary

Modifier and Type	Method	Description
boolean	clearDialog(UUID uuid)	Clear the current dialog associated with the given player UUID.
BungeeConfirmationDialog<SpigotDialogOpener>	createConfirmationDialog()	Create a confirmation dialog
BungeeDialogListDialog<SpigotDialogOpener>	createDialogListDialog()	Create a dialog list dialog
BungeeMultiActionDialog<SpigotDialogOpener>	createMultiActionDialog()	Create a multi-action dialog
BungeeNoticeDialog<SpigotDialogOpener>	createNoticeDialog()	Create a notice dialog
BungeeServerLinksDialog<SpigotDialogOpener>	createServerLinksDialog()	Create a server links dialog
void	onCustomClick(org.bukkit.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

SpigotDialogManager

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

SpigotDialogManager

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

Method Details

createConfirmationDialog

public BungeeConfirmationDialog<SpigotDialogOpener> createConfirmationDialog()

Description copied from interface: DialogManager

Create a confirmation dialog

Specified by:

createConfirmationDialog in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Returns:

a new instance of ConfirmationDialog

createMultiActionDialog

public BungeeMultiActionDialog<SpigotDialogOpener> createMultiActionDialog()

Description copied from interface: DialogManager

Create a multi-action dialog

Specified by:

createMultiActionDialog in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Returns:

a new instance of MultiActionDialog

createServerLinksDialog

public BungeeServerLinksDialog<SpigotDialogOpener> createServerLinksDialog()

Description copied from interface: DialogManager

Create a server links dialog

Specified by:

createServerLinksDialog in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Returns:

a new instance of ServerLinksDialog

createNoticeDialog

public BungeeNoticeDialog<SpigotDialogOpener> createNoticeDialog()

Description copied from interface: DialogManager

Create a notice dialog

Specified by:

createNoticeDialog in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Returns:

a new instance of NoticeDialog

createDialogListDialog

public BungeeDialogListDialog<SpigotDialogOpener> createDialogListDialog()

Description copied from interface: DialogManager

Create a dialog list dialog

Specified by:

createDialogListDialog in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

unregister

public void unregister()

Description copied from interface: DialogManager

Unregister the dialog manager

Specified by:

unregister in interface DialogManager<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

onCustomClick

public void onCustomClick(org.bukkit.event.player.PlayerCustomClickEvent event)

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Parameters:

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

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<Object,BungeeDialogBodyBuilder,BungeeDialogInputBuilder,BungeeDialog<?,?>,BungeeDialogActionBuilder>

Parameters:

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

Returns:

true if the dialog was successfully cleared, false otherwise