Package net.minecraft.text

Record Class Decoration

java.lang.Object
java.lang.Record
net.minecraft.text.Decoration
Record Components:
translationKey -
parameters -
style -
public record Decoration(String translationKey, List<Decoration.Parameter> parameters, Style style) extends Record
A decoration is a pre-defined set of styling and formatting rules for messages sent by the server. This consists of the translation key, the style, and the parameters usable in the translation. The actual text format needs to be supplied via custom language files in resource packs.
Mappings:
Namespace Name
official st
intermediary net/minecraft/class_7463
named net/minecraft/text/Decoration
official b
intermediary comp_788
named translationKey
official c
intermediary comp_789
named parameters
official d
intermediary comp_790
named style

  • Field Details

    • translationKey

      private final String translationKey
      The field for the translationKey record component.

    • parameters

      private final List<Decoration.Parameter> parameters
      The field for the parameters record component.

    • style

      private final Style style
      The field for the style record component.

    • CODEC

      public static final com.mojang.serialization.Codec<Decoration> CODEC
      Mappings:
      Namespace Name Mixin selector
      official a Lst;a:Lcom/mojang/serialization/Codec;
      intermediary field_39219 Lnet/minecraft/class_7463;field_39219:Lcom/mojang/serialization/Codec;
      named CODEC Lnet/minecraft/text/Decoration;CODEC:Lcom/mojang/serialization/Codec;

  • Constructor Details

  • Method Details

    • ofChat

      public static Decoration ofChat(String translationKey)
      Returns the decoration used in chat messages.
      Returns:
      the decoration used in chat messages
      Implementation Note:
      This decoration allows using the sender and the content parameters. It has no style.
      Mappings:
      Namespace Name Mixin selector
      official a Lst;a(Ljava/lang/String;)Lst;
      intermediary method_43831 Lnet/minecraft/class_7463;method_43831(Ljava/lang/String;)Lnet/minecraft/class_7463;
      named ofChat Lnet/minecraft/text/Decoration;ofChat(Ljava/lang/String;)Lnet/minecraft/text/Decoration;

    • ofIncomingMessage

      public static Decoration ofIncomingMessage(String translationKey)
      Returns the decoration used in incoming messages sent with MessageCommand.
      Returns:
      the decoration used in incoming messages sent with MessageCommand
      Implementation Note:
      This decoration allows using the sender and the content parameters. It is italicized and colored gray.
      Mappings:
      Namespace Name Mixin selector
      official b Lst;b(Ljava/lang/String;)Lst;
      intermediary method_44779 Lnet/minecraft/class_7463;method_44779(Ljava/lang/String;)Lnet/minecraft/class_7463;
      named ofIncomingMessage Lnet/minecraft/text/Decoration;ofIncomingMessage(Ljava/lang/String;)Lnet/minecraft/text/Decoration;

    • ofOutgoingMessage

      public static Decoration ofOutgoingMessage(String translationKey)
      Returns the decoration used in outgoing messages sent with MessageCommand.
      Returns:
      the decoration used in outgoing messages sent with MessageCommand
      Implementation Note:
      This decoration allows using the target (recipient) and the content parameters. It is italicized and colored gray.
      Mappings:
      Namespace Name Mixin selector
      official c Lst;c(Ljava/lang/String;)Lst;
      intermediary method_44780 Lnet/minecraft/class_7463;method_44780(Ljava/lang/String;)Lnet/minecraft/class_7463;
      named ofOutgoingMessage Lnet/minecraft/text/Decoration;ofOutgoingMessage(Ljava/lang/String;)Lnet/minecraft/text/Decoration;

    • ofTeamMessage

      public static Decoration ofTeamMessage(String translationKey)
      Returns the decoration used in chat messages.
      Returns:
      the decoration used in chat messages
      Implementation Note:
      This decoration allows using the target (team name), the sender, and the content parameters. It has no style.
      Mappings:
      Namespace Name Mixin selector
      official d Lst;d(Ljava/lang/String;)Lst;
      intermediary method_43835 Lnet/minecraft/class_7463;method_43835(Ljava/lang/String;)Lnet/minecraft/class_7463;
      named ofTeamMessage Lnet/minecraft/text/Decoration;ofTeamMessage(Ljava/lang/String;)Lnet/minecraft/text/Decoration;

    • apply

      public Text apply(Text content, MessageType.Parameters params)
      Returns the text obtained by applying the passed values to the decoration.
      Parameters:
      content - the value of the content parameter
      Returns:
      the text obtained by applying the passed values to the decoration
      Mappings:
      Namespace Name Mixin selector
      official a Lst;a(Lsw;Lss$a;)Lsw;
      intermediary method_43832 Lnet/minecraft/class_7463;method_43832(Lnet/minecraft/class_2561;Lnet/minecraft/class_2556$class_7602;)Lnet/minecraft/class_2561;
      named apply Lnet/minecraft/text/Decoration;apply(Lnet/minecraft/text/Text;Lnet/minecraft/network/message/MessageType$Parameters;)Lnet/minecraft/text/Text;

    • collectArguments

      private Text[] collectArguments(Text content, MessageType.Parameters params)
      Returns the arguments passed to Text.translatable(String, Object[]).

      This is collected by supplying content and sender to the parameters' Decoration.Parameter.apply(net.minecraft.text.Text, net.minecraft.network.message.MessageType.Parameters) method.

      Returns:
      the arguments passed to Text.translatable(String, Object[])
      Mappings:
      Namespace Name Mixin selector
      official b Lst;b(Lsw;Lss$a;)[Lsw;
      intermediary method_43834 Lnet/minecraft/class_7463;method_43834(Lnet/minecraft/class_2561;Lnet/minecraft/class_2556$class_7602;)[Lnet/minecraft/class_2561;
      named collectArguments Lnet/minecraft/text/Decoration;collectArguments(Lnet/minecraft/text/Text;Lnet/minecraft/network/message/MessageType$Parameters;)[Lnet/minecraft/text/Text;

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object object)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      object - the object with which to compare
      Returns:
      true if this object is the same as the object argument; false otherwise.

    • translationKey

      public String translationKey()
      Returns the value of the translationKey record component.
      Returns:
      the value of the translationKey record component

    • parameters

      public List<Decoration.Parameter> parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component

    • style

      public Style style()
      Returns the value of the style record component.
      Returns:
      the value of the style record component