Package codechicken.lib.gui.modular.elements

Class GuiEventProvider

java.lang.Object

codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry<GuiEventProvider>

codechicken.lib.gui.modular.elements.GuiElement<GuiEventProvider>

codechicken.lib.gui.modular.elements.GuiEventProvider

All Implemented Interfaces:

ElementEvents, GuiParent<GuiEventProvider>, TooltipHandler<GuiEventProvider>

public class GuiEventProvider
extends GuiElement<GuiEventProvider>

Created by brandon3055 on 15/11/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuiEventProvider.MouseMoveListener
static interface	GuiEventProvider.ScrollListener

Field Summary

Fields inherited from class codechicken.lib.gui.modular.elements.GuiElement

hoverTime, initialized

Constructor Summary

Constructors

Constructor	Description
GuiEventProvider(GuiParent<?> parent)

Method Summary

Modifier and Type	Method	Description
boolean	charTyped(net.minecraft.client.input.CharacterEvent event, boolean consumed)	Root handler for charTyped event.
boolean	keyPressed(net.minecraft.client.input.KeyEvent event, boolean consumed)	Root handler for keyPressed event.
boolean	keyReleased(net.minecraft.client.input.KeyEvent event, boolean consumed)	Root handler for keyReleased event.
boolean	mouseClicked(net.minecraft.client.input.MouseButtonEvent event, boolean consumed)	Root handler for mouseClick event.
void	mouseMoved(double mouseX, double mouseY)	Called whenever the cursor position changes.
boolean	mouseReleased(net.minecraft.client.input.MouseButtonEvent event, boolean consumed)	Root handler for mouseReleased event.
boolean	mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY, boolean consumed)	Root handler for mouseScrolled event.
GuiEventProvider	onCharTyped(Consumer<net.minecraft.client.input.CharacterEvent> listener)
GuiEventProvider	onKeyPress(Consumer<net.minecraft.client.input.KeyEvent> listener)
GuiEventProvider	onKeyRelease(Consumer<net.minecraft.client.input.KeyEvent> listener)
GuiEventProvider	onMouseClick(Consumer<net.minecraft.client.input.MouseButtonEvent> listener)
GuiEventProvider	onMouseMove(GuiEventProvider.MouseMoveListener listener)
GuiEventProvider	onMouseRelease(Consumer<net.minecraft.client.input.MouseButtonEvent> listener)
GuiEventProvider	onScroll(GuiEventProvider.ScrollListener listener)
GuiEventProvider	setIgnoreConsumed(boolean ignoreConsumed)

Methods inherited from class codechicken.lib.gui.modular.elements.GuiElement

addChild, addJeiDropTargets, addJeiExclusions, adoptChild, applyQueuedChildUpdates, blockMouseEvents, blockMouseOver, bringChildToForeground, font, getChildren, getJeiDropConsumer, getModularGui, getParent, getTooltip, getTooltipDelay, hoverTime, initElement, isDescendantOf, isEnabled, isJeiDropTarget, isJeiExcluded, isMouseOver, isOpaque, isRemoved, isTooltipEnabled, jeiExclude, mc, onScreenInit, removeChild, render, renderChild, renderOverlay, scaledScreenHeight, scaledScreenWidth, sendChildToBackground, sendChildToIndex, setEnabled, setEnabled, setEnableToolTip, setJeiDropTarget, setJeiExcluded, setOpaque, setRenderCull, setTooltip, setTooltipDelay, showToolTip, tick, toString, updateMouseOver, updateScreenData

Methods inherited from class codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry

addBoundsToRect, clearConstraints, clearGeometryCache, constrain, get, getChildBounds, getEnclosingRect, getParent, getPosition, getRectangle, placeInside, placeInside, placeOutside, placeOutside, setHeight, setPos, setSize, setWidth, setXPos, setYPos, strictMode, validate, xCenter, xMax, xMin, xSize, yCenter, yMax, yMin, ySize

Methods inherited from class java.lang.Object

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

