Package net.minecraft.client.gui.screen

Class TaskScreen

java.lang.Object

net.minecraft.client.gui.AbstractParentElement

net.minecraft.client.gui.screen.Screen

net.minecraft.client.gui.screen.TaskScreen

All Implemented Interfaces:

Drawable, Element, Navigable, ParentElement

@Environment(CLIENT)
public class TaskScreen
extends Screen

A screen that is used for indicating that a task is running or has finished running (either successfully or unsuccessfully). The screen has an optional multi-line description and a button which can be used to close the screen. The button can have a cooldown, which disables the button for a while after the screen is displayed.

Mappings:

Namespace	Name
official	exr
intermediary	net/minecraft/class_7534
named	net/minecraft/client/gui/screen/TaskScreen

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.client.gui.screen.Screen

Screen.SelectedElementNarrationData

Field Summary

Fields

Modifier and Type	Field	Description
private ButtonWidget	button	The button to close the screen (potentially with a side effect, such as cancelling a task).
private int	buttonCooldown	How long the button should be disabled after the screen is displayed in ticks.
private final Text	closeButtonText
private final Runnable	closeCallback	The callback executed when the button or the Esc key is pressed.
private @Nullable MultilineText	description
private static final int	DESCRIPTION_TEXT_WIDTH
private static final int	DESCRIPTION_TEXT_Y
private final @Nullable Text	descriptionText
private static final int	TITLE_TEXT_Y

Fields inherited from class net.minecraft.client.gui.screen.Screen

client, executor, height, OPTIONS_BACKGROUND_TEXTURE, textRenderer, title, width

Fields inherited from interface net.minecraft.client.gui.Element

MAX_DOUBLE_CLICK_INTERVAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskScreen(Text title, @Nullable Text descriptionText, Text closeButtonText, Runnable closeCallback, int buttonCooldown)

Method Summary

Modifier and Type	Method	Description
void	close()
static TaskScreen	createResultScreen(Text title, Text descriptionText, Text closeButtonText, Runnable closeCallback)	Returns a new screen to indicate a task has finished running.
static TaskScreen	createRunningScreen(Text title, Text closeButtonText, Runnable closeCallback)	Returns a new screen to indicate a task is running.
Text	getNarratedTitle()
protected void	init()	Called when a screen should be initialized.
void	render(DrawContext context, int mouseX, int mouseY, float delta)
boolean	shouldCloseOnEsc()	Checks whether this screen should be closed when the escape key is pressed.
void	tick()

Methods inherited from class net.minecraft.client.gui.screen.Screen

addDrawable, addDrawableChild, addElementNarrations, addScreenNarrations, addSelectableChild, applyKeyPressNarratorDelay, applyMouseMoveNarratorDelay, applyMousePressScrollNarratorDelay, applyNarratorModeChangeDelay, children, clearAndInit, clearChildren, filesDragged, findSelectedElementData, getMusic, getNavigationFocus, getTitle, getTooltipFromItem, getUsageNarrationText, handleTextClick, hasAltDown, hasControlDown, hasShiftDown, hasUsageText, hide, init, initTabNavigation, insertText, isCopy, isCut, isMouseOver, isPaste, isSelectAll, isValidCharacterForName, keyPressed, narrateScreenIfNarrationEnabled, onDisplayed, remove, removed, renderBackground, renderBackgroundTexture, renderInGameBackground, renderWithTooltip, resize, setInitialFocus, setTooltip, setTooltip, setTooltip, setTooltip, shouldPause, switchFocus, updateNarrator, wrapScreenError

Methods inherited from class net.minecraft.client.gui.AbstractParentElement

getFocused, isDragging, setDragging, setFocused

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.client.gui.Element

mouseMoved

Methods inherited from interface net.minecraft.client.gui.navigation.Navigable

getNavigationOrder

Methods inherited from interface net.minecraft.client.gui.ParentElement

charTyped, focusOn, getFocusedPath, getNavigationPath, hoveredElement, isFocused, keyReleased, mouseClicked, mouseDragged, mouseReleased, mouseScrolled, setFocused

Field Details

TITLE_TEXT_Y

