Package net.kyori.adventure.text.format
Interface StyleGetter
- All Known Subinterfaces:
BlockNBTComponent
,BuildableComponent<C,
,B> Component
,EntityNBTComponent
,KeybindComponent
,NBTComponent<C,
,B> ScopedComponent<C>
,ScoreComponent
,SelectorComponent
,StorageNBTComponent
,Style
,TextComponent
,TranslatableComponent
,VirtualComponent
- All Known Implementing Classes:
AbstractComponent
@NonExtendable
public interface StyleGetter
Reads style properties from an object.
- Since:
- 4.10.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescription@Nullable ClickEvent
Gets the click event.@Nullable TextColor
color()
Gets the color.@NotNull TextDecoration.State
decoration
(@NotNull TextDecoration decoration) Gets the state of a decoration on this stylable.default @Unmodifiable @NotNull Map<TextDecoration,
TextDecoration.State> Gets a map of decorations this stylable has.@Nullable Key
font()
Gets the font.default boolean
hasDecoration
(@NotNull TextDecoration decoration) Tests if this stylable has a decoration.@Nullable HoverEvent<?>
Gets the hover event.@Nullable String
Gets the string to be inserted when this stylable is shift-clicked.@Nullable ShadowColor
Gets the shadow color.
-
Method Details
-
font
Gets the font.- Returns:
- the font
- Since:
- 4.10.0
- Since Minecraft:
- 1.16
-
color
Gets the color.- Returns:
- the color
- Since:
- 4.10.0
-
shadowColor
Gets the shadow color.- Returns:
- the shadow color
- Since:
- 4.18.0
-
hasDecoration
Tests if this stylable has a decoration.- Parameters:
decoration
- the decoration- Returns:
true
if this stylable has the decoration,false
if this stylable does not have the decoration- Since:
- 4.10.0
-
decoration
Gets the state of a decoration on this stylable.- Parameters:
decoration
- the decoration- Returns:
TextDecoration.State.TRUE
if this stylable has the decoration,TextDecoration.State.FALSE
if this stylable does not have the decoration, andTextDecoration.State.NOT_SET
if not set- Since:
- 4.10.0
-
decorations
Gets a map of decorations this stylable has.- Returns:
- a set of decorations this stylable has
- Since:
- 4.10.0
-
clickEvent
Gets the click event.- Returns:
- the click event
- Since:
- 4.10.0
-
hoverEvent
Gets the hover event.- Returns:
- the hover event
- Since:
- 4.10.0
-
insertion
Gets the string to be inserted when this stylable is shift-clicked.- Returns:
- the insertion string
- Since:
- 4.10.0
-