Package net.kyori.adventure.text.event
Class HoverEvent<V>
- 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 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 ashow_entity
hover event.static class
HoverEvent.ShowItem
The value of ashow_item
hover event.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull HoverEvent.Action<V>
action()
Gets the hover event action.@NonNull HoverEvent<V>
asHoverEvent()
Represent this object as a hover event.@NonNull HoverEvent<V>
asHoverEvent(@NonNull UnaryOperator<V> op)
Creates a hover event with value derived from this object.boolean
equals(@Nullable Object other)
@NonNull Stream<? extends net.kyori.examination.ExaminableProperty>
examinableProperties()
int
hashCode()
static <V> @NonNull HoverEvent<V>
hoverEvent(@NonNull HoverEvent.Action<V> action, @NonNull V value)
Creates a hover event.static @NonNull HoverEvent<HoverEvent.ShowEntity>
showEntity(@NonNull net.kyori.adventure.key.Key type, @NonNull UUID id)
Creates a hover event that show information about an entity on hover.static @NonNull HoverEvent<HoverEvent.ShowEntity>
showEntity(@NonNull net.kyori.adventure.key.Key type, @NonNull UUID id, @Nullable Component name)
Creates a hover event that show information about an entity on hover.static @NonNull HoverEvent<HoverEvent.ShowEntity>
showEntity(@NonNull HoverEvent.ShowEntity entity)
Creates a hover event that show information about an entity on hover.static @NonNull HoverEvent<HoverEvent.ShowItem>
showItem(@NonNull net.kyori.adventure.key.Key item, @org.checkerframework.checker.index.qual.NonNegative int count)
Creates a hover event that shows an item on hover.static @NonNull HoverEvent<HoverEvent.ShowItem>
showItem(@NonNull net.kyori.adventure.key.Key item, @org.checkerframework.checker.index.qual.NonNegative int count, @Nullable BinaryTagHolder nbt)
Creates a hover event that shows an item on hover.static @NonNull HoverEvent<HoverEvent.ShowItem>
showItem(@NonNull HoverEvent.ShowItem item)
Creates a hover event that shows an item on hover.static @NonNull HoverEvent<Component>
showText(@NonNull Component text)
Creates a hover event that shows text on hover.static @NonNull HoverEvent<Component>
showText(@NonNull ComponentLike text)
Creates a hover event that shows text on hover.void
styleApply(@NonNull Style.Builder style)
Applies tostyle
.String
toString()
@NonNull V
value()
Gets the hover event value.@NonNull HoverEvent<V>
value(@NonNull V value)
Sets the hover event value.<C> @NonNull HoverEvent<V>
withRenderedValue(@NonNull ComponentRenderer<C> renderer, @NonNull C context)
Returns a hover event with the value rendered usingrenderer
when possible.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.kyori.adventure.text.format.StyleBuilderApplicable
componentBuilderApply
-
-
-
-
Method Detail
-
showText
public static @NonNull HoverEvent<Component> showText(@NonNull 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 @NonNull HoverEvent<Component> showText(@NonNull 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 @NonNull HoverEvent<HoverEvent.ShowItem> showItem(@NonNull net.kyori.adventure.key.Key item, @org.checkerframework.checker.index.qual.NonNegative int count)
Creates a hover event that shows an item on hover.- Parameters:
item
- the itemcount
- the count- Returns:
- a hover event
- Since:
- 4.0.0
-
showItem
public static @NonNull HoverEvent<HoverEvent.ShowItem> showItem(@NonNull net.kyori.adventure.key.Key item, @org.checkerframework.checker.index.qual.NonNegative int count, @Nullable BinaryTagHolder nbt)
Creates a hover event that shows an item on hover.- Parameters:
item
- the itemcount
- the countnbt
- the nbt- Returns:
- a hover event
- Since:
- 4.0.0
-
showItem
public static @NonNull HoverEvent<HoverEvent.ShowItem> showItem(@NonNull 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 @NonNull HoverEvent<HoverEvent.ShowEntity> showEntity(@NonNull net.kyori.adventure.key.Key type, @NonNull UUID id)
Creates a hover event that show information about an entity on hover.- Parameters:
type
- the typeid
- the id- Returns:
- a
ShowEntity
- Since:
- 4.0.0
-
showEntity
public static @NonNull HoverEvent<HoverEvent.ShowEntity> showEntity(@NonNull net.kyori.adventure.key.Key type, @NonNull UUID id, @Nullable Component name)
Creates a hover event that show information about an entity on hover.- Parameters:
type
- the typeid
- the idname
- the name- Returns:
- a
ShowEntity
- Since:
- 4.0.0
-
showEntity
public static @NonNull HoverEvent<HoverEvent.ShowEntity> showEntity(@NonNull HoverEvent.ShowEntity entity)
Creates a hover event that show information about an entity on hover.- Parameters:
entity
- the entity to show on hover- Returns:
- a hover event
- Since:
- 4.0.0
-
hoverEvent
public static <V> @NonNull HoverEvent<V> hoverEvent(@NonNull HoverEvent.Action<V> action, @NonNull V value)
Creates a hover event.- Type Parameters:
V
- the value type- Parameters:
action
- the actionvalue
- the value- Returns:
- a click event
- Since:
- 4.0.0
-
action
public @NonNull HoverEvent.Action<V> action()
Gets the hover event action.- Returns:
- the hover event action
- Since:
- 4.0.0
-
value
public @NonNull V value()
Gets the hover event value.- Returns:
- the hover event value
- Since:
- 4.0.0
-
value
public @NonNull HoverEvent<V> value(@NonNull V value)
Sets the hover event value.- Parameters:
value
- the hover event value- Returns:
- a hover event
- Since:
- 4.0.0
-
withRenderedValue
public <C> @NonNull HoverEvent<V> withRenderedValue(@NonNull ComponentRenderer<C> renderer, @NonNull C context)
Returns a hover event with the value rendered usingrenderer
when possible.- Type Parameters:
C
- the context type- Parameters:
renderer
- the renderercontext
- the render context- Returns:
- a hover event
- Since:
- 4.0.0
-
asHoverEvent
public @NonNull HoverEvent<V> asHoverEvent()
Description copied from interface:HoverEventSource
Represent this object as a hover event.- Specified by:
asHoverEvent
in interfaceHoverEventSource<V>
- Returns:
- a hover event
-
asHoverEvent
public @NonNull HoverEvent<V> asHoverEvent(@NonNull 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 interfaceHoverEventSource<V>
- Parameters:
op
- transformation on value- Returns:
- a hover event
-
styleApply
public void styleApply(@NonNull Style.Builder style)
Description copied from interface:StyleBuilderApplicable
Applies tostyle
.- Specified by:
styleApply
in interfaceStyleBuilderApplicable
- Parameters:
style
- the style builder
-
examinableProperties
public @NonNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
-
-