net.malisis.core.client.gui

Class MalisisGui

java.lang.Object

net.minecraft.client.gui.Gui

net.minecraft.client.gui.GuiScreen

net.malisis.core.client.gui.MalisisGui

All Implemented Interfaces:

net.minecraft.client.gui.GuiYesNoCallback

Direct Known Subclasses:

ConfigurationGui

public abstract class MalisisGui
extends net.minecraft.client.gui.GuiScreen

GuiScreenProxy

Field Summary

Fields

Modifier and Type	Field and Description
static GuiTexture	BLOCK_TEXTURE
static boolean	cancelClose Whether or not to cancel the next gui close event.
protected boolean	constructed Whether this GUI has been constructed.
protected int	currentGuiScale Currently used gui scale.
protected int	displayHeight Height of the window.
protected int	displayWidth Width of the window.
protected UIComponent<?>	focusedComponent Currently focused child component.
protected boolean	guiscreenBackground Determines if the screen should be darkened when the GUI is opened.
protected UIComponent<?>	hoveredComponent Currently hovered child component.
protected MalisisInventoryContainer	inventoryContainer Inventory container that handles the inventories and slots actions.
protected boolean	isOverlay Whether this GUI is considered as an overlay
protected java.util.Set<IKeyListener>	keyListeners List of IKeyListener registered.
protected long	lastClickButton Last clicked button
protected long	lastClickTime How long since last click.
protected int	lastMouseX Last known position of the mouse.
protected int	lastMouseY Last known position of the mouse.
protected GuiRenderer	renderer Renderer drawing the components.
protected net.minecraft.client.gui.ScaledResolution	resolution The resolution for the GUI

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

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

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

ICONS, OPTIONS_BACKGROUND, STAT_ICONS, zLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MalisisGui()

Method Summary

Modifier and Type	Method and Description
void	addDebug(java.lang.String name, java.lang.Object... objects)
protected void	addToScreen(UIComponent<?> component) Adds container to the screen.
void	animate(Animation<?> animation)
void	animate(Animation<?> animation, int delay)
void	clearScreen() Removes all the components from the screen
void	close() Closes this MalisisGui.
void	closeOverlay()
abstract void	construct() Called before display() if this MalisisGui is not constructed yet.
static MalisisGui	currentGui() Gets the current MalisisGui displayed.
static <T extends MalisisGui> T	currentGui(java.lang.Class<T> type) Gets the current MalisisGui of the specified type displayed.
void	display() Displays this MalisisGui.
void	display(boolean cancelClose) Display this MalisisGui.
void	displayOverlay()
protected boolean	doConstruct()
boolean	doesGuiPauseGame()
void	drawScreen(int mouseX, int mouseY, float partialTicks) Draws this MalisisGui.
UIComponent<?>	getComponentAt(int x, int y) Gets the UIContainer at the specified coordinates inside this MalisisGui.
long	getElapsedTime() Gets elapsed time since the GUI was opened.
static UIComponent<?>	getFocusedComponent() Gets the currently focused UIComponent
GuiTexture	getGuiTexture() Gets the default GuiTexture used by the GuiRenderer.
static UIComponent<?>	getHoveredComponent()
MalisisInventoryContainer	getInventoryContainer() Gets the MalisisInventoryContainer for this MalisisGui.
GuiRenderer	getRenderer() Gets the GuiRenderer for this MalisisGui.
void	handleMouseInput() Called every frame to handle mouse input.
static boolean	isGuiCloseKey(int keyCode)
void	keyEvent(net.minecraftforge.fml.common.gameevent.InputEvent.KeyInputEvent event)
protected void	keyTyped(char keyChar, int keyCode) Called when a key is pressed on the keyboard.
protected void	mouseClicked(int x, int y, int button) Called when a mouse button is pressed down.
protected void	mouseClickMove(int x, int y, int button, long timer) Called when the mouse is moved while a button is pressed.
protected void	mouseReleased(int x, int y, int button) Called when a mouse button is released.
void	onGuiClosed()
static void	playSound(net.minecraft.util.SoundEvent sound)
static void	playSound(net.minecraft.util.SoundEvent sound, float level)
void	registerKeyListener(IKeyListener listener) Registers a IKeyListener that will always receive keys types, even when not focused or hovered.
void	removeDebug(java.lang.String name)
void	renderOverlay(net.minecraftforge.client.event.RenderGameOverlayEvent.Post event)
static void	sendAction(MalisisInventoryContainer.ActionType action, MalisisSlot slot, int code) Sends a GUI action to the server.
static boolean	setFocusedComponent(UIComponent<?> component, boolean focused)
static boolean	setHoveredComponent(UIComponent<?> component, boolean hovered) Sets the hovered state for a UIComponent.
void	setInventoryContainer(MalisisInventoryContainer container) Sets the MalisisInventoryContainer for this MalisisGui.
void	setResolution() Sets the resolution for this MalisisGui.
void	setWorldAndResolution(net.minecraft.client.Minecraft minecraft, int width, int height) Called when game resolution changes.
void	unregisterKeyListener(IKeyListener listener) Unregisters a previously registered IKeyListener.
void	update(int mouseX, int mouseY, float partialTick) Called every frame.
void	updateGui() Called from TE when TE is updated.

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

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

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