Methods inherited from interface codechicken.lib.gui.modular.lib.ElementEvents

charTyped, keyPressed, keyReleased, mouseClicked, mouseReleased, mouseScrolled

Methods inherited from interface codechicken.lib.gui.modular.lib.geometry.GuiParent

addChild, getValue

Methods inherited from interface codechicken.lib.gui.modular.lib.TooltipHandler

renderTooltip, setTooltip, setTooltip, setTooltip, setTooltipSingle, setTooltipSingle

Constructor Details

GuiEventProvider

public GuiEventProvider(GuiParent<?> parent)

Method Details

setIgnoreConsumed

public GuiEventProvider setIgnoreConsumed(boolean ignoreConsumed)

onMouseClick

public GuiEventProvider onMouseClick(Consumer<net.minecraft.client.input.MouseButtonEvent> listener)

onMouseRelease

public GuiEventProvider onMouseRelease(Consumer<net.minecraft.client.input.MouseButtonEvent> listener)

onMouseMove

public GuiEventProvider onMouseMove(GuiEventProvider.MouseMoveListener listener)

onScroll

public GuiEventProvider onScroll(GuiEventProvider.ScrollListener listener)

onKeyPress

public GuiEventProvider onKeyPress(Consumer<net.minecraft.client.input.KeyEvent> listener)

onKeyRelease

public GuiEventProvider onKeyRelease(Consumer<net.minecraft.client.input.KeyEvent> listener)

onCharTyped

public GuiEventProvider onCharTyped(Consumer<net.minecraft.client.input.CharacterEvent> listener)

mouseClicked

public boolean mouseClicked(net.minecraft.client.input.MouseButtonEvent event,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for mouseClick event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of mouseClick handling should be implemented via ElementEvents.mouseClicked(MouseButtonEvent)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

event - The mouse button event. Position, Key, and modifiers.

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.

mouseReleased

public boolean mouseReleased(net.minecraft.client.input.MouseButtonEvent event,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for mouseReleased event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of mouseReleased handling should be implemented via ElementEvents.mouseReleased(MouseButtonEvent)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

event - The mouse button event. Position, Key, and modifiers.

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.

mouseMoved

public void mouseMoved(double mouseX,
 double mouseY)

Description copied from interface: ElementEvents

Called whenever the cursor position changes. Vanillas mouseDragged is not passed through because it is redundant. All mouse drag functionality can be archived using available events.

Parameters:

mouseX - new mouse X position

mouseY - new mouse Y position

mouseScrolled

public boolean mouseScrolled(double mouseX,
 double mouseY,
 double scrollX,
 double scrollY,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for mouseScrolled event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of mouseScrolled handling should be implemented via ElementEvents.mouseScrolled(double, double, double, double)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

mouseX - Mouse X position

mouseY - Mouse Y position

scrollX - Scroll direction and amount

scrollY - Scroll direction and amount

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.

keyPressed

public boolean keyPressed(net.minecraft.client.input.KeyEvent event,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for keyPressed event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of keyPressed handling should be implemented via ElementEvents.keyPressed(KeyEvent)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

event - The key event. Key, scancode, and modifiers.

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.

keyReleased

public boolean keyReleased(net.minecraft.client.input.KeyEvent event,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for keyReleased event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of keyReleased handling should be implemented via ElementEvents.keyReleased(KeyEvent)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

event - The key event. Key, scancode, and modifiers.

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.

charTyped

public boolean charTyped(net.minecraft.client.input.CharacterEvent event,
 boolean consumed)

Description copied from interface: ElementEvents

Root handler for charTyped event. This method will always be called for all elements even if the event has already been consumed. There are a few uses for this method, but the fast majority of charTyped handling should be implemented via ElementEvents.charTyped(CharacterEvent)

Note: If overriding this method, do so with caution, You must either return true (if you wish to consume the event) or you must return the result of the super call.

Parameters:

event - The character event, codepoint and modifiers.

consumed - Will be true if this action has already been consumed.

Returns:

true if this event has been consumed.