Class TextComponent

java.lang.Object
net.md_5.bungee.api.chat.BaseComponent
net.md_5.bungee.api.chat.TextComponent

public final class TextComponent extends BaseComponent
  • Constructor Details

    • TextComponent

      public TextComponent()
      Creates a TextComponent with blank text.
    • TextComponent

      public TextComponent(TextComponent textComponent)
      Creates a TextComponent with formatting and text from the passed component
      Parameters:
      textComponent - the component to copy from
    • TextComponent

      public TextComponent(BaseComponent... extras)
      Creates a TextComponent with blank text and the extras set to the passed array
      Parameters:
      extras - the extras to set
  • Method Details

    • fromLegacy

      public static BaseComponent fromLegacy(String message)
      Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
      Parameters:
      message - the text to convert
      Returns:
      the components needed to print the message to the client
    • fromLegacy

      public static BaseComponent fromLegacy(String message, ChatColor defaultColor)
      Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
      Parameters:
      message - the text to convert
      defaultColor - color to use when no formatting is to be applied (i.e. after ChatColor.RESET).
      Returns:
      the components needed to print the message to the client
    • fromLegacyText

      @Deprecated public static BaseComponent[] fromLegacyText(String message)
      Deprecated.
      fromLegacy(String) is preferred as it will consolidate all components into a single BaseComponent with extra contents as opposed to an array of components which is non-standard and may result in unexpected behavior.
      Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
      Parameters:
      message - the text to convert
      Returns:
      the components needed to print the message to the client
    • fromLegacyText

      @Deprecated public static BaseComponent[] fromLegacyText(String message, ChatColor defaultColor)
      Deprecated.
      fromLegacy(String, ChatColor) is preferred as it will consolidate all components into a single BaseComponent with extra contents as opposed to an array of components which is non-standard and may result in unexpected behavior.
      Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
      Parameters:
      message - the text to convert
      defaultColor - color to use when no formatting is to be applied (i.e. after ChatColor.RESET).
      Returns:
      the components needed to print the message to the client
    • fromArray

      public static BaseComponent fromArray(BaseComponent... components)
      Internal compatibility method to transform an array of components to a single component.
      Parameters:
      components - array
      Returns:
      single component
    • duplicate

      public TextComponent duplicate()
      Creates a duplicate of this TextComponent.
      Specified by:
      duplicate in class BaseComponent
      Returns:
      the duplicate of this TextComponent.
    • toPlainText

      protected void toPlainText(StringBuilder builder)
    • toLegacyText

      protected void toLegacyText(StringBuilder builder)
    • toString

      public String toString()
      Overrides:
      toString in class Object