Class HoverEvent.Action<V>

java.lang.Object

net.kyori.adventure.text.event.HoverEvent.Action<V>

Type Parameters:

V - the value type an action handles

Enclosing class:

HoverEvent<V>

public static final class HoverEvent.Action<V>
extends Object

An enumeration of hover event actions.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HoverEvent.Action.Renderer<V>	Type-specific renderer.

Field Summary

Fields

Modifier and Type	Field	Description
static final Index<String, HoverEvent.Action<?>>	NAMES	The name map.
static final HoverEvent.Action<String>	SHOW_ACHIEVEMENT	Shows a Component when hovered over.
static final HoverEvent.Action<HoverEvent.ShowEntity>	SHOW_ENTITY	Shows an entity when hovered over.
static final HoverEvent.Action<HoverEvent.ShowItem>	SHOW_ITEM	Shows an item instance when hovered over.
static final HoverEvent.Action<Component>	SHOW_TEXT	Shows a Component when hovered over.

Method Summary

Modifier and Type	Method	Description
String	name()	Returns the name of this action.
boolean	readable()	Tests if this action is readable.
HoverEvent.Action.Renderer<V>	renderer()	The renderer for this action.
String	toString()
Class<V>	type()	Gets the value type.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SHOW_TEXT

public static final HoverEvent.Action<Component> SHOW_TEXT

Shows a Component when hovered over.

Since:

4.0.0

SHOW_ITEM

public static final HoverEvent.Action<HoverEvent.ShowItem> SHOW_ITEM

Shows an item instance when hovered over.

Since:

4.0.0

SHOW_ENTITY

public static final HoverEvent.Action<HoverEvent.ShowEntity> SHOW_ENTITY

Shows an entity when hovered over.

Since:

4.0.0

SHOW_ACHIEVEMENT

@Obsolete
public static final HoverEvent.Action<String> SHOW_ACHIEVEMENT

Shows a Component when hovered over.

Since:

4.14.0

Obsolete since Minecraft

removed in 1.12

NAMES

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

The name map.

Since:

4.0.0

Method Details

name

public String name()

Returns the name of this action.

Returns:

the name

Since:

5.0.0

type

public Class<V> type()

Gets the value type.

Returns:

the value type

Since:

4.0.0

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

renderer

public HoverEvent.Action.Renderer<V> renderer()

The renderer for this action.

Returns:

the renderer

Since:

5.0.0

toString

public String toString()

Overrides:

toString in class Object