Package net.neoforged.neoforge.client.event

Class ScreenEvent.MouseScrolled

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.MouseScrolled

Direct Known Subclasses:

ScreenEvent.MouseScrolled.Post, ScreenEvent.MouseScrolled.Pre

Enclosing class:

ScreenEvent

public abstract static class ScreenEvent.MouseScrolled
extends ScreenEvent.MouseInput

Fired when the mouse was dragged while a button is being held down. See the two subclasses for listening before and after the normal handling.

See Also:

• ScreenEvent.MouseScrolled.Pre
• ScreenEvent.MouseScrolled.Post

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenEvent.MouseScrolled.Post	Fired after the mouse scroll is handled, if not handled by the screen and the corresponding ScreenEvent.MouseScrolled.Pre is not cancelled.
static class	ScreenEvent.MouseScrolled.Pre	Fired before the mouse scroll is handled by the screen.

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

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

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 double	scrollDeltaX
private final double	scrollDeltaY

Constructor Summary

Constructors

Constructor	Description
MouseScrolled(Screen screen, double mouseX, double mouseY, double scrollDeltaX, double scrollDeltaY)

Method Summary

Modifier and Type	Method	Description
double	getScrollDeltaX()	Returns the amount of change / delta of the mouse scroll on the X axis.
double	getScrollDeltaY()	Returns the amount of change / delta of the mouse scroll on the Y axis.

Methods inherited from class net.neoforged.neoforge.client.event.ScreenEvent.MouseInput

getMouseX, getMouseY

Methods inherited from class net.neoforged.neoforge.client.event.ScreenEvent

getScreen

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

scrollDeltaX

private final double scrollDeltaX

scrollDeltaY

private final double scrollDeltaY

Constructor Details

MouseScrolled

@Internal
public MouseScrolled(Screen screen,
 double mouseX,
 double mouseY,
 double scrollDeltaX,
 double scrollDeltaY)

Method Details

getScrollDeltaX

public double getScrollDeltaX()

Returns the amount of change / delta of the mouse scroll on the X axis.

Returns:

the amount of change / delta of the mouse scroll on the X axis

getScrollDeltaY

public double getScrollDeltaY()

Returns the amount of change / delta of the mouse scroll on the Y axis.

Returns:

the amount of change / delta of the mouse scroll on the Y axis