Skip to content

BasicPointerEvent

class BasicPointerEvent(
    type: PointerEventType, 
    mouseX: Double, 
    mouseY: Double, 
    button: Int = MouseButton.NONE
) : PointerEvent

A basic pointer event carrying position, type and, for a press or release, the MouseButton it came from.

Constructors

BasicPointerEvent

constructor(
    type: PointerEventType, 
    mouseX: Double, 
    mouseY: Double, 
    button: Int = MouseButton.NONE
)

Properties

button

val button: Int

mouseX

val mouseX: Double

mouseY

val mouseY: Double

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.