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

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

Fields inherited from class net.minecraft.client.gui.screens.Screen
CUBE_MAP, font, FOOTER_SEPARATOR, HEADER_SEPARATOR, height, INWORLD_FOOTER_SEPARATOR, INWORLD_HEADER_SEPARATOR, MENU_BACKGROUND, minecraft, narratorButton, PANORAMA, 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 bookAccess)

private

BookViewScreen(BookViewScreen.BookAccess bookAccess, boolean playTurnSound)
Method Summary

Modifier and Type

Method

Description

protected void

closeScreen()

protected void

createMenuControls()

protected void

createPageControlButtons()

protected boolean

forcePage(int pageNum)

I'm not sure why this exists.

Style

getClickedComponentStyleAt(double mouseX, double mouseY)

private int

getNumPages()

boolean

handleComponentClicked(Style style)

protected void

init()

boolean

keyPressed(int keyCode, int scanCode, int modifiers)

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

boolean

mouseClicked(double mouseX, double mouseY, int button)

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

protected void

pageBack()

protected void

pageForward()

void

render(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)

Renders the graphical user interface (GUI) element.

void

renderBackground(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)

void

setBookAccess(BookViewScreen.BookAccess bookAccess)

boolean

setPage(int pageNum)

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, clearTooltipForNextRenderPass, clearWidgets, findNarratableWidget, getBackgroundMusic, getMinecraft, getNarrationMessage, getRectangle, getTitle, getTooltipFromItem, getUsageNarration, 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, setTooltipForNextRenderPass, setTooltipForNextRenderPass, setTooltipForNextRenderPass, setTooltipForNextRenderPass, shouldCloseOnEsc, shouldNarrateNavigation, tick, triggerImmediateNarration, updateNarratedWidget, updateNarrationState, updateNarratorStatus, wrapScreenError

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
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
- 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 bookAccess)
- BookViewScreen
  
  public BookViewScreen()
- BookViewScreen
  
  private BookViewScreen(BookViewScreen.BookAccess bookAccess, boolean playTurnSound)
Method Details
- setBookAccess
  
  public void setBookAccess(BookViewScreen.BookAccess bookAccess)
- setPage
  
  public boolean setPage(int pageNum)
  
  Moves the book to the specified page and returns true if it exists, false otherwise.
- forcePage
  
  protected boolean forcePage(int pageNum)
  
  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
- 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 keyCode, int scanCode, int modifiers)
  
  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:
  
  keyCode - the key code of the pressed key.
  
  scanCode - the scan code of the pressed key.
  
  modifiers - the keyboard modifiers.
  
  Returns:
  
  true if the event is consumed, false otherwise.
- render
  
  public void render(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
  
  Renders the graphical user interface (GUI) element.
  
  Specified by:
  
  render in interface Renderable
  
  Overrides:
  
  render in class Screen
  
  Parameters:
  
  guiGraphics - the GuiGraphics object used for rendering.
  
  mouseX - the x-coordinate of the mouse cursor.
  
  mouseY - the y-coordinate of the mouse cursor.
  
  partialTick - the partial tick time.
- renderBackground
  
  public void renderBackground(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
  
  Overrides:
  
  renderBackground in class Screen
- mouseClicked
  
  public boolean mouseClicked(double mouseX, double mouseY, int button)
  
  Called when a mouse button is clicked within the GUI element.
  
  Parameters:
  
  mouseX - the X coordinate of the mouse.
  
  mouseY - the Y coordinate of the mouse.
  
  button - the button that was clicked.
  
  Returns:
  
  true if the event is consumed, false otherwise.
- handleComponentClicked
  
  public boolean handleComponentClicked(Style style)
  
  Overrides:
  
  handleComponentClicked in class Screen
- closeScreen
  
  protected void closeScreen()
- getClickedComponentStyleAt
  
  @Nullable public Style getClickedComponentStyleAt(double mouseX, double mouseY)

Class BookViewScreen

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Details

PAGE_INDICATOR_TEXT_Y_OFFSET

PAGE_TEXT_X_OFFSET

PAGE_TEXT_Y_OFFSET

EMPTY_ACCESS

BOOK_LOCATION

TEXT_WIDTH

TEXT_HEIGHT

IMAGE_WIDTH

IMAGE_HEIGHT

bookAccess

currentPage

cachedPageComponents

cachedPage

pageMsg

forwardButton

backButton

playTurnSound

Constructor Details

BookViewScreen

BookViewScreen

BookViewScreen

Method Details

setBookAccess

setPage

forcePage

init

createMenuControls

createPageControlButtons

getNumPages

pageBack

pageForward

updateButtonVisibility

keyPressed

render

renderBackground

mouseClicked

handleComponentClicked

closeScreen

getClickedComponentStyleAt