net.minecraft.client.gui.inventory

Class GuiContainer

java.lang.Object

net.minecraft.client.gui.Gui

net.minecraft.client.gui.GuiScreen

net.minecraft.client.gui.inventory.GuiContainer

All Implemented Interfaces:

GuiYesNoCallback

Direct Known Subclasses:

GuiBeacon, GuiBrewingStand, GuiChest, GuiCrafting, GuiDispenser, GuiEnchantment, GuiFurnace, GuiHopper, GuiMerchant, GuiRepair, GuiScreenHorseInventory, GuiShulkerBox, InventoryEffectRenderer

public abstract class GuiContainer
extends GuiScreen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dragSplitting
protected java.util.Set<Slot>	dragSplittingSlots
protected int	guiLeft Starting X position for the Gui.
protected int	guiTop Starting Y position for the Gui.
static ResourceLocation	INVENTORY_BACKGROUND The location of the inventory background texture
Container	inventorySlots A list of the players inventory slots
protected int	xSize The X size of the inventory window in pixels.
protected int	ySize The Y size of the inventory window in pixels.

Fields inherited from class net.minecraft.client.gui.GuiScreen

allowUserInput, buttonList, fontRendererObj, height, itemRender, keyHandled, labelList, mc, mouseHandled, width

Fields inherited from class net.minecraft.client.gui.Gui

ICONS, OPTIONS_BACKGROUND, STAT_ICONS, zLevel

Constructor Summary

Constructors

Constructor and Description
GuiContainer(Container inventorySlotsIn)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkHotbarKeys(int keyCode) Checks whether a hotbar key (to swap the hovered item with an item in the hotbar) has been pressed.
boolean	doesGuiPauseGame() Returns true if this GUI should pause the game when it is displayed in single-player
protected abstract void	drawGuiContainerBackgroundLayer(float partialTicks, int mouseX, int mouseY) Draws the background layer of this container (behind the items).
protected void	drawGuiContainerForegroundLayer(int mouseX, int mouseY) Draw the foreground layer for the GuiContainer (everything in front of the items)
void	drawScreen(int mouseX, int mouseY, float partialTicks) Draws the screen and all the components in it.
int	getGuiLeft()
int	getGuiTop()
Slot	getSlotUnderMouse() Returns the slot that is currently displayed under the mouse.
int	getXSize()
int	getYSize()
protected void	handleMouseClick(Slot slotIn, int slotId, int mouseButton, ClickType type) Called when the mouse is clicked over a slot or outside the gui.
void	initGui() Adds the buttons (and other controls) to the screen in question.
protected boolean	isPointInRegion(int rectX, int rectY, int rectWidth, int rectHeight, int pointX, int pointY) Test if the 2D point is in a rectangle (relative to the GUI).
protected void	keyTyped(char typedChar, int keyCode) Fired when a key is typed (except F11 which toggles full screen).
protected void	mouseClicked(int mouseX, int mouseY, int mouseButton) Called when the mouse is clicked.
protected void	mouseClickMove(int mouseX, int mouseY, int clickedMouseButton, long timeSinceLastClick) Called when a mouse button is pressed and the mouse is moved around.
protected void	mouseReleased(int mouseX, int mouseY, int state) Called when a mouse button is released.
void	onGuiClosed() Called when the screen is unloaded.
void	updateScreen() Called from the main game loop to update the screen.

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

actionPerformed, addButton, confirmClicked, drawBackground, drawCreativeTabHoveringText, drawDefaultBackground, drawHoveringText, drawHoveringText, drawWorldBackground, getClipboardString, handleComponentClick, handleComponentHover, handleInput, handleKeyboardInput, handleMouseInput, isAltKeyDown, isCtrlKeyDown, isKeyComboCtrlA, isKeyComboCtrlC, isKeyComboCtrlV, isKeyComboCtrlX, isShiftKeyDown, onResize, renderToolTip, sendChatMessage, sendChatMessage, setClipboardString, setGuiSize, setText, setWorldAndResolution

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

drawCenteredString, drawGradientRect, drawHorizontalLine, drawModalRectWithCustomSizedTexture, drawRect, drawScaledCustomSizeModalRect, drawString, drawTexturedModalRect, drawTexturedModalRect, drawTexturedModalRect, drawVerticalLine

Methods inherited from class java.lang.Object

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

Field Detail

