net.minecraft.client.gui

Class GuiScreen

java.lang.Object

net.minecraft.client.gui.Gui

net.minecraft.client.gui.GuiScreen

All Implemented Interfaces:

GuiYesNoCallback

Direct Known Subclasses:

GuiAccessDenied, GuiBackupFailed, GuiChat, GuiCommandBlock, GuiConfig, GuiConnecting, GuiContainer, GuiControls, GuiCreateFlatWorld, GuiCreateWorld, GuiCustomizeSkin, GuiCustomizeWorldScreen, GuiDisconnected, GuiDownloadTerrain, GuiEditArray, GuiEditCommandBlockMinecart, GuiEditSign, GuiEditStructure, GuiErrorScreen, GuiFlatPresets, GuiGameOver, GuiIngameMenu, GuiLanguage, GuiMainMenu, GuiMemoryErrorScreen, GuiModList, GuiModsMissingForServer, GuiMultiplayer, GuiNotification, GuiOptions, GuiScreenAddServer, GuiScreenAdvancements, GuiScreenBook, GuiScreenCustomizePresets, GuiScreenDemo, GuiScreenOptionsSounds, GuiScreenRealmsProxy, GuiScreenResourcePacks, GuiScreenServerList, GuiScreenWorking, GuiSelectString, GuiShareToLan, GuiSnooper, GuiSortingProblem, GuiStats, GuiVideoSettings, GuiWinGame, GuiWorldEdit, GuiWorldSelection, GuiYesNo, NotificationModUpdateScreen, ScreenChatOptions

public abstract class GuiScreen
extends Gui
implements GuiYesNoCallback

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowUserInput
protected java.util.List<GuiButton>	buttonList A list of all the buttons in this container.
protected FontRenderer	fontRenderer The FontRenderer used by GuiScreen
int	height The height of the screen object.
protected RenderItem	itemRender Holds a instance of RenderItem, used to draw the achievement icons on screen (is based on ItemStack)
protected boolean	keyHandled
protected java.util.List<GuiLabel>	labelList A list of all the labels in this container.
Minecraft	mc Reference to the Minecraft object.
protected boolean	mouseHandled
protected GuiButton	selectedButton The button that was just pressed.
int	width The width of the screen object.

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

ICONS, OPTIONS_BACKGROUND, STAT_ICONS, zLevel

Constructor Summary

Constructors

Constructor and Description
GuiScreen()

Method Summary

Modifier and Type	Method and Description
protected void	actionPerformed(GuiButton button) Called by the controls from the buttonList when activated.
protected <T extends GuiButton> T	addButton(T buttonIn) Adds a control to this GUI's button list.
void	confirmClicked(boolean result, int id)
boolean	doesGuiPauseGame() Returns true if this GUI should pause the game when it is displayed in single-player
void	drawBackground(int tint) Draws the background (i is always 0 as of 1.2.2)
void	drawDefaultBackground() Draws either a gradient over the background screen (when it exists) or a flat gradient over background.png
void	drawHoveringText(java.util.List<java.lang.String> textLines, int x, int y) Draws a List of strings as a tooltip.
protected void	drawHoveringText(java.util.List<java.lang.String> textLines, int x, int y, FontRenderer font)
void	drawHoveringText(java.lang.String text, int x, int y) Draws the given text as a tooltip.
void	drawScreen(int mouseX, int mouseY, float partialTicks) Draws the screen and all the components in it.
void	drawWorldBackground(int tint)
static java.lang.String	getClipboardString() Returns a string stored in the system clipboard.
java.util.List<java.lang.String>	getItemToolTip(ItemStack p_191927_1_)
boolean	handleComponentClick(ITextComponent component) Executes the click event specified by the given chat component
protected void	handleComponentHover(ITextComponent component, int x, int y) Draws the hover event specified by the given chat component
void	handleInput() Delegates mouse and keyboard input.
void	handleKeyboardInput() Handles keyboard input.
void	handleMouseInput() Handles mouse input.
void	initGui() Adds the buttons (and other controls) to the screen in question.
static boolean	isAltKeyDown() Returns true if either alt key is down
static boolean	isCtrlKeyDown() Returns true if either windows ctrl key is down or if either mac meta key is down
boolean	isFocused()
static boolean	isKeyComboCtrlA(int keyID)
static boolean	isKeyComboCtrlC(int keyID)
static boolean	isKeyComboCtrlV(int keyID)
static boolean	isKeyComboCtrlX(int keyID)
static boolean	isShiftKeyDown() Returns true if either shift key is down
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	onResize(Minecraft mcIn, int w, int h) Called when the GUI is resized in order to update the world and the resolution
protected void	renderToolTip(ItemStack stack, int x, int y)
void	sendChatMessage(java.lang.String msg) Used to add chat messages to the client's GuiChat.
void	sendChatMessage(java.lang.String msg, boolean addToChat)
static void	setClipboardString(java.lang.String copyText) Stores the given string in the system clipboard
void	setFocused(boolean hasFocusedControlIn)
void	setGuiSize(int w, int h) Set the gui to the specified width and height
protected void	setText(java.lang.String newChatText, boolean shouldOverwrite) Sets the text of the chat
void	setWorldAndResolution(Minecraft mc, int width, int height) Causes the screen to lay out its subcomponents again.
void	updateScreen() Called from the main game loop to update the screen.

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

