Module net.kyori.adventure.api
Package net.kyori.adventure.text.format

Interface StyleGetter

All Known Subinterfaces:
BlockNBTComponent, Component, EntityNBTComponent, KeybindComponent, NBTComponent<C>, ObjectComponent, ScopedComponent<C>, ScoreComponent, SelectorComponent, StorageNBTComponent, Style, TextComponent, TranslatableComponent, VirtualComponent
@NonExtendable public interface StyleGetter
Reads style properties from an object.
Since:
4.10.0
See Also:

  • Method Details

    • font

      @Nullable Key font()
      Gets the font.
      Returns:
      the font
      Since:
      4.10.0
      Since Minecraft:
      1.16

    • color

      @Nullable TextColor color()
      Gets the color.
      Returns:
      the color
      Since:
      4.10.0

    • shadowColor

      @Nullable ShadowColor shadowColor()
      Gets the shadow color.
      Returns:
      the shadow color
      Since:
      4.18.0

    • hasDecoration

      default boolean hasDecoration(TextDecoration decoration)
      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

      TextDecoration.State decoration(TextDecoration 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, and TextDecoration.State.NOT_SET if not set
      Since:
      4.10.0

    • decorations

      default @Unmodifiable Map<TextDecoration,TextDecoration.State> decorations()
      Gets a map of decorations this stylable has.
      Returns:
      a set of decorations this stylable has
      Since:
      4.10.0

    • clickEvent

      @Nullable ClickEvent<?> clickEvent()
      Gets the click event.
      Returns:
      the click event
      Since:
      4.10.0

    • hoverEvent

      @Nullable HoverEvent<?> hoverEvent()
      Gets the hover event.
      Returns:
      the hover event
      Since:
      4.10.0

    • insertion

      @Nullable String insertion()
      Gets the string to be inserted when this stylable is shift-clicked.
      Returns:
      the insertion string
      Since:
      4.10.0