net.minecraft.client.gui

Class GuiButton

java.lang.Object

net.minecraft.client.gui.Gui

net.minecraft.client.gui.GuiButton

Direct Known Subclasses:

GuiButtonExt, GuiButtonLanguage, GuiButtonRealmsProxy, GuiCheckBox, GuiListButton, GuiLockIconButton, GuiOptionButton, GuiOptionSlider, GuiSlider

public class GuiButton
extends Gui

Field Summary

Fields

Modifier and Type	Field and Description
protected static ResourceLocation	buttonTextures
java.lang.String	displayString The string displayed on this control.
boolean	enabled True if this control is enabled, false to disable.
int	height Button height in pixels
protected boolean	hovered
int	id
int	packedFGColour
boolean	visible Hides the button completely if false.
int	width Button width in pixels
int	xPosition The x position of this control.
int	yPosition The y position of this control.

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

icons, optionsBackground, statIcons, zLevel

Constructor Summary

Constructors

Constructor and Description
GuiButton(int buttonId, int x, int y, int widthIn, int heightIn, java.lang.String buttonText)
GuiButton(int buttonId, int x, int y, java.lang.String buttonText)

Method Summary

Modifier and Type	Method and Description
void	drawButton(Minecraft mc, int mouseX, int mouseY) Draws this button to the screen.
void	drawButtonForegroundLayer(int mouseX, int mouseY)
int	getButtonWidth()
protected int	getHoverState(boolean mouseOver) Returns 0 if the button is disabled, 1 if the mouse is NOT hovering over this button and 2 if it IS hovering over this button.
boolean	isMouseOver() Whether the mouse cursor is currently over the button.
protected void	mouseDragged(Minecraft mc, int mouseX, int mouseY) Fired when the mouse button is dragged.
boolean	mousePressed(Minecraft mc, int mouseX, int mouseY) Returns true if the mouse has been pressed on this control.
void	mouseReleased(int mouseX, int mouseY) Fired when the mouse button is released.
void	playPressSound(SoundHandler soundHandlerIn)
void	setWidth(int width)

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

buttonTextures

protected static final ResourceLocation buttonTextures

width

public int width

Button width in pixels

height

public int height

Button height in pixels

xPosition

public int xPosition

The x position of this control.

yPosition

public int yPosition

The y position of this control.

displayString

public java.lang.String displayString

The string displayed on this control.

id

public int id

enabled

public boolean enabled

True if this control is enabled, false to disable.

visible

public boolean visible

Hides the button completely if false.

hovered

protected boolean hovered

packedFGColour

public int packedFGColour

Constructor Detail

GuiButton

public GuiButton(int buttonId,
                 int x,
                 int y,
                 java.lang.String buttonText)

GuiButton

public GuiButton(int buttonId,
                 int x,
                 int y,
                 int widthIn,
                 int heightIn,
                 java.lang.String buttonText)

Method Detail

getHoverState

protected int getHoverState(boolean mouseOver)

Returns 0 if the button is disabled, 1 if the mouse is NOT hovering over this button and 2 if it IS hovering over this button.

drawButton

public void drawButton(Minecraft mc,
                       int mouseX,
                       int mouseY)

Draws this button to the screen.

mouseDragged

protected void mouseDragged(Minecraft mc,
                            int mouseX,
                            int mouseY)

Fired when the mouse button is dragged. Equivalent of MouseListener.mouseDragged(MouseEvent e).

mouseReleased

public void mouseReleased(int mouseX,
                          int mouseY)

Fired when the mouse button is released. Equivalent of MouseListener.mouseReleased(MouseEvent e).

mousePressed

public boolean mousePressed(Minecraft mc,
                            int mouseX,
                            int mouseY)

Returns true if the mouse has been pressed on this control. Equivalent of MouseListener.mousePressed(MouseEvent e).

isMouseOver

public boolean isMouseOver()

Whether the mouse cursor is currently over the button.

drawButtonForegroundLayer

public void drawButtonForegroundLayer(int mouseX,
                                      int mouseY)

playPressSound

public void playPressSound(SoundHandler soundHandlerIn)

getButtonWidth

public int getButtonWidth()

setWidth

public void setWidth(int width)