INVENTORY_BACKGROUND

public static final ResourceLocation INVENTORY_BACKGROUND

The location of the inventory background texture

xSize

protected int xSize

The X size of the inventory window in pixels.

ySize

protected int ySize

The Y size of the inventory window in pixels.

inventorySlots

public Container inventorySlots

A list of the players inventory slots

guiLeft

protected int guiLeft

Starting X position for the Gui. Inconsistent use for Gui backgrounds.

guiTop

protected int guiTop

Starting Y position for the Gui. Inconsistent use for Gui backgrounds.

dragSplittingSlots

protected final java.util.Set<Slot> dragSplittingSlots

dragSplitting

protected boolean dragSplitting

Constructor Detail

GuiContainer

public GuiContainer(Container inventorySlotsIn)

Method Detail

initGui

public void initGui()

Adds the buttons (and other controls) to the screen in question. Called when the GUI is displayed and when the window resizes, the buttonList is cleared beforehand.

Overrides:

initGui in class GuiScreen

drawScreen

public void drawScreen(int mouseX,
                       int mouseY,
                       float partialTicks)

Draws the screen and all the components in it.

Overrides:

drawScreen in class GuiScreen

drawGuiContainerForegroundLayer

protected void drawGuiContainerForegroundLayer(int mouseX,
                                               int mouseY)

Draw the foreground layer for the GuiContainer (everything in front of the items)

drawGuiContainerBackgroundLayer

protected abstract void drawGuiContainerBackgroundLayer(float partialTicks,
                                                        int mouseX,
                                                        int mouseY)

Draws the background layer of this container (behind the items).

mouseClicked

protected void mouseClicked(int mouseX,
                            int mouseY,
                            int mouseButton)
                     throws java.io.IOException

Called when the mouse is clicked. Args : mouseX, mouseY, clickedButton

Overrides:

mouseClicked in class GuiScreen

Throws:

java.io.IOException

mouseClickMove

protected void mouseClickMove(int mouseX,
                              int mouseY,
                              int clickedMouseButton,
                              long timeSinceLastClick)

Called when a mouse button is pressed and the mouse is moved around. Parameters are : mouseX, mouseY, lastButtonClicked & timeSinceMouseClick.

Overrides:

mouseClickMove in class GuiScreen

mouseReleased

protected void mouseReleased(int mouseX,
                             int mouseY,
                             int state)

Called when a mouse button is released.

Overrides:

mouseReleased in class GuiScreen

isPointInRegion

protected boolean isPointInRegion(int rectX,
                                  int rectY,
                                  int rectWidth,
                                  int rectHeight,
                                  int pointX,
                                  int pointY)

Test if the 2D point is in a rectangle (relative to the GUI). Args : rectX, rectY, rectWidth, rectHeight, pointX, pointY

handleMouseClick

protected void handleMouseClick(Slot slotIn,
                                int slotId,
                                int mouseButton,
                                ClickType type)

Called when the mouse is clicked over a slot or outside the gui.

keyTyped

protected void keyTyped(char typedChar,
                        int keyCode)
                 throws java.io.IOException

Fired when a key is typed (except F11 which toggles full screen). This is the equivalent of KeyListener.keyTyped(KeyEvent e). Args : character (character on the key), keyCode (lwjgl Keyboard key code)

Overrides:

keyTyped in class GuiScreen

Throws:

java.io.IOException

checkHotbarKeys

protected boolean checkHotbarKeys(int keyCode)

Checks whether a hotbar key (to swap the hovered item with an item in the hotbar) has been pressed. If so, it swaps the given items. Returns true if a hotbar key was pressed.

onGuiClosed

public void onGuiClosed()

Called when the screen is unloaded. Used to disable keyboard repeat events

Overrides:

onGuiClosed in class GuiScreen

doesGuiPauseGame

public boolean doesGuiPauseGame()

Returns true if this GUI should pause the game when it is displayed in single-player

Overrides:

doesGuiPauseGame in class GuiScreen

updateScreen

public void updateScreen()

Called from the main game loop to update the screen.

Overrides:

updateScreen in class GuiScreen

getSlotUnderMouse

public Slot getSlotUnderMouse()

Returns the slot that is currently displayed under the mouse.

getGuiLeft

public int getGuiLeft()

getGuiTop

public int getGuiTop()

getXSize

public int getXSize()

getYSize

public int getYSize()