Class ScreenEvent.MouseButtonPressed

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

net.neoforged.neoforge.client.event.ScreenEvent.MouseInput

net.neoforged.neoforge.client.event.ScreenEvent.MouseButtonPressed

Direct Known Subclasses:

ScreenEvent.MouseButtonPressed.Post, ScreenEvent.MouseButtonPressed.Pre

Enclosing class:

ScreenEvent

public abstract static class ScreenEvent.MouseButtonPressed
extends ScreenEvent.MouseInput

Fired when a mouse button is pressed. See the two subclasses for listening before and after the normal handling.

See Also:

• ScreenEvent.MouseButtonPressed.Pre
• ScreenEvent.MouseButtonPressed.Post

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenEvent.MouseButtonPressed.Post	This event is fired after the mouse click is handled, if the corresponding ScreenEvent.MouseButtonPressed.Pre was not cancelled.
static class	ScreenEvent.MouseButtonPressed.Pre	Fired before the mouse click is handled by the screen.

Nested classes/interfaces inherited from class ScreenEvent

ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyPressed, ScreenEvent.KeyReleased, ScreenEvent.MouseButtonPressed, ScreenEvent.MouseButtonReleased, ScreenEvent.MouseDragged, ScreenEvent.MouseScrolled, ScreenEvent.Opening, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	doubleClick
private final MouseButtonEvent	mouseEvent

Constructor Summary

Constructors

Constructor	Description
MouseButtonPressed(Screen screen, MouseButtonEvent mouseEvent, boolean doubleClick)

Method Summary

Modifier and Type	Method	Description
int	getButton()	Returns the mouse button's input code.
MouseButtonEvent	getMouseButtonEvent()
boolean	isDoubleClick()	Returns whether the user double-clicked.

Methods inherited from class ScreenEvent.MouseInput

getMouseX, getMouseY

Methods inherited from class ScreenEvent

getScreen

Methods inherited from class Object

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

Field Details

mouseEvent

private final MouseButtonEvent mouseEvent

doubleClick

private final boolean doubleClick

Constructor Details

MouseButtonPressed

@Internal
public MouseButtonPressed(Screen screen,
 MouseButtonEvent mouseEvent,
 boolean doubleClick)

Method Details

getMouseButtonEvent

public MouseButtonEvent getMouseButtonEvent()

getButton

public int getButton()

Returns the mouse button's input code.

Returns:

the mouse button's input code

See Also:

• mouse constants starting with 'GLFW_MOUSE_BUTTON_'
• the online GLFW documentation

isDoubleClick

public boolean isDoubleClick()

Returns whether the user double-clicked.

Returns:

whether the user double-clicked