Package io.github.projectunified.unidialog.viaversion.action

Class ViaDialogActionBuilder

java.lang.Object

io.github.projectunified.unidialog.viaversion.action.ViaDialogActionBuilder

All Implemented Interfaces:

DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

public class ViaDialogActionBuilder
extends Object
implements DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

A ViaVersion-based implementation of DialogActionBuilder for building dialog actions.

Field Summary

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

DEFAULT_WIDTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ViaDialogActionBuilder	copyToClipboard(String value)	Set the action to be a copy-to-clipboard action
ViaDialogActionBuilder	dynamicCustom(String id)	Set the action to be a dynamic custom action
ViaDialogActionBuilder	dynamicCustom(String namespace, String id)	Set the action to be a dynamic custom action with a namespace
ViaDialogActionBuilder	dynamicRunCommand(String template)	Set the action to be a dynamic run command action
com.viaversion.nbt.tag.CompoundTag	getAction(com.viaversion.viaversion.util.SerializerVersion base, com.viaversion.viaversion.util.SerializerVersion target)	Build the button tag for the given target serializer
ViaDialogActionBuilder	label(com.viaversion.viaversion.libs.mcstructs.text.TextComponent label)	Set the label for the action
ViaDialogActionBuilder	label(String label)	Set the label for the dialog action
ViaDialogActionBuilder	openUrl(String url)	Set the action to be an open-URL action
ViaDialogActionBuilder	runCommand(String command)	Set the action to be a run command action
ViaDialogActionBuilder	showDialog(DialogOpener dialogOpener)	Set the action to be a show dialog action
ViaDialogActionBuilder	showDialog(ViaDialog<?> dialog)	Set the action to be a show dialog action
ViaDialogActionBuilder	showDialog(String namespace, String dialogId)	Set the action to be a show dialog action
ViaDialogActionBuilder	suggestCommand(String command)	Set the action to be a suggest command action
ViaDialogActionBuilder	tooltip(@Nullable com.viaversion.viaversion.libs.mcstructs.text.TextComponent tooltip)	Set the tooltip for the action
ViaDialogActionBuilder	tooltip(@Nullable String tooltip)	Set the tooltip for the dialog action
ViaDialogActionBuilder	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

Constructor Details

ViaDialogActionBuilder

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

Constructor for ViaDialogActionBuilder

Parameters:

defaultNamespace - the default namespace for custom actions

componentDeserializer - the function to deserialize components from strings

Method Details

label

public ViaDialogActionBuilder label(com.viaversion.viaversion.libs.mcstructs.text.TextComponent label)

Set the label for the action

Parameters:

label - the label

Returns:

the builder itself for method chaining

label

public ViaDialogActionBuilder label(String label)

Description copied from interface: DialogActionBuilder

Set the label for the dialog action

Specified by:

label in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

label - the label to set

Returns:

the current instance of the builder for method chaining

tooltip

public ViaDialogActionBuilder tooltip(@Nullable
 @Nullable com.viaversion.viaversion.libs.mcstructs.text.TextComponent tooltip)

Set the tooltip for the action

Parameters:

tooltip - the tooltip

Returns:

the builder itself for method chaining

tooltip

public ViaDialogActionBuilder tooltip(@Nullable
 @Nullable String tooltip)

Description copied from interface: DialogActionBuilder

Set the tooltip for the dialog action

Specified by:

tooltip in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

tooltip - the tooltip to set, can be null

Returns:

the current instance of the builder for method chaining

width

public ViaDialogActionBuilder width(int width)

Description copied from interface: DialogActionBuilder

Set the width for the dialog action

Specified by:

width in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

width - the width to set

Returns:

the current instance of the builder for method chaining

copyToClipboard

public ViaDialogActionBuilder copyToClipboard(String value)

Description copied from interface: DialogActionBuilder

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

Specified by:

copyToClipboard in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

value - the value to copy to the clipboard

Returns:

the current instance of the builder for method chaining

dynamicCustom

public ViaDialogActionBuilder dynamicCustom(String id)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic custom action

Specified by:

dynamicCustom in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

id - the identifier for the dynamic custom action

Returns:

the current instance of the builder for method chaining

dynamicCustom

public ViaDialogActionBuilder 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<ViaDialog<?>,ViaDialogActionBuilder>

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 ViaDialogActionBuilder dynamicRunCommand(String template)

Description copied from interface: DialogActionBuilder

Set the action to be a dynamic run command action

Specified by:

dynamicRunCommand in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

template - the command template to run

Returns:

the current instance of the builder for method chaining

openUrl

public ViaDialogActionBuilder openUrl(String url)

Description copied from interface: DialogActionBuilder

Set the action to be an open-URL action

Specified by:

openUrl in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

url - the URL to open

Returns:

the current instance of the builder for method chaining

runCommand

public ViaDialogActionBuilder runCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a run command action

Specified by:

runCommand in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

command - the command to run

Returns:

the current instance of the builder for method chaining

suggestCommand

public ViaDialogActionBuilder suggestCommand(String command)

Description copied from interface: DialogActionBuilder

Set the action to be a suggest command action

Specified by:

suggestCommand in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

command - the command to suggest

Returns:

the current instance of the builder for method chaining

showDialog

public ViaDialogActionBuilder showDialog(ViaDialog<?> dialog)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

dialog - the dialog to show

Returns:

the current instance of the builder for method chaining

showDialog

public ViaDialogActionBuilder 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<ViaDialog<?>,ViaDialogActionBuilder>

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 ViaDialogActionBuilder showDialog(DialogOpener dialogOpener)

Description copied from interface: DialogActionBuilder

Set the action to be a show dialog action

Specified by:

showDialog in interface DialogActionBuilder<ViaDialog<?>,ViaDialogActionBuilder>

Parameters:

dialogOpener - the dialog opener to use for showing the dialog

Returns:

the current instance of the builder for method chaining

getAction

public com.viaversion.nbt.tag.CompoundTag getAction(com.viaversion.viaversion.util.SerializerVersion base,
 com.viaversion.viaversion.util.SerializerVersion target)

Build the button tag for the given target serializer

Parameters:

base - the serializer of the version the components are created for

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

Returns:

the button tag