Class ClickEvent.Action<T extends ClickEvent.Payload>

java.lang.Object

net.kyori.adventure.text.event.ClickEvent.Action<T>

Type Parameters:

T - the payload type

Direct Known Subclasses:

ClickEvent.Action.ChangePage, ClickEvent.Action.Custom, ClickEvent.Action.ShowDialog, ClickEvent.Action.TextCarrier

Enclosing class:

ClickEvent<T extends ClickEvent.Payload>

public abstract static sealed class ClickEvent.Action<T extends ClickEvent.Payload>
extends Object
permits ClickEvent.Action.ChangePage, ClickEvent.Action.Custom, ClickEvent.Action.ShowDialog, ClickEvent.Action.TextCarrier

An enumeration of click event actions.

Note: although this interface is sealed, new implementations may be added at any time as and when needed.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClickEvent.Action.ChangePage	Changes the page of a book.
static final class	ClickEvent.Action.CopyToClipboard	Copies text to the clipboard.
static final class	ClickEvent.Action.Custom	Sends a custom event to the server.
static final class	ClickEvent.Action.OpenFile	Opens a file when clicked.
static final class	ClickEvent.Action.OpenUrl	Opens a url when clicked.
static final class	ClickEvent.Action.RunCommand	Runs a command when clicked.
static final class	ClickEvent.Action.ShowDialog	Shows a dialog.
static final class	ClickEvent.Action.SuggestCommand	Suggests a command.
static class	ClickEvent.Action.TextCarrier	An action with a text payload.

Field Summary

Fields

Modifier and Type	Field	Description
static final ClickEvent.Action.ChangePage	CHANGE_PAGE	Changes the page of a book.
static final ClickEvent.Action.CopyToClipboard	COPY_TO_CLIPBOARD	Copies text to the clipboard.
static final ClickEvent.Action.Custom	CUSTOM	Sends a custom event to the server.
static final Index<String, ClickEvent.Action<?>>	NAMES	The name map.
static final ClickEvent.Action.OpenFile	OPEN_FILE	Opens a file when clicked.
static final ClickEvent.Action.OpenUrl	OPEN_URL	Opens a url when clicked.
static final ClickEvent.Action.RunCommand	RUN_COMMAND	Runs a command when clicked.
static final ClickEvent.Action.ShowDialog	SHOW_DIALOG	Shows a dialog.
static final ClickEvent.Action.SuggestCommand	SUGGEST_COMMAND	Suggests a command into the chat box.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
boolean	isValid(T payload)	Returns if the provided payload is valid for this action.
String	name()	Returns the name of this action.
boolean	readable()	Tests if this action is readable.
boolean	supports(ClickEvent.Payload payload)	Returns if this action supports the provided payload type.
String	toString()
void	validate(T payload)	Validates the provided payload, throwing an exception if the payload is not valid for this action.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OPEN_URL

public static final ClickEvent.Action.OpenUrl OPEN_URL

Opens a url when clicked.

Since:

4.0.0

OPEN_FILE

public static final ClickEvent.Action.OpenFile OPEN_FILE

Opens a file when clicked.

This action is not readable, and may only be used locally on the client.

Since:

4.0.0

RUN_COMMAND

public static final ClickEvent.Action.RunCommand RUN_COMMAND

Runs a command when clicked.

Since:

4.0.0

SUGGEST_COMMAND

public static final ClickEvent.Action.SuggestCommand SUGGEST_COMMAND

Suggests a command into the chat box.

Since:

4.0.0

CHANGE_PAGE

public static final ClickEvent.Action.ChangePage CHANGE_PAGE

Changes the page of a book.

Since:

4.0.0

COPY_TO_CLIPBOARD

public static final ClickEvent.Action.CopyToClipboard COPY_TO_CLIPBOARD

Copies text to the clipboard.

Since:

4.0.0

Since Minecraft:

1.15

SHOW_DIALOG

public static final ClickEvent.Action.ShowDialog SHOW_DIALOG

Shows a dialog.

This action is not readable at this time until Adventure has a full Dialog API.

Since:

4.22.0

Since Minecraft:

1.21.6

CUSTOM

public static final ClickEvent.Action.Custom CUSTOM

Sends a custom event to the server.

Since:

4.22.0

Since Minecraft:

1.21.6

NAMES

public static final Index<String, ClickEvent.Action<?>> NAMES

The name map.

Since:

4.0.0

Method Details

readable

public boolean readable()

Tests if this action is readable.

Returns:

true if this action is readable, false if this action is not readable

Since:

4.0.0

supports

public boolean supports(ClickEvent.Payload payload)

Returns if this action supports the provided payload type.

Note: This method only checks if the type of the payload is supported, to check if the payload is compatible with this action, see isValid(Payload).

Parameters:

payload - the payload

Returns:

true if this action supports the payload type

Since:

4.22.0

isValid

public boolean isValid(T payload)

Returns if the provided payload is valid for this action.

Parameters:

payload - the payload

Returns:

true if the payload is valid for this action, false otherwise

Since:

5.1.0

validate

public void validate(T payload)
              throws IllegalArgumentException

Validates the provided payload, throwing an exception if the payload is not valid for this action.

Parameters:

payload - the payload

Throws:

IllegalArgumentException - if the payload is not valid for this action

Since:

5.1.0

name

public String name()

Returns the name of this action.

Returns:

the name of the action

Since:

4.0.0

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object