Package io.github.projectunified.unidialog.viaversion.dialog

Class ViaDialogListDialog

java.lang.Object

io.github.projectunified.unidialog.viaversion.dialog.ViaDialog<ViaDialogListDialog>

io.github.projectunified.unidialog.viaversion.dialog.ViaDialogListDialog

All Implemented Interfaces:

Dialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialogListDialog>, DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

public class ViaDialogListDialog
extends ViaDialog<ViaDialogListDialog>
implements DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

A ViaVersion-based implementation of DialogListDialog for building dialog list dialogs.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.projectunified.unidialog.core.dialog.Dialog

Dialog.AfterAction

Field Summary

Fields inherited from interface io.github.projectunified.unidialog.core.dialog.DialogListDialog

DEFAULT_BUTTON_WIDTH, DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
ViaDialogListDialog(String defaultNamespace, Function<String,com.viaversion.viaversion.libs.mcstructs.text.TextComponent> componentDeserializer)	Constructor for ViaDialogListDialog

Method Summary

Modifier and Type	Method	Description
ViaDialogListDialog	buttonWidth(int buttonWidth)	Set the width of the buttons in the dialog
ViaDialogListDialog	columns(int columns)	Set the number of columns in the dialog
ViaDialogListDialog	dialog(DialogOpener dialogOpener)	Add a dialog to the list of dialogs in this dialog
ViaDialogListDialog	dialog(ViaDialog<?> dialog)	Add a dialog to the list of dialogs in this dialog
ViaDialogListDialog	dialog(String namespace, String dialogId)	Add a dialog to the list of dialogs in this dialog
ViaDialogListDialog	exitAction(Consumer<ViaDialogActionBuilder> action)	Set the action to be performed when exiting the dialog
protected void	writeDialogType(com.viaversion.nbt.tag.CompoundTag tag, com.viaversion.viaversion.util.SerializerVersion baseVersion, com.viaversion.viaversion.util.SerializerVersion targetVersion)	Write the type-specific fields of this dialog, including the type key

Methods inherited from class io.github.projectunified.unidialog.viaversion.dialog.ViaDialog

afterAction, body, canCloseWithEscape, deserialize, externalTitle, externalTitle, getActionBuilder, getDialogTag, getDialogTag, input, opener, pause, title, title

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.dialog.Dialog

afterAction, body, body, canCloseWithEscape, externalTitle, input, input, opener, pause, title

Methods inherited from interface io.github.projectunified.unidialog.core.dialog.DialogListDialog

dialog

Constructor Details

ViaDialogListDialog

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

Constructor for ViaDialogListDialog

Parameters:

defaultNamespace - the default namespace for custom actions

componentDeserializer - the function to deserialize components from strings

Method Details

dialog

public ViaDialogListDialog dialog(ViaDialog<?> dialog)

Description copied from interface: DialogListDialog

Add a dialog to the list of dialogs in this dialog

Specified by:

dialog in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

dialog - the dialog to add

Returns:

the dialog itself for method chaining

dialog

public ViaDialogListDialog dialog(String namespace,
 String dialogId)

Description copied from interface: DialogListDialog

Add a dialog to the list of dialogs in this dialog

Specified by:

dialog in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

namespace - the namespace of the dialog

dialogId - the ID of the dialog

Returns:

the dialog itself for method chaining

dialog

public ViaDialogListDialog dialog(DialogOpener dialogOpener)

Description copied from interface: DialogListDialog

Add a dialog to the list of dialogs in this dialog

Specified by:

dialog in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

dialogOpener - the dialog opener that will open the dialog

Returns:

the dialog itself for method chaining

exitAction

public ViaDialogListDialog exitAction(Consumer<ViaDialogActionBuilder> action)

Description copied from interface: DialogListDialog

Set the action to be performed when exiting the dialog

Specified by:

exitAction in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

action - the action to be performed when exiting the dialog

Returns:

the dialog itself for method chaining

columns

public ViaDialogListDialog columns(int columns)

Description copied from interface: DialogListDialog

Set the number of columns in the dialog

Specified by:

columns in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

columns - the number of columns in the dialog

Returns:

the dialog itself for method chaining

buttonWidth

public ViaDialogListDialog buttonWidth(int buttonWidth)

Description copied from interface: DialogListDialog

Set the width of the buttons in the dialog

Specified by:

buttonWidth in interface DialogListDialog<ViaItem,ViaDialogBodyBuilder,ViaDialogInputBuilder,ViaDialog<?>,ViaDialogActionBuilder,ViaDialogListDialog>

Parameters:

buttonWidth - the width of the buttons in the dialog

Returns:

the dialog itself for method chaining

writeDialogType

protected void writeDialogType(com.viaversion.nbt.tag.CompoundTag tag,
 com.viaversion.viaversion.util.SerializerVersion baseVersion,
 com.viaversion.viaversion.util.SerializerVersion targetVersion)

Description copied from class: ViaDialog

Write the type-specific fields of this dialog, including the type key

Specified by:

writeDialogType in class ViaDialog<ViaDialogListDialog>

Parameters:

tag - the tag to write into

baseVersion - the serializer of the server version the dialog is created for

targetVersion - the serializer of the version the dialog is sent to