ScreenMouseEvents

public final class ScreenMouseEvents

Events related to use of the mouse in a Screen.

All of these events work on top of a specific screen instance. Subscriptions will only last as long as the screen itself, they'll disappear once the screen gets refreshed, closed or replaced. Use BEFORE_INIT to register the desired events every time it is necessary.

Events are fired in the following order:

{@code AllowX -> BeforeX -> AfterX}

If the result of the Allow event is false, then Before and After are not called.

See also

net.fabricmc.fabric.api.client.screen.v1.ScreenEvents

Types

AfterMouseClick

public interface AfterMouseClick

AfterMouseRelease

public interface AfterMouseRelease

AfterMouseScroll

public interface AfterMouseScroll

AllowMouseClick

public interface AllowMouseClick

AllowMouseRelease

public interface AllowMouseRelease

AllowMouseScroll

public interface AllowMouseScroll

BeforeMouseClick

public interface BeforeMouseClick

BeforeMouseRelease

public interface BeforeMouseRelease

BeforeMouseScroll

public interface BeforeMouseScroll

Functions

afterMouseClick

static Event<ScreenMouseEvents.AfterMouseClick> afterMouseClick(Screen screen)

An event that is called after a mouse click is processed for a screen.

afterMouseRelease

static Event<ScreenMouseEvents.AfterMouseRelease> afterMouseRelease(Screen screen)

An event that is called after the release of a mouse click is processed for a screen.

afterMouseScroll

static Event<ScreenMouseEvents.AfterMouseScroll> afterMouseScroll(Screen screen)

An event that is called after mouse scrolling is processed for a screen.

allowMouseClick

static Event<ScreenMouseEvents.AllowMouseClick> allowMouseClick(Screen screen)

An event that checks if the mouse click should be allowed.

allowMouseRelease

static Event<ScreenMouseEvents.AllowMouseRelease> allowMouseRelease(Screen screen)

An event that checks if the mouse click should be allowed to release in a screen.

allowMouseScroll

static Event<ScreenMouseEvents.AllowMouseScroll> allowMouseScroll(Screen screen)

An event that is checks if the mouse should be allowed to scroll in a screen.

beforeMouseClick

static Event<ScreenMouseEvents.BeforeMouseClick> beforeMouseClick(Screen screen)

An event that is called before a mouse click is processed for a screen.

beforeMouseRelease

static Event<ScreenMouseEvents.BeforeMouseRelease> beforeMouseRelease(Screen screen)

An event that is called before the release of a mouse click is processed for a screen.

beforeMouseScroll

static Event<ScreenMouseEvents.BeforeMouseScroll> beforeMouseScroll(Screen screen)

An event that is called after mouse scrolling is processed for a screen.

Sources

jvm source