Package io.github.projectunified.unidialog.packetevents

Class PocketEventsDialogManager

java.lang.Object

io.github.projectunified.unidialog.packetevents.PocketEventsDialogManager

All Implemented Interfaces:

DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

public abstract class PocketEventsDialogManager
extends Object
implements DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Constructor Summary

Constructors

Constructor	Description
PocketEventsDialogManager(String defaultNamespace)	Constructor for PocketEventsDialogManagee.
PocketEventsDialogManager(String defaultNamespace, Function<String,net.kyori.adventure.text.Component> componentDeserializer)	Constructor for PocketEventsDialogManager

Method Summary

Modifier and Type	Method	Description
void	clearDialog(com.github.retrooper.packetevents.protocol.player.User user)	Clear the dialog for a user, automatically determining if it is a configuration dialog based on the user's connection state.
void	clearDialog(com.github.retrooper.packetevents.protocol.player.User user, boolean configuration)	Clear the dialog for a user, optionally specifying if it is a configuration dialog.
boolean	clearDialog(UUID uuid)	Clear the current dialog associated with the given player UUID.
PEConfirmationDialog	createConfirmationDialog()	Create a confirmation dialog
PEDialogListDialog	createDialogListDialog()	Create a dialog list dialog
PEMultiActionDialog	createMultiActionDialog()	Create a multi-action dialog
PENoticeDialog	createNoticeDialog()	Create a notice dialog
PEServerLinksDialog	createServerLinksDialog()	Create a server links dialog
protected abstract @Nullable Object	getPlayer(UUID uuid)	Get the player object for a given UUID
protected abstract UUID	getPlayerId(Object player)	Get the UUID of a player object
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

PocketEventsDialogManager

public PocketEventsDialogManager(String defaultNamespace,
 Function<String,net.kyori.adventure.text.Component> componentDeserializer)

Constructor for PocketEventsDialogManager

Parameters:

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

componentDeserializer - a function to deserialize components from strings

PocketEventsDialogManager

public PocketEventsDialogManager(String defaultNamespace)

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

Parameters:

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

Method Details

getPlayer

@Nullable
protected abstract @Nullable Object getPlayer(UUID uuid)

Get the player object for a given UUID

Parameters:

uuid - the UUID of the player

Returns:

the player object, or null if not found

getPlayerId

protected abstract UUID getPlayerId(Object player)

Get the UUID of a player object

Parameters:

player - the player object

Returns:

the UUID of the player

createConfirmationDialog

public PEConfirmationDialog createConfirmationDialog()

Description copied from interface: DialogManager

Create a confirmation dialog

Specified by:

createConfirmationDialog in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Returns:

a new instance of ConfirmationDialog

createMultiActionDialog

public PEMultiActionDialog createMultiActionDialog()

Description copied from interface: DialogManager

Create a multi-action dialog

Specified by:

createMultiActionDialog in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Returns:

a new instance of MultiActionDialog

createServerLinksDialog

public PEServerLinksDialog createServerLinksDialog()

Description copied from interface: DialogManager

Create a server links dialog

Specified by:

createServerLinksDialog in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Returns:

a new instance of ServerLinksDialog

createNoticeDialog

public PENoticeDialog createNoticeDialog()

Description copied from interface: DialogManager

Create a notice dialog

Specified by:

createNoticeDialog in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Returns:

a new instance of NoticeDialog

createDialogListDialog

public PEDialogListDialog createDialogListDialog()

Description copied from interface: DialogManager

Create a dialog list dialog

Specified by:

createDialogListDialog in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

unregister

public void unregister()

Description copied from interface: DialogManager

Unregister the dialog manager

Specified by:

unregister in interface DialogManager<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

clearDialog

public void clearDialog(com.github.retrooper.packetevents.protocol.player.User user,
 boolean configuration)

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

Parameters:

user - the user to clear the dialog for

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

clearDialog

public void clearDialog(com.github.retrooper.packetevents.protocol.player.User user)

Clear the dialog for a user, automatically determining if it is a configuration dialog based on the user's connection state.

Parameters:

user - the user to clear the dialog for

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<com.github.retrooper.packetevents.protocol.item.ItemStack,PEDialogBodyBuilder,PEDialogInputBuilder,PEDialog<?>,PEDialogActionBuilder>

Parameters:

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

Returns:

true if the dialog was successfully cleared, false otherwise