buildcraft.lib.gui

Interface IInteractionElement

All Superinterfaces:

IGuiArea, IGuiElement, IGuiPosition, IHelpElement, ITooltipElement

All Known Subinterfaces:

IContainingElement, IMenuElement

All Known Implementing Classes:

GuiAbstractButton, GuiButtonDrawable, GuiElementContainer2, GuiElementContainerResizing, GuiElementContainerScissor, GuiElementStatement, GuiElementStatementDrag, GuiElementStatementParam, GuiElementStatementSource, GuiElementStatementVariant, GuiImageButton, Ledger_Neptune, LedgerEngine, LedgerHelp, LedgerOwnership, LedgerTablePower, ScrollbarElement, ScrollWindow, WidgetPhantomSlot.GuiElementPhantomSlot

public interface IInteractionElement
extends IGuiElement

Method Summary

Modifier and Type	Method and Description
default boolean	onKeyPress(char typedChar, int keyCode) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseClicked(int button) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseDragged(int button, long ticksSinceClick) This is called EVEN IF the mouse is not inside your width and height!
default void	onMouseReleased(int button) This is called EVEN IF the mouse is not inside your width and height!

Methods inherited from interface buildcraft.lib.gui.IGuiElement

addHelpElements, addToolTips, drawBackground, drawForeground, getDebugInfo, getThisAndChildrenAt, tick

Methods inherited from interface buildcraft.lib.gui.pos.IGuiArea

asImmutable, contains, contains, contains, create, create, create, expand, expand, expand, expand, getCenter, getCenterTop, getCenterX, getCenterY, getEnd, getEndX, getEndY, getHeight, getPosition, getWidth, offset, offset, offset, offset, offset, offsetToOrigin, rectangleToString, resize, resize

Methods inherited from interface buildcraft.lib.gui.pos.IGuiPosition

getX, getY

Method Detail

onMouseClicked

default void onMouseClicked(int button)

This is called EVEN IF the mouse is not inside your width and height!

onMouseDragged

default void onMouseDragged(int button,
                            long ticksSinceClick)

This is called EVEN IF the mouse is not inside your width and height!

onMouseReleased

default void onMouseReleased(int button)

This is called EVEN IF the mouse is not inside your width and height!

onKeyPress

default boolean onKeyPress(char typedChar,
                           int keyCode)

This is called EVEN IF the mouse is not inside your width and height!

Returns:

True if this element handled the press, false otherwise. If this returns true then the normal gui interaction events won't happen (for example if the player presses escape and this returns true then the gui won't be closed). It is highly recommended that you close something if escape is pressed.