private static final int TITLE_TEXT_Y

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	a	Lexr;a:I
intermediary	field_39541	Lnet/minecraft/class_7534;field_39541:I
named	TITLE_TEXT_Y	Lnet/minecraft/client/gui/screen/TaskScreen;TITLE_TEXT_Y:I

DESCRIPTION_TEXT_Y

private static final int DESCRIPTION_TEXT_Y

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lexr;b:I
intermediary	field_39542	Lnet/minecraft/class_7534;field_39542:I
named	DESCRIPTION_TEXT_Y	Lnet/minecraft/client/gui/screen/TaskScreen;DESCRIPTION_TEXT_Y:I

DESCRIPTION_TEXT_WIDTH

private static final int DESCRIPTION_TEXT_WIDTH

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	c	Lexr;c:I
intermediary	field_39543	Lnet/minecraft/class_7534;field_39543:I
named	DESCRIPTION_TEXT_WIDTH	Lnet/minecraft/client/gui/screen/TaskScreen;DESCRIPTION_TEXT_WIDTH:I

descriptionText

@Nullable
private final @Nullable Text descriptionText

Mappings:

Namespace	Name	Mixin selector
official	k	Lexr;k:Ltl;
intermediary	field_39745	Lnet/minecraft/class_7534;field_39745:Lnet/minecraft/class_2561;
named	descriptionText	Lnet/minecraft/client/gui/screen/TaskScreen;descriptionText:Lnet/minecraft/text/Text;

closeButtonText

private final Text closeButtonText

Mappings:

Namespace	Name	Mixin selector
official	l	Lexr;l:Ltl;
intermediary	field_39544	Lnet/minecraft/class_7534;field_39544:Lnet/minecraft/class_2561;
named	closeButtonText	Lnet/minecraft/client/gui/screen/TaskScreen;closeButtonText:Lnet/minecraft/text/Text;

closeCallback

private final Runnable closeCallback

The callback executed when the button or the Esc key is pressed. This can have a side effect, such as cancelling a task in progress.

Mappings:

Namespace	Name	Mixin selector
official	m	Lexr;m:Ljava/lang/Runnable;
intermediary	field_39545	Lnet/minecraft/class_7534;field_39545:Ljava/lang/Runnable;
named	closeCallback	Lnet/minecraft/client/gui/screen/TaskScreen;closeCallback:Ljava/lang/Runnable;

description

@Nullable
private @Nullable MultilineText description

Mappings:

Namespace	Name	Mixin selector
official	n	Lexr;n:Letj;
intermediary	field_39546	Lnet/minecraft/class_7534;field_39546:Lnet/minecraft/class_5489;
named	description	Lnet/minecraft/client/gui/screen/TaskScreen;description:Lnet/minecraft/client/font/MultilineText;

button

private ButtonWidget button

The button to close the screen (potentially with a side effect, such as cancelling a task).

Mappings:

Namespace	Name	Mixin selector
official	o	Lexr;o:Lesq;
intermediary	field_39547	Lnet/minecraft/class_7534;field_39547:Lnet/minecraft/class_4185;
named	button	Lnet/minecraft/client/gui/screen/TaskScreen;button:Lnet/minecraft/client/gui/widget/ButtonWidget;

buttonCooldown

private int buttonCooldown

How long the button should be disabled after the screen is displayed in ticks. Can be disabled by setting to 0.

Mappings:

Namespace	Name	Mixin selector
official	p	Lexr;p:I
intermediary	field_39746	Lnet/minecraft/class_7534;field_39746:I
named	buttonCooldown	Lnet/minecraft/client/gui/screen/TaskScreen;buttonCooldown:I

Constructor Details

TaskScreen

protected TaskScreen(Text title,
 @Nullable
 @Nullable Text descriptionText,
 Text closeButtonText,
 Runnable closeCallback,
 int buttonCooldown)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lexr;<init>(Ltl;Ltl;Ltl;Ljava/lang/Runnable;I)V
intermediary	<init>	Lnet/minecraft/class_7534;<init>(Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;Ljava/lang/Runnable;I)V
named	<init>	Lnet/minecraft/client/gui/screen/TaskScreen;<init>(Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;Ljava/lang/Runnable;I)V

Method Details

