Package net.minecraft.client.gui.screen.narration

Class Narration<T>

java.lang.Object
net.minecraft.client.gui.screen.narration.Narration<T>
@Environment(CLIENT) public class Narration<T> extends Object
A narration is a message consisting of a list of string "sentences". The sentences can be iterated using forEachSentence.

Narrations are attached to narration parts using NarrationMessageBuilder.put(NarrationPart, Narration).

Mappings:
Namespace Name
official esc
intermediary net/minecraft/class_6384
named net/minecraft/client/gui/screen/narration/Narration

  • Field Details

    • EMPTY

      public static final Narration<?> EMPTY
      An empty narration that contains no sentences.
      Mappings:
      Namespace Name Mixin selector
      official a Lesc;a:Lesc;
      intermediary field_33793 Lnet/minecraft/class_6384;field_33793:Lnet/minecraft/class_6384;
      named EMPTY Lnet/minecraft/client/gui/screen/narration/Narration;EMPTY:Lnet/minecraft/client/gui/screen/narration/Narration;

    • value

      private final T value
      Mappings:
      Namespace Name Mixin selector
      official b Lesc;b:Ljava/lang/Object;
      intermediary field_33794 Lnet/minecraft/class_6384;field_33794:Ljava/lang/Object;
      named value Lnet/minecraft/client/gui/screen/narration/Narration;value:Ljava/lang/Object;

    • transformer

      private final BiConsumer<Consumer<String>,T> transformer
      Mappings:
      Namespace Name Mixin selector
      official c Lesc;c:Ljava/util/function/BiConsumer;
      intermediary field_33795 Lnet/minecraft/class_6384;field_33795:Ljava/util/function/BiConsumer;
      named transformer Lnet/minecraft/client/gui/screen/narration/Narration;transformer:Ljava/util/function/BiConsumer;

  • Constructor Details

    • Narration

      private Narration(T value, BiConsumer<Consumer<String>,T> transformer)
      Mappings:
      Namespace Name Mixin selector
      official <init> Lesc;<init>(Ljava/lang/Object;Ljava/util/function/BiConsumer;)V
      intermediary <init> Lnet/minecraft/class_6384;<init>(Ljava/lang/Object;Ljava/util/function/BiConsumer;)V
      named <init> Lnet/minecraft/client/gui/screen/narration/Narration;<init>(Ljava/lang/Object;Ljava/util/function/BiConsumer;)V

  • Method Details

    • string

      public static Narration<?> string(String string)
      Creates a narration from a single string sentence.
      Parameters:
      string - the narrated sentence
      Returns:
      the created narration
      Mappings:
      Namespace Name Mixin selector
      official a Lesc;a(Ljava/lang/String;)Lesc;
      intermediary method_37036 Lnet/minecraft/class_6384;method_37036(Ljava/lang/String;)Lnet/minecraft/class_6384;
      named string Lnet/minecraft/client/gui/screen/narration/Narration;string(Ljava/lang/String;)Lnet/minecraft/client/gui/screen/narration/Narration;

    • text

      public static Narration<?> text(Text text)
      Creates a narration from a single Text sentence.
      Parameters:
      text - the narrated sentence
      Returns:
      the created narration
      Implementation Requirements:
      The sentence is converted to a string using Text.getString().
      Mappings:
      Namespace Name Mixin selector
      official a Lesc;a(Lsw;)Lesc;
      intermediary method_37042 Lnet/minecraft/class_6384;method_37042(Lnet/minecraft/class_2561;)Lnet/minecraft/class_6384;
      named text Lnet/minecraft/client/gui/screen/narration/Narration;text(Lnet/minecraft/text/Text;)Lnet/minecraft/client/gui/screen/narration/Narration;

    • texts

      public static Narration<?> texts(List<Text> texts)
      Creates a narration from a list of Text sentences.
      Parameters:
      texts - the narrated sentences
      Returns:
      the created narration
      Implementation Requirements:
      The sentences are converted to strings using Text.getString().
      Mappings:
      Namespace Name Mixin selector
      official a Lesc;a(Ljava/util/List;)Lesc;
      intermediary method_37037 Lnet/minecraft/class_6384;method_37037(Ljava/util/List;)Lnet/minecraft/class_6384;
      named texts Lnet/minecraft/client/gui/screen/narration/Narration;texts(Ljava/util/List;)Lnet/minecraft/client/gui/screen/narration/Narration;

    • forEachSentence

      public void forEachSentence(Consumer<String> consumer)
      Iterates all sentences in this narration with a Consumer.
      Parameters:
      consumer - the consumer to accept all sentences in this narration
      Mappings:
      Namespace Name Mixin selector
      official a Lesc;a(Ljava/util/function/Consumer;)V
      intermediary method_37039 Lnet/minecraft/class_6384;method_37039(Ljava/util/function/Consumer;)V
      named forEachSentence Lnet/minecraft/client/gui/screen/narration/Narration;forEachSentence(Ljava/util/function/Consumer;)V

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
      Mappings:
      Namespace Name Mixin selector
      official equals Lesc;equals(Ljava/lang/Object;)Z
      intermediary equals Lnet/minecraft/class_6384;equals(Ljava/lang/Object;)Z
      named equals Lnet/minecraft/client/gui/screen/narration/Narration;equals(Ljava/lang/Object;)Z

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object