Package net.minecraft.client.gui.screens.inventory

Class BookViewScreen

java.lang.Object

net.minecraft.client.gui.components.events.AbstractContainerEventHandler

net.minecraft.client.gui.screens.Screen

net.minecraft.client.gui.screens.inventory.BookViewScreen

All Implemented Interfaces:

ContainerEventHandler, GuiEventListener, Renderable, TabOrderedElement

Direct Known Subclasses:

LecternScreen

public class BookViewScreen
extends Screen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BookViewScreen.BookAccess

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

Screen.NarratableSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
private PageButton	backButton
private static final int	BACKGROUND_TEXTURE_HEIGHT
private static final int	BACKGROUND_TEXTURE_WIDTH
static final ResourceLocation	BOOK_LOCATION
private BookViewScreen.BookAccess	bookAccess
private int	cachedPage
private List<FormattedCharSequence>	cachedPageComponents	Holds a copy of the page text, split into page width lines
private int	currentPage
static final BookViewScreen.BookAccess	EMPTY_ACCESS
private PageButton	forwardButton
protected static final int	IMAGE_HEIGHT
protected static final int	IMAGE_WIDTH
static final int	PAGE_INDICATOR_TEXT_Y_OFFSET
static final int	PAGE_TEXT_X_OFFSET
static final int	PAGE_TEXT_Y_OFFSET
private Component	pageMsg
private final boolean	playTurnSound	Determines if a sound is played when the page is turned
protected static final int	TEXT_HEIGHT
protected static final int	TEXT_WIDTH
private static final Component	TITLE

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

FADE_IN_TIME, font, FOOTER_SEPARATOR, HEADER_SEPARATOR, height, INWORLD_FOOTER_SEPARATOR, INWORLD_HEADER_SEPARATOR, MENU_BACKGROUND, minecraft, narratorButton, renderables, screenExecutor, title, width

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

DOUBLE_CLICK_THRESHOLD_MS

Constructor Summary

Constructors

Modifier	Constructor	Description
	BookViewScreen()
	BookViewScreen(BookViewScreen.BookAccess pBookAccess)
private	BookViewScreen(BookViewScreen.BookAccess pBookAccess, boolean pPlayTurnSound)

Method Summary

Modifier and Type	Method	Description
protected void	closeContainerOnServer()
protected void	createMenuControls()
protected void	createPageControlButtons()
protected boolean	forcePage(int pPageNum)	I'm not sure why this exists.
Style	getClickedComponentStyleAt(double pMouseX, double pMouseY)
Component	getNarrationMessage()
private int	getNumPages()
private Component	getPageNumberMessage()
protected void	handleClickEvent(Minecraft pMinecraft, ClickEvent pClickEvent)
protected void	init()
boolean	keyPressed(int pKeyCode, int pScanCode, int pModifiers)	Called when a keyboard key is pressed within the GUI element.
boolean	mouseClicked(double pMouseX, double pMouseY, int pButton)	Called when a mouse button is clicked within the GUI element.
protected void	pageBack()
protected void	pageForward()
void	render(GuiGraphics pGuiGraphics, int pMouseX, int pMouseY, float pPartialTick)	Renders the graphical user interface (GUI) element.
void	renderBackground(GuiGraphics pGuiGraphics, int pMouseX, int pMouseY, float pPartialTick)
void	setBookAccess(BookViewScreen.BookAccess pBookAccess)
boolean	setPage(int pPageNum)	Moves the book to the specified page and returns true if it exists, false otherwise.
private void	updateButtonVisibility()

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

added, addRenderableOnly, addRenderableWidget, addWidget, afterKeyboardAction, afterMouseAction, afterMouseMove, changeFocus, children, clearFocus, clearWidgets, clickCommandAction, clickUrlAction, defaultHandleClickEvent, defaultHandleGameClickEvent, fadeWidgets, fillCrashDetails, findNarratableWidget, getBackgroundMusic, getFont, getMinecraft, getRectangle, getTitle, getTooltipFromItem, getUsageNarration, handleComponentClicked, handleDelayedNarration, hasAltDown, hasControlDown, hasShiftDown, init, insertText, isCopy, isCut, isMouseOver, isPaste, isPauseScreen, isSelectAll, isValidCharacterForName, onClose, onFilesDrop, rebuildWidgets, removed, removeWidget, renderBlurredBackground, renderMenuBackground, renderMenuBackground, renderMenuBackgroundTexture, renderPanorama, renderTransparentBackground, renderWithTooltip, repositionElements, resize, setInitialFocus, setInitialFocus, shouldCloseOnEsc, shouldNarrateNavigation, showsActiveEffects, tick, triggerImmediateNarration, updateNarratedWidget, updateNarrationState, updateNarratorStatus

Methods inherited from class net.minecraft.client.gui.components.events.AbstractContainerEventHandler

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.components.events.ContainerEventHandler

charTyped, getChildAt, getCurrentFocusPath, isFocused, keyReleased, mouseDragged, mouseReleased, mouseScrolled, nextFocusPath, setFocused

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

