java.lang.Object

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

Type Parameters:: V - the value type

All Implemented Interfaces:: ComponentBuilderApplicable, HoverEventSource<V>, StyleBuilderApplicable

public final class HoverEvent<V> extends Object implements HoverEventSource<V>, StyleBuilderApplicable

A hover event.

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

Since:: 4.0.0

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

HoverEvent.Action<V>

An enumeration of hover event actions.

static final class

HoverEvent.ShowEntity

The value of a show_entity hover event.

static final class

HoverEvent.ShowItem

The value of a show_item hover event.
Method Summary

Modifier and Type

Method

Description

HoverEvent.Action<V>

action()

Gets the hover event action.

HoverEvent<V>

asHoverEvent()

Represent this object as a hover event.

HoverEvent<V>

asHoverEvent(UnaryOperator<V> op)

Creates a hover event with value derived from this object.

boolean

equals(Object o)

int

hashCode()

static <V> HoverEvent<V>

hoverEvent(HoverEvent.Action<V> action, V value)

Creates a hover event.

static HoverEvent<String>

showAchievement(String value)

Creates a hover event that shows an achievement on hover.

static HoverEvent<HoverEvent.ShowEntity>

showEntity(Keyed type, UUID id)

Creates a hover event that show information about an entity on hover.

static HoverEvent<HoverEvent.ShowEntity>

showEntity(Keyed type, UUID id, @Nullable Component name)

Creates a hover event that show information about an entity on hover.

static HoverEvent<HoverEvent.ShowEntity>

showEntity(Key type, UUID id)

Creates a hover event that show information about an entity on hover.

static HoverEvent<HoverEvent.ShowEntity>

showEntity(Key type, UUID id, @Nullable Component name)

Creates a hover event that show information about an entity on hover.

static HoverEvent<HoverEvent.ShowEntity>

showEntity(HoverEvent.ShowEntity entity)

Creates a hover event that show information about an entity on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(Keyed item, @Range(from=0L,to=2147483647L) int count)

Creates a hover event that shows an item on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, Map<Key, ? extends DataComponentValue> dataComponents)

Creates a hover event that shows an item on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)

Creates a hover event that shows an item on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(Key item, @Range(from=0L,to=2147483647L) int count)

Creates a hover event that shows an item on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(Key item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)

Creates a hover event that shows an item on hover.

static HoverEvent<HoverEvent.ShowItem>

showItem(HoverEvent.ShowItem item)

Creates a hover event that shows an item on hover.

static HoverEvent<Component>

showText(Component text)

Creates a hover event that shows text on hover.

static HoverEvent<Component>

showText(ComponentLike text)

Creates a hover event that shows text on hover.

void

styleApply(Style.Builder style)

Applies to style.

String

toString()

V

value()

Gets the hover event value.

HoverEvent<V>

value(V value)

Sets the hover event value.

<C> HoverEvent<V>

withRenderedValue(ComponentRenderer<C> renderer, C context)

Returns a hover event with the value rendered using renderer when possible.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface StyleBuilderApplicable
componentBuilderApply

Method Details
- showText
  
  public static HoverEvent<Component> showText(ComponentLike text)
  
  Creates a hover event that shows text on hover.
  
  Parameters:
  
  text - the text to show on hover
  
  Returns:
  
  a hover event
  
  Since:
  
  4.2.0
- showText
  
  public static HoverEvent<Component> showText(Component text)
  
  Creates a hover event that shows text on hover.
  
  Parameters:
  
  text - the text to show on hover
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
- showItem
  
  public static HoverEvent<HoverEvent.ShowItem> showItem(Key item, @Range(from=0L,to=2147483647L) int count)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item
  
  count - the count
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
- showItem
  
  public static HoverEvent<HoverEvent.ShowItem> showItem(Keyed item, @Range(from=0L,to=2147483647L) int count)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item
  
  count - the count
  
  Returns:
  
  a hover event
  
  Since:
  
  4.6.0
- showItem
  
  @Obsolete public static HoverEvent<HoverEvent.ShowItem> showItem(Key item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item
  
  count - the count
  
  nbt - the nbt
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
  
  Obsolete since Minecraft
  
  obsolete since 1.20.5 and replaced with data components
- showItem
  
  @Obsolete public static HoverEvent<HoverEvent.ShowItem> showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item
  
  count - the count
  
  nbt - the nbt
  
  Returns:
  
  a hover event
  
  Since:
  
  4.6.0
  
  Obsolete since Minecraft
  
  obsolete since 1.20.5 and replaced with data components
- showItem
  
  public static HoverEvent<HoverEvent.ShowItem> showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, Map<Key, ? extends DataComponentValue> dataComponents)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item
  
  count - the count
  
  dataComponents - the data components
  
  Returns:
  
  a hover event
  
  Since:
  
  4.17.0
- showItem
  
  public static HoverEvent<HoverEvent.ShowItem> showItem(HoverEvent.ShowItem item)
  
  Creates a hover event that shows an item on hover.
  
  Parameters:
  
  item - the item to show on hover
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
- showEntity
  
  public static HoverEvent<HoverEvent.ShowEntity> showEntity(Key type, UUID id)
  
  Creates a hover event that show information about an entity on hover.
  In the official Minecraft: Java Edition client, no information will be shown unless the "Advanced tooltips" debug option is enabled.
  
  Parameters:
  
  type - the type
  
  id - the id
  
  Returns:
  
  a ShowEntity
  
  Since:
  
  4.0.0
