Package io.github.projectunified.unidialog.paper.action

Class PaperDialogActionBuilder

java.lang.Object

io.github.projectunified.unidialog.paper.action.PaperDialogActionBuilder

All Implemented Interfaces:

AdventureDialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>, AdventureSupport, DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

public class PaperDialogActionBuilder
extends Object
implements AdventureDialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Field Summary

Fields inherited from interface io.github.projectunified.unidialog.core.action.DialogActionBuilder

DEFAULT_WIDTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PaperDialogActionBuilder	copyToClipboard(String value)	Set the action to be a copy-to-clipboard action
PaperDialogActionBuilder	dynamicCustom(String id)	Set the action to be a dynamic custom action
PaperDialogActionBuilder	dynamicCustom(String namespace, String id)	Set the action to be a dynamic custom action with a namespace
PaperDialogActionBuilder	dynamicRunCommand(String template)	Set the action to be a dynamic run command action
io.papermc.paper.registry.data.dialog.ActionButton	getAction()
Function<String,net.kyori.adventure.text.Component>	getComponentDeserializer()	Get the deserializer function that converts a string to a Component
PaperDialogActionBuilder	label(net.kyori.adventure.text.Component label)	Set the label for the dialog action
PaperDialogActionBuilder	openUrl(String url)	Set the action to be an open-URL action
PaperDialogActionBuilder	runCommand(String command)	Set the action to be a run command action
PaperDialogActionBuilder	showDialog(DialogOpener dialogOpener)	Set the action to be a show dialog action
PaperDialogActionBuilder	showDialog(PaperDialog<?> dialog)	Set the action to be a show dialog action
PaperDialogActionBuilder	showDialog(String namespace, String dialogId)	Set the action to be a show dialog action
PaperDialogActionBuilder	suggestCommand(String command)	Set the action to be a suggest command action
PaperDialogActionBuilder	tooltip(@Nullable net.kyori.adventure.text.Component tooltip)	Set the tooltip for the dialog action
PaperDialogActionBuilder	width(int width)	Set the width for the dialog action

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.adventure.action.AdventureDialogActionBuilder

label, tooltip

Methods inherited from interface io.github.projectunified.unidialog.adventure.support.AdventureSupport

deserialize

Constructor Details

PaperDialogActionBuilder

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

Method Details

label

public PaperDialogActionBuilder label(net.kyori.adventure.text.Component label)

Description copied from interface: AdventureDialogActionBuilder

Set the label for the dialog action

Specified by:

label in interface AdventureDialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

label - the label to set

Returns:

the current instance of the builder for method chaining

tooltip

public PaperDialogActionBuilder tooltip(@Nullable
 @Nullable net.kyori.adventure.text.Component tooltip)

Description copied from interface: AdventureDialogActionBuilder

Set the tooltip for the dialog action

Specified by:

tooltip in interface AdventureDialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

tooltip - the tooltip to set, can be null

Returns:

the current instance of the builder for method chaining

getComponentDeserializer

public Function<String,net.kyori.adventure.text.Component> getComponentDeserializer()

Description copied from interface: AdventureSupport

Get the deserializer function that converts a string to a Component

Specified by:

getComponentDeserializer in interface AdventureSupport

Returns:

the function that deserializes a string into a Component

width

public PaperDialogActionBuilder width(int width)

Description copied from interface: DialogActionBuilder

Set the width for the dialog action

Specified by:

width in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

width - the width to set

Returns:

the current instance of the builder for method chaining

copyToClipboard

public PaperDialogActionBuilder copyToClipboard(String value)

Description copied from interface: DialogActionBuilder

Set the action to be a copy-to-clipboard action

Specified by:

copyToClipboard in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

value - the value to copy to the clipboard

Returns:

the current instance of the builder for method chaining

dynamicCustom

public PaperDialogActionBuilder dynamicCustom(String id)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic custom action

Specified by:

dynamicCustom in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

id - the identifier for the dynamic custom action

Returns:

the current instance of the builder for method chaining

dynamicCustom

public PaperDialogActionBuilder dynamicCustom(String namespace,
 String id)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic custom action with a namespace

Specified by:

dynamicCustom in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

namespace - the namespace for the dynamic custom action

id - the identifier for the dynamic custom action

Returns:

the current instance of the builder for method chaining

dynamicRunCommand

public PaperDialogActionBuilder dynamicRunCommand(String template)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic run command action

Specified by:

dynamicRunCommand in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

template - the command template to run

Returns:

the current instance of the builder for method chaining

openUrl

public PaperDialogActionBuilder openUrl(String url)

Description copied from interface: DialogActionBuilder

Set the action to be an open-URL action

Specified by:

openUrl in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

url - the URL to open

Returns:

the current instance of the builder for method chaining

runCommand

public PaperDialogActionBuilder runCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a run command action

Specified by:

runCommand in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

command - the command to run

Returns:

the current instance of the builder for method chaining

suggestCommand

public PaperDialogActionBuilder suggestCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a suggest command action

Specified by:

suggestCommand in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

command - the command to suggest

Returns:

the current instance of the builder for method chaining

showDialog

public PaperDialogActionBuilder showDialog(PaperDialog<?> dialog)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

dialog - the dialog to show

Returns:

the current instance of the builder for method chaining

showDialog

public PaperDialogActionBuilder showDialog(String namespace,
 String dialogId)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

namespace - the namespace of the dialog

dialogId - the identifier of the dialog to show

Returns:

the current instance of the builder for method chaining

showDialog

public PaperDialogActionBuilder showDialog(DialogOpener dialogOpener)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<PaperDialog<?>,PaperDialogActionBuilder>

Parameters:

dialogOpener - the dialog opener to use for showing the dialog

Returns:

the current instance of the builder for method chaining

getAction

public io.papermc.paper.registry.data.dialog.ActionButton getAction()