getBorderForArrowNavigation, mouseMoved

Methods inherited from interface net.minecraft.client.gui.components.TabOrderedElement

getTabOrderGroup

Field Details

PAGE_INDICATOR_TEXT_Y_OFFSET

public static final int PAGE_INDICATOR_TEXT_Y_OFFSET

See Also:

• Constant Field Values

PAGE_TEXT_X_OFFSET

public static final int PAGE_TEXT_X_OFFSET

See Also:

• Constant Field Values

PAGE_TEXT_Y_OFFSET

public static final int PAGE_TEXT_Y_OFFSET

See Also:

• Constant Field Values

BACKGROUND_TEXTURE_WIDTH

private static final int BACKGROUND_TEXTURE_WIDTH

See Also:

• Constant Field Values

BACKGROUND_TEXTURE_HEIGHT

private static final int BACKGROUND_TEXTURE_HEIGHT

See Also:

• Constant Field Values

TITLE

private static final Component TITLE

EMPTY_ACCESS

public static final BookViewScreen.BookAccess EMPTY_ACCESS

BOOK_LOCATION

public static final ResourceLocation BOOK_LOCATION

TEXT_WIDTH

protected static final int TEXT_WIDTH

See Also:

• Constant Field Values

TEXT_HEIGHT

protected static final int TEXT_HEIGHT

See Also:

• Constant Field Values

IMAGE_WIDTH

protected static final int IMAGE_WIDTH

See Also:

• Constant Field Values

IMAGE_HEIGHT

protected static final int IMAGE_HEIGHT

See Also:

• Constant Field Values

bookAccess

private BookViewScreen.BookAccess bookAccess

currentPage

private int currentPage

cachedPageComponents

private List<FormattedCharSequence> cachedPageComponents

Holds a copy of the page text, split into page width lines

cachedPage

private int cachedPage

pageMsg

private Component pageMsg

forwardButton

private PageButton forwardButton

backButton

private PageButton backButton

playTurnSound

private final boolean playTurnSound

Determines if a sound is played when the page is turned

Constructor Details

BookViewScreen

public BookViewScreen(BookViewScreen.BookAccess pBookAccess)

BookViewScreen

public BookViewScreen()

BookViewScreen

private BookViewScreen(BookViewScreen.BookAccess pBookAccess,
 boolean pPlayTurnSound)

Method Details

setBookAccess

public void setBookAccess(BookViewScreen.BookAccess pBookAccess)

setPage

public boolean setPage(int pPageNum)

Moves the book to the specified page and returns true if it exists, false otherwise.

forcePage

protected boolean forcePage(int pPageNum)

I'm not sure why this exists. The function it calls is public and does all the work.

init

protected void init()

Overrides:

init in class Screen

getNarrationMessage

public Component getNarrationMessage()

Overrides:

getNarrationMessage in class Screen

getPageNumberMessage

private Component getPageNumberMessage()

createMenuControls

protected void createMenuControls()

createPageControlButtons

protected void createPageControlButtons()

getNumPages

private int getNumPages()

pageBack

protected void pageBack()

pageForward

protected void pageForward()

updateButtonVisibility

private void updateButtonVisibility()

keyPressed

public boolean keyPressed(int pKeyCode,
 int pScanCode,
 int pModifiers)

Called when a keyboard key is pressed within the GUI element.

Specified by:

keyPressed in interface ContainerEventHandler

Specified by:

keyPressed in interface GuiEventListener

Overrides:

keyPressed in class Screen

Parameters:

pKeyCode - the key code of the pressed key.

pScanCode - the scan code of the pressed key.

pModifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

render

public void render(GuiGraphics pGuiGraphics,
 int pMouseX,
 int pMouseY,
 float pPartialTick)

Renders the graphical user interface (GUI) element.

Specified by:

render in interface Renderable

Overrides:

render in class Screen

Parameters:

pGuiGraphics - the GuiGraphics object used for rendering.

pMouseX - the x-coordinate of the mouse cursor.

pMouseY - the y-coordinate of the mouse cursor.

pPartialTick - the partial tick time.

renderBackground

public void renderBackground(GuiGraphics pGuiGraphics,
 int pMouseX,
 int pMouseY,
 float pPartialTick)

Overrides:

renderBackground in class Screen

mouseClicked

public boolean mouseClicked(double pMouseX,
 double pMouseY,
 int pButton)

Called when a mouse button is clicked within the GUI element.

Parameters:

pMouseX - the X coordinate of the mouse.

pMouseY - the Y coordinate of the mouse.

pButton - the button that was clicked.

Returns:

true if the event is consumed, false otherwise.

handleClickEvent

protected void handleClickEvent(Minecraft pMinecraft,
 ClickEvent pClickEvent)

Overrides:

handleClickEvent in class Screen

closeContainerOnServer

protected void closeContainerOnServer()

getClickedComponentStyleAt

@Nullable
public Style getClickedComponentStyleAt(double pMouseX,
 double pMouseY)