net.kyori.text.event

Class ClickEvent

java.lang.Object

net.kyori.text.event.ClickEvent

public final class ClickEvent
extends java.lang.Object

A click event.

A click event processes an ClickEvent.Action when clicked on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClickEvent.Action An enumeration of click event actions.

Method Summary

Modifier and Type	Method and Description
@NonNull ClickEvent.Action	action() Gets the click event action.
static @NonNull ClickEvent	changePage(int page) Creates a click event that changes to a page.
static @NonNull ClickEvent	changePage(@NonNull java.lang.String page) Creates a click event that changes to a page.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
static @NonNull ClickEvent	of(@NonNull ClickEvent.Action action, @NonNull java.lang.String value) Creates a click event.
static @NonNull ClickEvent	openFile(@NonNull java.lang.String file) Creates a click event that opens a file.
static @NonNull ClickEvent	openUrl(@NonNull java.lang.String url) Creates a click event that opens a url.
static @NonNull ClickEvent	runCommand(@NonNull java.lang.String command) Creates a click event that runs a command.
static @NonNull ClickEvent	suggestCommand(@NonNull java.lang.String command) Creates a click event that suggests a command.
java.lang.String	toString()
@NonNull java.lang.String	value() Gets the click event value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static @NonNull ClickEvent of(@NonNull ClickEvent.Action action,
                                     @NonNull java.lang.String value)

Creates a click event.

Parameters:

action - the action

value - the value

Returns:

a click event

openUrl

public static @NonNull ClickEvent openUrl(@NonNull java.lang.String url)

Creates a click event that opens a url.

Parameters:

url - the url to open

Returns:

a click event

openFile

public static @NonNull ClickEvent openFile(@NonNull java.lang.String file)

Creates a click event that opens a file.

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

Parameters:

file - the file to open

Returns:

a click event

runCommand

public static @NonNull ClickEvent runCommand(@NonNull java.lang.String command)

Creates a click event that runs a command.

Parameters:

command - the command to run

Returns:

a click event

suggestCommand

public static @NonNull ClickEvent suggestCommand(@NonNull java.lang.String command)

Creates a click event that suggests a command.

Parameters:

command - the command to suggest

Returns:

a click event

changePage

public static @NonNull ClickEvent changePage(@NonNull java.lang.String page)

Creates a click event that changes to a page.

Parameters:

page - the page to change to

Returns:

a click event

changePage

public static @NonNull ClickEvent changePage(int page)

Creates a click event that changes to a page.

Parameters:

page - the page to change to

Returns:

a click event

action

public @NonNull ClickEvent.Action action()

Gets the click event action.

Returns:

the click event action

value

public @NonNull java.lang.String value()

Gets the click event value.

Returns:

the click event value

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object