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.

Constructor Summary

Constructors

Constructor and Description
HoverEvent(@NonNull HoverEvent.Action action, @NonNull Component value)

Method Summary

Modifier and Type	Method and Description
@NonNull HoverEvent.Action	action() Gets the hover event action.
@NonNull HoverEvent	copy() Creates a copy of this hover event.
boolean	equals(java.lang.Object other)
int	hashCode()
@NonNull 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

Constructor Detail

HoverEvent

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

Method Detail

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

copy

public @NonNull HoverEvent copy()

Creates a copy of this hover event.

Returns:

a copy of this hover event

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public @NonNull java.lang.String toString()

Overrides:

toString in class java.lang.Object