Package net.minecraft.text

Interface Text

All Superinterfaces:
com.mojang.brigadier.Message, StringVisitable
All Known Implementing Classes:
MutableText
public interface Text extends com.mojang.brigadier.Message, StringVisitable
A text. Can be converted to and from JSON format.

Each text has a tree structure, embodying all its siblings. To iterate contents in the text and all its siblings, call visit methods.

This interface does not expose mutation operations. For mutation, refer to MutableText.

See Also:
Mappings:
Namespace Name
official rm
intermediary net/minecraft/class_2561
named net/minecraft/text/Text

  • Method Details

    • getStyle

      Style getStyle()
      Returns the style of this text.
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a()Lrv;
      intermediary method_10866 Lnet/minecraft/class_2561;method_10866()Lnet/minecraft/class_2583;
      named getStyle Lnet/minecraft/text/Text;getStyle()Lnet/minecraft/text/Style;

    • getContent

      TextContent getContent()
      Returns the content of the text.
      Returns:
      the content of the text
      Mappings:
      Namespace Name Mixin selector
      official b Lrm;b()Lrn;
      intermediary method_10851 Lnet/minecraft/class_2561;method_10851()Lnet/minecraft/class_7417;
      named getContent Lnet/minecraft/text/Text;getContent()Lnet/minecraft/text/TextContent;

    • getString

      default String getString()
      Specified by:
      getString in interface com.mojang.brigadier.Message
      Specified by:
      getString in interface StringVisitable

    • asTruncatedString

      default String asTruncatedString(int length)
      Returns the full string representation of this text, truncated beyond the supplied length.
      Parameters:
      length - the max length allowed for the string representation of the text
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(I)Ljava/lang/String;
      intermediary method_10858 Lnet/minecraft/class_2561;method_10858(I)Ljava/lang/String;
      named asTruncatedString Lnet/minecraft/text/Text;asTruncatedString(I)Ljava/lang/String;

    • getSiblings

      List<Text> getSiblings()
      Returns the siblings of this text.
      Mappings:
      Namespace Name Mixin selector
      official c Lrm;c()Ljava/util/List;
      intermediary method_10855 Lnet/minecraft/class_2561;method_10855()Ljava/util/List;
      named getSiblings Lnet/minecraft/text/Text;getSiblings()Ljava/util/List;

    • copyContentOnly

      default MutableText copyContentOnly()
      Copies the text's content, excluding the styles or siblings.
      Mappings:
      Namespace Name Mixin selector
      official d Lrm;d()Lrt;
      intermediary method_27662 Lnet/minecraft/class_2561;method_27662()Lnet/minecraft/class_5250;
      named copyContentOnly Lnet/minecraft/text/Text;copyContentOnly()Lnet/minecraft/text/MutableText;

    • copy

      default MutableText copy()
      Copies the text's content, the style, and the siblings.

      A shallow copy is made for the siblings.

      Mappings:
      Namespace Name Mixin selector
      official e Lrm;e()Lrt;
      intermediary method_27661 Lnet/minecraft/class_2561;method_27661()Lnet/minecraft/class_5250;
      named copy Lnet/minecraft/text/Text;copy()Lnet/minecraft/text/MutableText;

    • asOrderedText

      OrderedText asOrderedText()
      Mappings:
      Namespace Name Mixin selector
      official f Lrm;f()Lalc;
      intermediary method_30937 Lnet/minecraft/class_2561;method_30937()Lnet/minecraft/class_5481;
      named asOrderedText Lnet/minecraft/text/Text;asOrderedText()Lnet/minecraft/text/OrderedText;

    • visit

      default <T> Optional<T> visit(StringVisitable.StyledVisitor<T> styledVisitor, Style style)
      Supplies this visitable's literal content and contextual style to the visitor.
      Specified by:
      visit in interface StringVisitable
      Parameters:
      styledVisitor - the visitor
      style - the contextual style
      Returns:
      Optional.empty() if the visit finished, or a terminating result from the visitor
      Mappings:
      Namespace Name Mixin selector
      official a Lrp;a(Lrp$b;Lrv;)Ljava/util/Optional;
      intermediary method_27658 Lnet/minecraft/class_5348;method_27658(Lnet/minecraft/class_5348$class_5246;Lnet/minecraft/class_2583;)Ljava/util/Optional;
      named visit Lnet/minecraft/text/StringVisitable;visit(Lnet/minecraft/text/StringVisitable$StyledVisitor;Lnet/minecraft/text/Style;)Ljava/util/Optional;

    • visit

      default <T> Optional<T> visit(StringVisitable.Visitor<T> visitor)
      Supplies this visitable's literal content to the visitor.
      Specified by:
      visit in interface StringVisitable
      Parameters:
      visitor - the visitor
      Returns:
      Optional.empty() if the visit finished, or a terminating result from the visitor
      Mappings:
      Namespace Name Mixin selector
      official a Lrp;a(Lrp$a;)Ljava/util/Optional;
      intermediary method_27657 Lnet/minecraft/class_5348;method_27657(Lnet/minecraft/class_5348$class_5245;)Ljava/util/Optional;
      named visit Lnet/minecraft/text/StringVisitable;visit(Lnet/minecraft/text/StringVisitable$Visitor;)Ljava/util/Optional;

    • getWithStyle

      default List<Text> getWithStyle(Style style)
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Lrv;)Ljava/util/List;
      intermediary method_36136 Lnet/minecraft/class_2561;method_36136(Lnet/minecraft/class_2583;)Ljava/util/List;
      named getWithStyle Lnet/minecraft/text/Text;getWithStyle(Lnet/minecraft/text/Style;)Ljava/util/List;

    • of

      static Text of(@Nullable @Nullable String string)
      Creates a literal text with the given string as content.
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Ljava/lang/String;)Lrm;
      intermediary method_30163 Lnet/minecraft/class_2561;method_30163(Ljava/lang/String;)Lnet/minecraft/class_2561;
      named of Lnet/minecraft/text/Text;of(Ljava/lang/String;)Lnet/minecraft/text/Text;

    • literal

      static MutableText literal(String string)
      Mappings:
      Namespace Name Mixin selector
      official b Lrm;b(Ljava/lang/String;)Lrt;
      intermediary method_43470 Lnet/minecraft/class_2561;method_43470(Ljava/lang/String;)Lnet/minecraft/class_5250;
      named literal Lnet/minecraft/text/Text;literal(Ljava/lang/String;)Lnet/minecraft/text/MutableText;

    • translatable

      static MutableText translatable(String key)
      Mappings:
      Namespace Name Mixin selector
      official c Lrm;c(Ljava/lang/String;)Lrt;
      intermediary method_43471 Lnet/minecraft/class_2561;method_43471(Ljava/lang/String;)Lnet/minecraft/class_5250;
      named translatable Lnet/minecraft/text/Text;translatable(Ljava/lang/String;)Lnet/minecraft/text/MutableText;

    • translatable

      static MutableText translatable(String key, Object[] args)
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Ljava/lang/String;[Ljava/lang/Object;)Lrt;
      intermediary method_43469 Lnet/minecraft/class_2561;method_43469(Ljava/lang/String;[Ljava/lang/Object;)Lnet/minecraft/class_5250;
      named translatable Lnet/minecraft/text/Text;translatable(Ljava/lang/String;[Ljava/lang/Object;)Lnet/minecraft/text/MutableText;

    • empty

      static MutableText empty()
      Mappings:
      Namespace Name Mixin selector
      official g Lrm;g()Lrt;
      intermediary method_43473 Lnet/minecraft/class_2561;method_43473()Lnet/minecraft/class_5250;
      named empty Lnet/minecraft/text/Text;empty()Lnet/minecraft/text/MutableText;

    • keybind

      static MutableText keybind(String string)
      Mappings:
      Namespace Name Mixin selector
      official d Lrm;d(Ljava/lang/String;)Lrt;
      intermediary method_43472 Lnet/minecraft/class_2561;method_43472(Ljava/lang/String;)Lnet/minecraft/class_5250;
      named keybind Lnet/minecraft/text/Text;keybind(Ljava/lang/String;)Lnet/minecraft/text/MutableText;

    • nbt

      static MutableText nbt(String rawPath, boolean interpret, Optional<Text> separator, NbtDataSource dataSource)
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Ljava/lang/String;ZLjava/util/Optional;Lsa;)Lrt;
      intermediary method_43468 Lnet/minecraft/class_2561;method_43468(Ljava/lang/String;ZLjava/util/Optional;Lnet/minecraft/class_7419;)Lnet/minecraft/class_5250;
      named nbt Lnet/minecraft/text/Text;nbt(Ljava/lang/String;ZLjava/util/Optional;Lnet/minecraft/text/NbtDataSource;)Lnet/minecraft/text/MutableText;

    • score

      static MutableText score(String name, String objective)
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Ljava/lang/String;Ljava/lang/String;)Lrt;
      intermediary method_43466 Lnet/minecraft/class_2561;method_43466(Ljava/lang/String;Ljava/lang/String;)Lnet/minecraft/class_5250;
      named score Lnet/minecraft/text/Text;score(Ljava/lang/String;Ljava/lang/String;)Lnet/minecraft/text/MutableText;

    • selector

      static MutableText selector(String pattern, Optional<Text> separator)
      Mappings:
      Namespace Name Mixin selector
      official a Lrm;a(Ljava/lang/String;Ljava/util/Optional;)Lrt;
      intermediary method_43467 Lnet/minecraft/class_2561;method_43467(Ljava/lang/String;Ljava/util/Optional;)Lnet/minecraft/class_5250;
      named selector Lnet/minecraft/text/Text;selector(Ljava/lang/String;Ljava/util/Optional;)Lnet/minecraft/text/MutableText;