Package net.neoforged.neoforge.client.event

Class InputEvent.MouseButton

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.InputEvent

net.neoforged.neoforge.client.event.InputEvent.MouseButton

Direct Known Subclasses:

InputEvent.MouseButton.Post, InputEvent.MouseButton.Pre

Enclosing class:

InputEvent

public abstract static class InputEvent.MouseButton
extends InputEvent

Fired when a mouse button is pressed/released. Sub-events get fired before and after this happens.

These events are fired on the main Forge event bus, only on the logical client.

See Also:

• the online GLFW documentation
• InputEvent.MouseButton.Pre
• InputEvent.MouseButton.Post

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputEvent.MouseButton.Post	Fired when a mouse button is pressed/released, after processing.
static class	InputEvent.MouseButton.Pre	Fired when a mouse button is pressed/released, before being processed by vanilla.

Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.InputEvent

InputEvent.InteractionKeyMappingTriggered, InputEvent.Key, InputEvent.MouseButton, InputEvent.MouseScrollingEvent

Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final int	action
private final int	button
private final int	modifiers

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MouseButton(int button, int action, int modifiers)

Method Summary

Modifier and Type	Method	Description
int	getAction()	Returns the mouse button's action.
int	getButton()	Returns the mouse button's input code.
int	getModifiers()	Returns a bit field representing the active modifier keys.

Methods inherited from class net.neoforged.bus.api.Event

getResult, hasResult, setResult

Methods inherited from class java.lang.Object

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

Field Details

button

private final int button

action

private final int action

modifiers

private final int modifiers

Constructor Details

MouseButton

@Internal
protected MouseButton(int button,
 int action,
 int modifiers)

Method Details

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

getAction

public int getAction()

Returns the mouse button's action.

Returns:

the mouse button's action

See Also:

• InputConstants.PRESS
• InputConstants.RELEASE

getModifiers

public int getModifiers()

Returns a bit field representing the active modifier keys.

Returns:

a bit field representing the active modifier keys

See Also:

• CTRL modifier key bit
• SHIFT modifier key bit
• ALT modifier key bit
• SUPER modifier key bit
• CAPS LOCK modifier key bit
• NUM LOCK modifier key bit
• the online GLFW documentation