Package net.kyori.adventure.text.minimessage.tag.resolver

Class Placeholder

java.lang.Object
net.kyori.adventure.text.minimessage.tag.resolver.Placeholder
public final class Placeholder extends Object
Tag resolvers producing tags that insert fixed values.

These are effectively placeholders.

Since:
4.10.0

  • Method Details

    • parsed

      public static @NotNull TagResolver.Single parsed(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull String value)
      Creates a placeholder that inserts a MiniMessage string.

      The inserted string will impact the rest of the parse process.

      Parameters:
      key - the key
      value - the replacement
      Returns:
      the placeholder
      Since:
      4.10.0

    • unparsed

      public static @NotNull TagResolver.Single unparsed(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull String value)
      Creates a placeholder that inserts a literal string, without attempting to parse any contained tags.
      Parameters:
      key - the key
      value - the replacement
      Returns:
      the placeholder
      Since:
      4.10.0

    • component

      public static @NotNull TagResolver.Single component(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull ComponentLike value)
      Creates a replacement that inserts a component.

      This replacement is auto-closing, so its style will not influence the style of following components.

      Parameters:
      key - the key
      value - the replacement
      Returns:
      the placeholder
      Since:
      4.10.0

    • styling

      public static @NotNull TagResolver.Single styling(@TagPattern @NotNull @NotNull String key, @NotNull @NotNull StyleBuilderApplicable @NotNull ... style)
      Creates a style tag which will modify the style of the component.

      This style can be used like other styles.

      Parameters:
      key - the key
      style - the style
      Returns:
      the placeholder
      Since:
      4.13.0