Package dev.architectury.event.events.client

Interface ClientScreenInputEvent.MouseScrolled

Enclosing interface:

ClientScreenInputEvent

public static interface ClientScreenInputEvent.MouseScrolled

Method Summary

Modifier and Type	Method	Description
EventResult	mouseScrolled(net.minecraft.client.Minecraft client, net.minecraft.client.gui.screens.Screen screen, double mouseX, double mouseY, double amount)	Invoked whenever the mouse scroll wheel is moved.

Method Details

mouseScrolled

EventResult mouseScrolled(net.minecraft.client.Minecraft client,
 net.minecraft.client.gui.screens.Screen screen,
 double mouseX,
 double mouseY,
 double amount)

Invoked whenever the mouse scroll wheel is moved. Equivalent to Forge's GuiScreenEvent.MouseScrollEvent event.

This event is handled in two phases PRE and POST, which are invoked before and after the keys have been processed by the screen, respectively.

Parameters:

client - The Minecraft instance performing it.

screen - The screen this keystroke was performed in.

mouseX - The scaled x-coordinate of the mouse cursor.

mouseY - The scaled y-coordinate of the mouse cursor.

amount - The amount the scroll wheel is moved.

Returns:

A EventResult determining the outcome of the event, the execution of the vanilla scrolling mechanism may be cancelled by the result.