Skip to content

ScrollEvent

class ScrollEvent(
    type: PointerEventType = PointerEventType.SCROLL, 
    mouseX: Double, 
    mouseY: Double, 
    val scrollX: Double, 
    val scrollY: Double
) : PointerEvent

A pointer event generated by mouse wheel movement.

Constructors

ScrollEvent

constructor(
    type: PointerEventType = PointerEventType.SCROLL, 
    mouseX: Double, 
    mouseY: Double, 
    scrollX: Double, 
    scrollY: Double
)

Properties

mouseX

val mouseX: Double

mouseY

val mouseY: Double

scrollX

scrollY

type

Functions

consume

fun consume(bypassSuperCall: Boolean = false)

Marks this event as consumed, stopping further propagation.

Parameters

  • bypassSuperCall: When true, the corresponding screen method will return true instead of delegating to the super implementation. Use this when the UI has fully handled a keyboard or mouse event and the vanilla logic should be suppressed.