mc

public Minecraft mc

Reference to the Minecraft object.

itemRender

protected RenderItem itemRender

Holds a instance of RenderItem, used to draw the achievement icons on screen (is based on ItemStack)

width

public int width

The width of the screen object.

height

public int height

The height of the screen object.

buttonList

protected java.util.List<GuiButton> buttonList

A list of all the buttons in this container.

labelList

protected java.util.List<GuiLabel> labelList

A list of all the labels in this container.

allowUserInput

public boolean allowUserInput

fontRenderer

protected FontRenderer fontRenderer

The FontRenderer used by GuiScreen

selectedButton

protected GuiButton selectedButton

The button that was just pressed.

keyHandled

protected boolean keyHandled

mouseHandled

protected boolean mouseHandled

Constructor Detail

GuiScreen

public GuiScreen()

Method Detail

drawScreen

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

Draws the screen and all the components in it.

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)

Throws:

java.io.IOException

addButton

protected <T extends GuiButton> T addButton(T buttonIn)

Adds a control to this GUI's button list. Any type that subclasses button may be added (particularly, GuiSlider, but not text fields).

Parameters:

buttonIn - The control to add

Returns:

The control passed in.

getClipboardString

public static java.lang.String getClipboardString()

Returns a string stored in the system clipboard.

setClipboardString

public static void setClipboardString(java.lang.String copyText)

Stores the given string in the system clipboard

renderToolTip

protected void renderToolTip(ItemStack stack,
                             int x,
                             int y)

getItemToolTip

public java.util.List<java.lang.String> getItemToolTip(ItemStack p_191927_1_)

drawHoveringText

public void drawHoveringText(java.lang.String text,
                             int x,
                             int y)

Draws the given text as a tooltip.

setFocused

public void setFocused(boolean hasFocusedControlIn)

isFocused

public boolean isFocused()

drawHoveringText

public void drawHoveringText(java.util.List<java.lang.String> textLines,
                             int x,
                             int y)

Draws a List of strings as a tooltip. Every entry is drawn on a seperate line.

drawHoveringText

protected void drawHoveringText(java.util.List<java.lang.String> textLines,
                                int x,
                                int y,
                                FontRenderer font)

handleComponentHover

protected void handleComponentHover(ITextComponent component,
                                    int x,
                                    int y)

Draws the hover event specified by the given chat component

setText

protected void setText(java.lang.String newChatText,
                       boolean shouldOverwrite)

Sets the text of the chat

handleComponentClick

public boolean handleComponentClick(ITextComponent component)

Executes the click event specified by the given chat component

sendChatMessage

public void sendChatMessage(java.lang.String msg)

Used to add chat messages to the client's GuiChat.

sendChatMessage

public void sendChatMessage(java.lang.String msg,
                            boolean addToChat)

mouseClicked

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

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

Throws:

java.io.IOException

mouseReleased

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

Called when a mouse button is released.

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.

actionPerformed

protected void actionPerformed(GuiButton button)
                        throws java.io.IOException

Called by the controls from the buttonList when activated. (Mouse pressed for buttons)

Throws:

java.io.IOException

setWorldAndResolution

public void setWorldAndResolution(Minecraft mc,
                                  int width,
                                  int height)

Causes the screen to lay out its subcomponents again. This is the equivalent of the Java call Container.validate()

setGuiSize

public void setGuiSize(int w,
                       int h)

Set the gui to the specified width and height

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.

handleInput

public void handleInput()
                 throws java.io.IOException

Delegates mouse and keyboard input.

Throws:

java.io.IOException

handleMouseInput

public void handleMouseInput()
                      throws java.io.IOException

Handles mouse input.

Throws:

java.io.IOException

handleKeyboardInput

public void handleKeyboardInput()
                         throws java.io.IOException

Handles keyboard input.

Throws:

java.io.IOException

updateScreen

public void updateScreen()

Called from the main game loop to update the screen.

onGuiClosed

public void onGuiClosed()

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

drawDefaultBackground

public void drawDefaultBackground()

Draws either a gradient over the background screen (when it exists) or a flat gradient over background.png

drawWorldBackground

public void drawWorldBackground(int tint)

drawBackground

public void drawBackground(int tint)

Draws the background (i is always 0 as of 1.2.2)

doesGuiPauseGame

public boolean doesGuiPauseGame()

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

confirmClicked

public void confirmClicked(boolean result,
                           int id)

Specified by:

confirmClicked in interface GuiYesNoCallback

isCtrlKeyDown

public static boolean isCtrlKeyDown()

Returns true if either windows ctrl key is down or if either mac meta key is down

isShiftKeyDown

public static boolean isShiftKeyDown()

Returns true if either shift key is down

isAltKeyDown

public static boolean isAltKeyDown()

Returns true if either alt key is down

isKeyComboCtrlX

public static boolean isKeyComboCtrlX(int keyID)

isKeyComboCtrlV

public static boolean isKeyComboCtrlV(int keyID)

isKeyComboCtrlC

public static boolean isKeyComboCtrlC(int keyID)

isKeyComboCtrlA

public static boolean isKeyComboCtrlA(int keyID)

onResize

public void onResize(Minecraft mcIn,
                     int w,
                     int h)

Called when the GUI is resized in order to update the world and the resolution