Module net.kyori.adventure.text.minimessage
Package net.kyori.adventure.text.minimessage.tag.standard

Class StandardTags

java.lang.Object
net.kyori.adventure.text.minimessage.tag.standard.StandardTags
public final class StandardTags extends Object
Tag types distributed with MiniMessage.

All built-in types are included in the default tag resolver.

Since:
4.10.0

  • Method Details

    • decorations

      public static TagResolver decorations(TextDecoration decoration)
      Get a resolver for a specific text decoration.

      This tag supports both the standard names from TextDecoration.NAMES as well as a few aliases from DecorationTag.

      Parameters:
      decoration - the decoration to have a tag for
      Returns:
      a resolver for a certain decoration's tags
      Since:
      4.10.0

    • decorations

      public static TagResolver decorations()
      Get a resolver for all decoration tags.

      This tag supports both standard names from TextDecoration.NAMES as well as a few aliases from DecorationTag.

      Returns:
      a resolver for all decoration tags
      Since:
      4.10.0

    • color

      public static TagResolver color()
      Get a resolver for the "color" tags.

      This tag supports both hex string colors as well as named colors.

      Returns:
      a resolver for the "color" tags
      Since:
      4.10.0

    • hoverEvent

      public static TagResolver hoverEvent()
      Get a resolver for the "hover" tag.
      Returns:
      a resolver for the "hover" tag
      Since:
      4.10.0

    • clickEvent

      public static TagResolver clickEvent()
      Get a resolver for the "click" tag.
      Returns:
      a resolver for the "click" tag
      Since:
      4.10.0

    • keybind

      public static TagResolver keybind()
      Get a resolver for the "key" tag.
      Returns:
      a resolver for the "key" tag
      Since:
      4.10.0

    • sequentialHead

      public static TagResolver sequentialHead()
      Get a resolver for the "head" tag.

      This variant of the head tag handles an alternative shorthand way of writing the head tag <head:name|uuid|texture:[outer_layer]>.

      Returns:
      a resolver for the "head" tag.
      Since:
      4.25.0
      Since Minecraft:
      1.21.9

    • translatable

      public static TagResolver translatable()
      Get a resolver for the "translate" tag.

      This tag also responds to "lang" and "tr".

      Returns:
      a resolver for the "translate" tag
      Since:
      4.10.0

    • translatableFallback

      public static TagResolver translatableFallback()
      Get a resolver for the "translate_or" tag.

      This tag also responds to "lang_or" and "tr_or".

      Returns:
      a resolver for the "translate_or" tag
      Since:
      4.13.0

    • insertion

      public static TagResolver insertion()
      Get a resolver for the "insert" tag.
      Returns:
      a resolver for the "insert" tag
      Since:
      4.10.0

    • font

      public static TagResolver font()
      Get a resolver for the "font" tag.
      Returns:
      a resolver for the "font" tag
      Since:
      4.10.0

    • gradient

      public static TagResolver gradient()
      Get a resolver for the "gradient" tag.
      Returns:
      a resolver for the "gradient" tag
      Since:
      4.10.0

    • rainbow

      public static TagResolver rainbow()
      Get a resolver for the "rainbow" tag.
      Returns:
      a resolver for the "rainbow" tag
      Since:
      4.10.0

    • transition

      public static TagResolver transition()
      Get a resolver for the "transition" tag.
      Returns:
      a resolver for the "transition" tag
      Since:
      4.10.0

    • reset

      public static TagResolver reset()
      Get a resolver for the "reset" tag.
      Returns:
      a resolver for the "reset" tag.
      Since:
      4.10.0

    • newline

      public static TagResolver newline()
      Get a resolver for the "newline" tag.

      This tag also responds to "br".

      Returns:
      a resolver for the "newline" tag.
      Since:
      4.10.0

    • selector

      public static TagResolver selector()
      Get a resolver for the "selector" tag.

      This tag also responds to "sel".

      Returns:
      a resolver for the "selector" tag
      Since:
      4.11.0

    • score

      public static TagResolver score()
      Get a resolver for the "score" tag.
      Returns:
      a resolver for the "score" tag
      Since:
      4.13.0

    • nbt

      public static TagResolver nbt()
      Get a resolver for the "nbt" tag.

      This tag also responds to "data".

      Returns:
      a resolver for the "nbt" tag.
      Since:
      4.13.0

    • pride

      public static TagResolver pride()
      Get a resolver for the "pride" tag.
      Returns:
      a resolver for the "pride" tag
      Since:
      4.18.0

    • shadowColor

      public static TagResolver shadowColor()
      Get a resolver for the "shadow" tags.

      This tag support both hex string

      Returns:
      a resolver for the "shadow" tags
      Since:
      4.18.0

    • sprite

      public static TagResolver sprite()
      Get a resolver for the "sprite" tag.
      Returns:
      a resolver for the "sprite" tag.
      Since:
      4.25.0
      Since Minecraft:
      1.21.9

    • defaults

      public static TagResolver defaults()
      Get a resolver that handles all default standard tags.

      This will currently return all standard tags, but in the future MiniMessage may add tags that are not enabled by default, and which must explicitly be opted-in to.

      Returns:
      the resolver for built-in tags
      Since:
      4.10.0

    • forPreset

      public static TagResolver forPreset(MiniMessage.Preset preset)
      Get a resolver that handles all standard tags for a given preset.
      Parameters:
      preset - the preset
      Returns:
      the resolver for built-in tags for a preset
      Since:
      5.0.0