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

Class ScreenNarrator

java.lang.Object

net.minecraft.client.gui.screen.narration.ScreenNarrator

@Environment(CLIENT)
public class ScreenNarrator
extends Object

Manages narration messages and combines them into a narrated string.

Mappings:

Namespace	Name
named	net/minecraft/client/gui/screen/narration/ScreenNarrator
intermediary	net/minecraft/class_6385
official	fsf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ScreenNarrator.Message
private class	ScreenNarrator.MessageBuilder
private static class	ScreenNarrator.PartIndex

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	currentMessageIndex
(package private) final Map<ScreenNarrator.PartIndex,ScreenNarrator.Message>	narrations

Constructor Summary

Constructors

Constructor	Description
ScreenNarrator()

Method Summary

Modifier and Type	Method	Description
void	buildNarrations(Consumer<NarrationMessageBuilder> builderConsumer)	Creates the narration messages for the next narration using a NarrationMessageBuilder.
String	buildNarratorText(boolean includeUnchanged)	Builds a text representation of the narrations produced by the last call to buildNarrations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

currentMessageIndex

int currentMessageIndex

Mappings:

Namespace	Name	Mixin selector
named	currentMessageIndex	Lnet/minecraft/client/gui/screen/narration/ScreenNarrator;currentMessageIndex:I
intermediary	field_33796	Lnet/minecraft/class_6385;field_33796:I
official	a	Lfsf;a:I

narrations

final Map<ScreenNarrator.PartIndex,ScreenNarrator.Message> narrations

Mappings:

Namespace	Name	Mixin selector
named	narrations	Lnet/minecraft/client/gui/screen/narration/ScreenNarrator;narrations:Ljava/util/Map;
intermediary	field_33797	Lnet/minecraft/class_6385;field_33797:Ljava/util/Map;
official	b	Lfsf;b:Ljava/util/Map;

Constructor Details

ScreenNarrator

public ScreenNarrator()

Method Details

buildNarrations

public void buildNarrations(Consumer<NarrationMessageBuilder> builderConsumer)

Creates the narration messages for the next narration using a NarrationMessageBuilder.

Parameters:

builderConsumer - a consumer that adds the narrations to a NarrationMessageBuilder

Mappings:

Namespace	Name	Mixin selector
named	buildNarrations	Lnet/minecraft/client/gui/screen/narration/ScreenNarrator;buildNarrations(Ljava/util/function/Consumer;)V
intermediary	method_37044	Lnet/minecraft/class_6385;method_37044(Ljava/util/function/Consumer;)V
official	a	Lfsf;a(Ljava/util/function/Consumer;)V

buildNarratorText

public String buildNarratorText(boolean includeUnchanged)

Builds a text representation of the narrations produced by the last call to buildNarrations.

Parameters:

includeUnchanged - if true, the text will include unchanged messages that have already been included in the output of this method previously

Returns:

the created narrator text

Implementation Note:

Contains all sentences in the narrations of the current narration message separated by ". ", ordered as described in NarrationMessageBuilder.

Mappings:

Namespace	Name	Mixin selector
named	buildNarratorText	Lnet/minecraft/client/gui/screen/narration/ScreenNarrator;buildNarratorText(Z)Ljava/lang/String;
intermediary	method_37045	Lnet/minecraft/class_6385;method_37045(Z)Ljava/lang/String;
official	a	Lfsf;a(Z)Ljava/lang/String;