Interface ExternalPlaceholderEngine

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ExternalPlaceholderEngine
Hook for integrating external placeholder engines.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ExternalPlaceholderEngine
    NOOP
    No-op placeholder engine implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    default net.kyori.adventure.audience.Audience
    adventureAudience(Audience audience)
    Returns a Kyori audience wrapper for the platform audience.
    String
    apply(Audience audience, String text)
    Applies external placeholder processing to plain text.
    default net.kyori.adventure.text.Component
    applyComponent(Audience audience, net.kyori.adventure.text.Component component)
    Applies external placeholder processing to a component.
    default net.kyori.adventure.text.minimessage.tag.resolver.TagResolver
    tagResolver(Audience audience)
    Returns a tag resolver for MiniMessage parsing.

  • Field Details

  • Method Details

    • apply

      String apply(Audience audience, String text)
      Applies external placeholder processing to plain text.
      Parameters:
      audience - audience context
      text - input text
      Returns:
      processed text

    • tagResolver

      default net.kyori.adventure.text.minimessage.tag.resolver.TagResolver tagResolver(Audience audience)
      Returns a tag resolver for MiniMessage parsing.
      Parameters:
      audience - audience context
      Returns:
      tag resolver

    • adventureAudience

      default net.kyori.adventure.audience.Audience adventureAudience(Audience audience)
      Returns a Kyori audience wrapper for the platform audience.
      Parameters:
      audience - audience context
      Returns:
      adventure audience or null

    • applyComponent

      default net.kyori.adventure.text.Component applyComponent(Audience audience, net.kyori.adventure.text.Component component)
      Applies external placeholder processing to a component.
      Parameters:
      audience - audience context
      component - component to process
      Returns:
      processed component