createRunningScreen

public static TaskScreen createRunningScreen(Text title,
 Text closeButtonText,
 Runnable closeCallback)

Returns a new screen to indicate a task is running.

The screen has no description or button cooldown.

Returns:

a new screen to indicate a task is running

Mappings:

Namespace	Name	Mixin selector
official	a	Lexr;a(Ltl;Ltl;Ljava/lang/Runnable;)Lexr;
intermediary	method_44690	Lnet/minecraft/class_7534;method_44690(Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;Ljava/lang/Runnable;)Lnet/minecraft/class_7534;
named	createRunningScreen	Lnet/minecraft/client/gui/screen/TaskScreen;createRunningScreen(Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;Ljava/lang/Runnable;)Lnet/minecraft/client/gui/screen/TaskScreen;

createResultScreen

public static TaskScreen createResultScreen(Text title,
 Text descriptionText,
 Text closeButtonText,
 Runnable closeCallback)

Returns a new screen to indicate a task has finished running.

The screen has a button cooldown of 20 ticks (1 second).

Returns:

a new screen to indicate a task has finished running

Mappings:

Namespace	Name	Mixin selector
official	a	Lexr;a(Ltl;Ltl;Ltl;Ljava/lang/Runnable;)Lexr;
intermediary	method_44691	Lnet/minecraft/class_7534;method_44691(Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;Ljava/lang/Runnable;)Lnet/minecraft/class_7534;
named	createResultScreen	Lnet/minecraft/client/gui/screen/TaskScreen;createResultScreen(Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;Ljava/lang/Runnable;)Lnet/minecraft/client/gui/screen/TaskScreen;

init

protected void init()

Called when a screen should be initialized.

This method is called when this screen is opened or resized.

This should call Screen.setInitialFocus(net.minecraft.client.gui.Element) to set the element that is initially focused.

Overrides:

init in class Screen

Mappings:

Namespace	Name	Mixin selector
official	aH_	Leyk;aH_()V
intermediary	method_25426	Lnet/minecraft/class_437;method_25426()V
named	init	Lnet/minecraft/client/gui/screen/Screen;init()V

tick

public void tick()

Overrides:

tick in class Screen

Mappings:

Namespace	Name	Mixin selector
official	c	Leyk;c()V
intermediary	method_25393	Lnet/minecraft/class_437;method_25393()V
named	tick	Lnet/minecraft/client/gui/screen/Screen;tick()V

render

public void render(DrawContext context,
 int mouseX,
 int mouseY,
 float delta)

Specified by:

render in interface Drawable

Overrides:

render in class Screen

Mappings:

Namespace	Name	Mixin selector
official	a	Lets;a(Lesf;IIF)V
intermediary	method_25394	Lnet/minecraft/class_4068;method_25394(Lnet/minecraft/class_332;IIF)V
named	render	Lnet/minecraft/client/gui/Drawable;render(Lnet/minecraft/client/gui/DrawContext;IIF)V

shouldCloseOnEsc

public boolean shouldCloseOnEsc()

Checks whether this screen should be closed when the escape key is pressed.

Overrides:

shouldCloseOnEsc in class Screen

Mappings:

Namespace	Name	Mixin selector
official	ay_	Leyk;ay_()Z
intermediary	method_25422	Lnet/minecraft/class_437;method_25422()Z
named	shouldCloseOnEsc	Lnet/minecraft/client/gui/screen/Screen;shouldCloseOnEsc()Z

close

public void close()

Overrides:

close in class Screen

Mappings:

Namespace	Name	Mixin selector
official	az_	Leyk;az_()V
intermediary	method_25419	Lnet/minecraft/class_437;method_25419()V
named	close	Lnet/minecraft/client/gui/screen/Screen;close()V

getNarratedTitle

public Text getNarratedTitle()

Overrides:

getNarratedTitle in class Screen

Mappings:

Namespace	Name	Mixin selector
official	g	Leyk;g()Ltl;
intermediary	method_25435	Lnet/minecraft/class_437;method_25435()Lnet/minecraft/class_2561;
named	getNarratedTitle	Lnet/minecraft/client/gui/screen/Screen;getNarratedTitle()Lnet/minecraft/text/Text;