de.ellpeck.actuallyadditions.api.booklet

Class BookletPage

java.lang.Object

de.ellpeck.actuallyadditions.api.booklet.BookletPage

public abstract class BookletPage
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	arePageStacksWildcard
protected IBookletChapter	chapter
protected boolean	hasNoText
protected java.util.HashMap<java.lang.String,java.lang.String>	textReplacements

Constructor Summary

Constructors

Constructor and Description
BookletPage()

Method Summary

Modifier and Type	Method and Description
BookletPage	addTextReplacement(java.lang.String text, int replacement)
BookletPage	addTextReplacement(java.lang.String text, java.lang.String replacement)
IBookletChapter	getChapter()
abstract java.lang.String	getClickToSeeRecipeString() Gets the text that is displayed when an Item is hovered over that can be clicked on to go to its page
abstract int	getID() The ID of the page, for the page number etc.
abstract net.minecraft.item.ItemStack[]	getItemStacksForPage() Gets the ItemStacks that are part of or displayed on this page (for NEI Handler, right-click function etc.)
abstract java.lang.String	getText() Gets the localized text to be displayed
boolean	onActionPerformed(IBookletGui gui, net.minecraft.client.gui.GuiButton button)
void	onClosed(IBookletGui gui)
void	onOpened(IBookletGui gui)
abstract void	render(IBookletGui gui, int mouseX, int mouseY, int ticksElapsed, boolean mousePressed) This render method ica called after super.drawScreen() is called in the GUI
abstract void	renderPre(IBookletGui gui, int mouseX, int mouseY, int ticksElapsed, boolean mousePressed) This render method ica called before super.drawScreen() is called in the GUI
void	setChapter(IBookletChapter chapter)
BookletPage	setNoText()
BookletPage	setPageStacksWildcard() Sets the stacks on the page to be wildcard, meaning the metadata doesn't matter This applies for all stacks at once
abstract void	updateScreen(int ticksElapsed) Equivalent to updateScreen() in GuiScreen

Methods inherited from class java.lang.Object

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

Field Detail

arePageStacksWildcard

public boolean arePageStacksWildcard

chapter

protected IBookletChapter chapter

textReplacements

protected final java.util.HashMap<java.lang.String,java.lang.String> textReplacements

hasNoText

protected boolean hasNoText

Constructor Detail

BookletPage

public BookletPage()

Method Detail

onOpened

public void onOpened(IBookletGui gui)

onClosed

public void onClosed(IBookletGui gui)

onActionPerformed

public boolean onActionPerformed(IBookletGui gui,
                                 net.minecraft.client.gui.GuiButton button)

getID

public abstract int getID()

The ID of the page, for the page number etc. Don't make two pages in the same chapter with the same ID.

getText

public abstract java.lang.String getText()

Gets the localized text to be displayed

renderPre

public abstract void renderPre(IBookletGui gui,
                               int mouseX,
                               int mouseY,
                               int ticksElapsed,
                               boolean mousePressed)

This render method ica called before super.drawScreen() is called in the GUI

render

public abstract void render(IBookletGui gui,
                            int mouseX,
                            int mouseY,
                            int ticksElapsed,
                            boolean mousePressed)

This render method ica called after super.drawScreen() is called in the GUI

updateScreen

public abstract void updateScreen(int ticksElapsed)

Equivalent to updateScreen() in GuiScreen

getItemStacksForPage

public abstract net.minecraft.item.ItemStack[] getItemStacksForPage()

Gets the ItemStacks that are part of or displayed on this page (for NEI Handler, right-click function etc.)

getClickToSeeRecipeString

public abstract java.lang.String getClickToSeeRecipeString()

Gets the text that is displayed when an Item is hovered over that can be clicked on to go to its page

getChapter

public IBookletChapter getChapter()

setChapter

public void setChapter(IBookletChapter chapter)

setPageStacksWildcard

public BookletPage setPageStacksWildcard()

Sets the stacks on the page to be wildcard, meaning the metadata doesn't matter This applies for all stacks at once

setNoText

public BookletPage setNoText()

addTextReplacement

public BookletPage addTextReplacement(java.lang.String text,
                                      int replacement)

addTextReplacement

public BookletPage addTextReplacement(java.lang.String text,
                                      java.lang.String replacement)