BLOCK_TEXTURE

public static GuiTexture BLOCK_TEXTURE

cancelClose

public static boolean cancelClose

Whether or not to cancel the next gui close event.

renderer

protected GuiRenderer renderer

Renderer drawing the components.

displayWidth

protected int displayWidth

Width of the window.

displayHeight

protected int displayHeight

Height of the window.

currentGuiScale

protected int currentGuiScale

Currently used gui scale.

resolution

protected net.minecraft.client.gui.ScaledResolution resolution

The resolution for the GUI

guiscreenBackground

protected boolean guiscreenBackground

Determines if the screen should be darkened when the GUI is opened.

lastMouseX

protected int lastMouseX

Last known position of the mouse.

lastMouseY

protected int lastMouseY

Last known position of the mouse.

lastClickButton

protected long lastClickButton

Last clicked button

lastClickTime

protected long lastClickTime

How long since last click.

inventoryContainer

protected MalisisInventoryContainer inventoryContainer

Inventory container that handles the inventories and slots actions.

isOverlay

protected boolean isOverlay

Whether this GUI is considered as an overlay

hoveredComponent

protected UIComponent<?> hoveredComponent

Currently hovered child component.

focusedComponent

protected UIComponent<?> focusedComponent

Currently focused child component.

constructed

protected boolean constructed

Whether this GUI has been constructed.

keyListeners

protected java.util.Set<IKeyListener> keyListeners

List of IKeyListener registered.

Constructor Detail

MalisisGui

protected MalisisGui()

Method Detail

construct

public abstract void construct()

Called before display() if this MalisisGui is not constructed yet.
Called when Ctrl+R is pressed to rebuild the GUI.

doConstruct

protected boolean doConstruct()

getRenderer

public GuiRenderer getRenderer()

Gets the GuiRenderer for this MalisisGui.

Returns:

the renderer

setInventoryContainer

public void setInventoryContainer(MalisisInventoryContainer container)

Sets the MalisisInventoryContainer for this MalisisGui.

Parameters:

container - the inventory container

getInventoryContainer

public MalisisInventoryContainer getInventoryContainer()

Gets the MalisisInventoryContainer for this MalisisGui.

Returns:

inventory container

getGuiTexture

public GuiTexture getGuiTexture()

Gets the default GuiTexture used by the GuiRenderer.

Returns:

the defaultGuiTexture

getElapsedTime

public long getElapsedTime()

Gets elapsed time since the GUI was opened.

Returns:

the time

setWorldAndResolution

public final void setWorldAndResolution(net.minecraft.client.Minecraft minecraft,
                                        int width,
                                        int height)

Called when game resolution changes.

Overrides:

setWorldAndResolution in class net.minecraft.client.gui.GuiScreen

setResolution

public void setResolution()

Sets the resolution for this MalisisGui.

addDebug

public void addDebug(java.lang.String name,
                     java.lang.Object... objects)

removeDebug

public void removeDebug(java.lang.String name)

addToScreen

protected void addToScreen(UIComponent<?> component)

Adds container to the screen.

Parameters:

component - the component

clearScreen

public void clearScreen()

Removes all the components from the screen

registerKeyListener

public void registerKeyListener(IKeyListener listener)

Registers a IKeyListener that will always receive keys types, even when not focused or hovered.

Parameters:

listener - the listener

unregisterKeyListener

