HoverEvent.Action (adventure-api 4.5.1 API)

java.lang.Object

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

Enclosing class:: HoverEvent<V>

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

An enumeration of hover event actions.

Since:: 4.0.0

Field Summary

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

Method Summary

Modifier and Type Method Description

boolean readable()
Tests if this action is readable.

@NonNull String toString()

@NonNull Class<V> type()
Gets the value type.

Methods inherited from class java.lang.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
- NAMES
  
  public static final Index<String,HoverEvent.Action<?>> NAMES
  
  The name map.
  
  Since:
  
  4.0.0
Method Details
- type
  
  public @NonNull 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
- toString
  
  public @NonNull String toString()
  
  Overrides:
  
  toString in class Object