Package net.kyori.adventure.text.event
Interface HoverEventSource<V>
- Type Parameters:
V
- the value type
- All Known Subinterfaces:
BlockNBTComponent
,BuildableComponent<C,
,B> Component
,EntityNBTComponent
,KeybindComponent
,NBTComponent<C,
,B> ScopedComponent<C>
,ScoreComponent
,SelectorComponent
,StorageNBTComponent
,TextComponent
,TranslatableComponent
,VirtualComponent
- All Known Implementing Classes:
AbstractComponent
,HoverEvent
public interface HoverEventSource<V>
Something that can provide a
HoverEvent
.- Since:
- 4.0.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault @NotNull HoverEvent<V>
Represent this object as a hover event.@NotNull HoverEvent<V>
asHoverEvent
(@NotNull UnaryOperator<V> op) Creates a hover event with value derived from this object.static <V> @Nullable HoverEvent<V>
unbox
(@Nullable HoverEventSource<V> source) Fetches aHoverEvent
from aHoverEventSource
.
-
Method Details
-
unbox
Fetches aHoverEvent
from aHoverEventSource
.- Type Parameters:
V
- the value type- Parameters:
source
- the hover event source- Returns:
- a hover event, or
null
- Since:
- 4.0.0
-
asHoverEvent
Represent this object as a hover event.- Returns:
- a hover event
- Since:
- 4.0.0
-
asHoverEvent
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.
- Parameters:
op
- transformation on value- Returns:
- a hover event
- Since:
- 4.0.0
-