public void unregisterKeyListener(IKeyListener listener)

Unregisters a previously registered IKeyListener.

Parameters:

listener - the listener

getComponentAt

public UIComponent<?> getComponentAt(int x,
                                     int y)

Gets the UIContainer at the specified coordinates inside this MalisisGui.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

the component, null if component is screen

handleMouseInput

public void handleMouseInput()

Called every frame to handle mouse input.

Overrides:

handleMouseInput in class net.minecraft.client.gui.GuiScreen

mouseClicked

protected void mouseClicked(int x,
                            int y,
                            int button)

Called when a mouse button is pressed down.

Overrides:

mouseClicked in class net.minecraft.client.gui.GuiScreen

mouseClickMove

protected void mouseClickMove(int x,
                              int y,
                              int button,
                              long timer)

Called when the mouse is moved while a button is pressed.

Overrides:

mouseClickMove in class net.minecraft.client.gui.GuiScreen

mouseReleased

protected void mouseReleased(int x,
                             int y,
                             int button)

Called when a mouse button is released.

Overrides:

mouseReleased in class net.minecraft.client.gui.GuiScreen

keyTyped

protected void keyTyped(char keyChar,
                        int keyCode)

Called when a key is pressed on the keyboard.

Overrides:

keyTyped in class net.minecraft.client.gui.GuiScreen

drawScreen

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

Draws this MalisisGui.

Overrides:

drawScreen in class net.minecraft.client.gui.GuiScreen

update

public void update(int mouseX,
                   int mouseY,
                   float partialTick)

Called every frame.

Parameters:

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

updateGui

public void updateGui()

Called from TE when TE is updated. Override this method when you want to change displayed informations when the TileEntity changes.

animate

public void animate(Animation<?> animation)

animate

public void animate(Animation<?> animation,
                    int delay)

doesGuiPauseGame

public boolean doesGuiPauseGame()

Overrides:

doesGuiPauseGame in class net.minecraft.client.gui.GuiScreen

display

public void display()

Displays this MalisisGui.

display

public void display(boolean cancelClose)

Display this MalisisGui.

Parameters:

cancelClose - the wether or not to cancel the next Gui close event (used for when the GUI is opened from command)

close

public void close()

Closes this MalisisGui.

displayOverlay

public void displayOverlay()

closeOverlay

public void closeOverlay()

onGuiClosed

public void onGuiClosed()

Overrides:

onGuiClosed in class net.minecraft.client.gui.GuiScreen

renderOverlay

public void renderOverlay(net.minecraftforge.client.event.RenderGameOverlayEvent.Post event)

keyEvent

public void keyEvent(net.minecraftforge.fml.common.gameevent.InputEvent.KeyInputEvent event)

currentGui

public static MalisisGui currentGui()

Gets the current MalisisGui displayed.

Returns:

null if no GUI being displayed or if not a MalisisGui

currentGui

public static <T extends MalisisGui> T currentGui(java.lang.Class<T> type)

Gets the current MalisisGui of the specified type displayed.
If the current gu is not of type, null is returned.

Type Parameters:

T - the generic type

Parameters:

type - the type

Returns:

the t

sendAction

public static void sendAction(MalisisInventoryContainer.ActionType action,
                              MalisisSlot slot,
                              int code)

Sends a GUI action to the server.

Parameters:

action - the action

slot - the slot

code - the keyboard code

getHoveredComponent

public static UIComponent<?> getHoveredComponent()

Returns:

the currently hovered UIComponent. null if there is no current GUI.

setHoveredComponent

public static boolean setHoveredComponent(UIComponent<?> component,
                                          boolean hovered)

Sets the hovered state for a UIComponent. If a UIComponent is currently hovered, it will be "unhovered" first.

Parameters:

component - the component that gets his state changed

hovered - the hovered state

Returns:

true, if the state was changed

getFocusedComponent

public static UIComponent<?> getFocusedComponent()

Gets the currently focused UIComponent

Returns:

the component

setFocusedComponent

public static boolean setFocusedComponent(UIComponent<?> component,
                                          boolean focused)

playSound

public static void playSound(net.minecraft.util.SoundEvent sound)

playSound

public static void playSound(net.minecraft.util.SoundEvent sound,
                             float level)

isGuiCloseKey

public static boolean isGuiCloseKey(int keyCode)