- showEntity
  
  public static HoverEvent<HoverEvent.ShowEntity> showEntity(Keyed type, UUID id)
  
  Creates a hover event that show information about an entity on hover.
  In the official Minecraft: Java Edition client, no information will be shown unless the "Advanced tooltips" debug option is enabled.
  
  Parameters:
  
  type - the type
  
  id - the id
  
  Returns:
  
  a ShowEntity
  
  Since:
  
  4.6.0
- showEntity
  
  public static HoverEvent<HoverEvent.ShowEntity> showEntity(Key type, UUID id, @Nullable Component name)
  
  Creates a hover event that show information about an entity on hover.
  In the official Minecraft: Java Edition client, no information will be shown unless the "Advanced tooltips" debug option is enabled.
  
  Parameters:
  
  type - the type
  
  id - the id
  
  name - the name
  
  Returns:
  
  a ShowEntity
  
  Since:
  
  4.0.0
- showEntity
  
  public static HoverEvent<HoverEvent.ShowEntity> showEntity(Keyed type, UUID id, @Nullable Component name)
  
  Creates a hover event that show information about an entity on hover.
  In the official Minecraft: Java Edition client, no information will be shown unless the "Advanced tooltips" debug option is enabled.
  
  Parameters:
  
  type - the type
  
  id - the id
  
  name - the name
  
  Returns:
  
  a ShowEntity
  
  Since:
  
  4.6.0
- showEntity
  
  public static HoverEvent<HoverEvent.ShowEntity> showEntity(HoverEvent.ShowEntity entity)
  
  Creates a hover event that show information about an entity on hover.
  In the official Minecraft: Java Edition client, no information will be shown unless the "Advanced tooltips" debug option is enabled.
  
  Parameters:
  
  entity - the entity to show on hover
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
- showAchievement
  
  @Obsolete public static HoverEvent<String> showAchievement(String value)
  
  Creates a hover event that shows an achievement on hover.
  
  Parameters:
  
  value - the achievement value
  
  Returns:
  
  a hover event
  
  Since:
  
  4.14.0
  
  Obsolete since Minecraft
  
  removed in 1.12
- hoverEvent
  
  public static <V> HoverEvent<V> hoverEvent(HoverEvent.Action<V> action, V value)
  
  Creates a hover event.
  
  Type Parameters:
  
  V - the value type
  
  Parameters:
  
  action - the action
  
  value - the value
  
  Returns:
  
  a click event
  
  Since:
  
  4.0.0
- action
  
  public HoverEvent.Action<V> action()
  
  Gets the hover event action.
  
  Returns:
  
  the hover event action
  
  Since:
  
  4.0.0
- value
  
  public V value()
  
  Gets the hover event value.
  
  Returns:
  
  the hover event value
  
  Since:
  
  4.0.0
- value
  
  @Contract(pure=true) public HoverEvent<V> value(V value)
  
  Sets the hover event value.
  
  Parameters:
  
  value - the hover event value
  
  Returns:
  
  a new hover event with the value set
  
  Since:
  
  4.0.0
- withRenderedValue
  
  public <C> HoverEvent<V> withRenderedValue(ComponentRenderer<C> renderer, C context)
  
  Returns a hover event with the value rendered using renderer when possible.
  
  Type Parameters:
  
  C - the context type
  
  Parameters:
  
  renderer - the renderer
  
  context - the render context
  
  Returns:
  
  a hover event
  
  Since:
  
  4.0.0
- asHoverEvent
  
  public HoverEvent<V> asHoverEvent()
  
  Description copied from interface: HoverEventSource
  
  Represent this object as a hover event.
  
  Specified by:
  
  asHoverEvent in interface HoverEventSource<V>
  
  Returns:
  
  a hover event
- asHoverEvent
  
  public HoverEvent<V> asHoverEvent(UnaryOperator<V> op)
  
  Description copied from interface: HoverEventSource
  
  Creates a hover event with value derived from this object.
  The event value will be passed through the provided callback to allow transforming the original value of the event.
  
  Specified by:
  
  asHoverEvent in interface HoverEventSource<V>
  
  Parameters:
  
  op - transformation on value
  
  Returns:
  
  a hover event
- styleApply
  
  public void styleApply(Style.Builder style)
  
  Description copied from interface: StyleBuilderApplicable
  
  Applies to style.
  
  Specified by:
  
  styleApply in interface StyleBuilderApplicable
  
  Parameters:
  
  style - the style builder
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class HoverEvent<V>

Nested Class Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface StyleBuilderApplicable

Method Details

showText

showText

showItem

showItem

showItem

showItem

showItem

showItem

showEntity

showEntity

showEntity

showEntity

showEntity

showAchievement

hoverEvent

action

value

value

withRenderedValue

asHoverEvent

asHoverEvent

styleApply

equals

hashCode

toString