net.kyori.text.event

Class HoverEvent

java.lang.Object

net.kyori.text.event.HoverEvent

public final class HoverEvent
extends java.lang.Object

A hover event.

A hover event displays a component when hovered over by a mouse on the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoverEvent.Action An enumeration of hover event actions.

Method Summary

Modifier and Type	Method and Description
@NonNull HoverEvent.Action	action() Gets the hover event action.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
static @NonNull HoverEvent	of(@NonNull HoverEvent.Action action, @NonNull Component value) Creates a hover event.
static @NonNull HoverEvent	showEntity(@NonNull Component entity) Creates a hover event that shows an entity on hover.
static @NonNull HoverEvent	showItem(@NonNull Component item) Creates a hover event that shows an item on hover.
static @NonNull HoverEvent	showText(@NonNull Component text) Creates a hover event that shows text on hover.
java.lang.String	toString()
@NonNull Component	value() Gets the hover event value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static @NonNull HoverEvent of(@NonNull HoverEvent.Action action,
                                     @NonNull Component value)

Creates a hover event.

Parameters:

action - the action

value - the value

Returns:

a click event

showText

public static @NonNull HoverEvent showText(@NonNull Component text)

Creates a hover event that shows text on hover.

Parameters:

text - the text to show on hover

Returns:

a hover event

showItem

public static @NonNull HoverEvent showItem(@NonNull Component item)

Creates a hover event that shows an item on hover.

Parameters:

item - the item to show on hover

Returns:

a hover event

showEntity

public static @NonNull HoverEvent showEntity(@NonNull Component entity)

Creates a hover event that shows an entity on hover.

Parameters:

entity - the entity to show on hover

Returns:

a hover event

action

public @NonNull HoverEvent.Action action()

Gets the hover event action.

Returns:

the hover event action

value

public @NonNull Component value()

Gets the hover event value.

Returns:

the hover 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