java.lang.Object
- net.kyori.adventure.text.event.HoverEvent<V>

Type Parameters:

V - the value type

All Implemented Interfaces:

ComponentBuilderApplicable, HoverEventSource<V>, StyleBuilderApplicable, net.kyori.examination.Examinable
```
public final class HoverEvent<V>
extends java.lang.Object
implements net.kyori.examination.Examinable, 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 class`	`HoverEvent.Action<V>`	An enumeration of hover event actions.
`static class`	`HoverEvent.ShowEntity`	The value of a `show_entity` hover event.
`static class`	`HoverEvent.ShowItem`	The value of a `show_item` hover event.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`@NotNull HoverEvent.Action<V>`	`action()`	Gets the hover event action.
`@NotNull HoverEvent<V>`	`asHoverEvent()`	Represent this object as a hover event.
`@NotNull HoverEvent<V>`	`asHoverEvent(@NotNull java.util.function.UnaryOperator<V> op)`	Creates a hover event with value derived from this object.
`boolean`	`equals(@Nullable java.lang.Object other)`
`@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>`	`examinableProperties()`
`int`	`hashCode()`
`static <V> @NotNull HoverEvent<V>`	`hoverEvent(@NotNull HoverEvent.Action<V> action, V value)`	Creates a hover event.
`static @NotNull HoverEvent<java.lang.String>`	`showAchievement(@NotNull java.lang.String value)`	Deprecated. Removed in Vanilla 1.12, but we keep it for backwards compat
`static @NotNull HoverEvent<HoverEvent.ShowEntity>`	`showEntity(@NotNull Keyed type, @NotNull java.util.UUID id)`	Creates a hover event that show information about an entity on hover.
`static @NotNull HoverEvent<HoverEvent.ShowEntity>`	`showEntity(@NotNull Keyed type, @NotNull java.util.UUID id, @Nullable Component name)`	Creates a hover event that show information about an entity on hover.
`static @NotNull HoverEvent<HoverEvent.ShowEntity>`	`showEntity(@NotNull Key type, @NotNull java.util.UUID id)`	Creates a hover event that show information about an entity on hover.
`static @NotNull HoverEvent<HoverEvent.ShowEntity>`	`showEntity(@NotNull Key type, @NotNull java.util.UUID id, @Nullable Component name)`	Creates a hover event that show information about an entity on hover.
`static @NotNull HoverEvent<HoverEvent.ShowEntity>`	`showEntity(@NotNull HoverEvent.ShowEntity entity)`	Creates a hover event that show information about an entity on hover.
`static @NotNull HoverEvent<HoverEvent.ShowItem>`	`showItem(@NotNull Keyed item, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int count)`	Creates a hover event that shows an item on hover.
`static @NotNull HoverEvent<HoverEvent.ShowItem>`	`showItem(@NotNull Keyed item, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int count, @Nullable BinaryTagHolder nbt)`	Creates a hover event that shows an item on hover.
`static @NotNull HoverEvent<HoverEvent.ShowItem>`	`showItem(@NotNull Key item, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int count)`	Creates a hover event that shows an item on hover.
`static @NotNull HoverEvent<HoverEvent.ShowItem>`	`showItem(@NotNull Key item, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int count, @Nullable BinaryTagHolder nbt)`	Creates a hover event that shows an item on hover.
`static @NotNull HoverEvent<HoverEvent.ShowItem>`	`showItem(@NotNull HoverEvent.ShowItem item)`	Creates a hover event that shows an item on hover.
`static @NotNull HoverEvent<Component>`	`showText(@NotNull Component text)`	Creates a hover event that shows text on hover.
`static @NotNull HoverEvent<Component>`	`showText(@NotNull ComponentLike text)`	Creates a hover event that shows text on hover.
`void`	`styleApply(@NotNull Style.Builder style)`	Applies to `style`.
`java.lang.String`	`toString()`
`V`	`value()`	Gets the hover event value.
`@NotNull HoverEvent<V>`	`value(V value)`	Sets the hover event value.
`<C> @NotNull HoverEvent<V>`	`withRenderedValue(@NotNull ComponentRenderer<C> renderer, C context)`	Returns a hover event with the value rendered using `renderer` when possible.

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

Methods inherited from interface net.kyori.examination.Examinable
examinableName, examine

Methods inherited from interface net.kyori.adventure.text.format.StyleBuilderApplicable
componentBuilderApply

Method Detail

showText

@NotNull
public static @NotNull HoverEvent<Component> showText(@NotNull
                                                      @NotNull 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

@NotNull
public static @NotNull HoverEvent<Component> showText(@NotNull
                                                      @NotNull 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