Class PointerEvent

Event that gets sent out when user interacts with the screen in some way, usually by moving the mouse cursor or using touch input.

Constructors

constructor

Properties

_buttonStates _clickCount _delta _eventButton _isAltHeldDown _isControlHeldDown _isMetaHeldDown _isShiftHeldDown _isUsed _mouseWheelScrollDeltaX _mouseWheelScrollDeltaY _pointerEventType _screenPosition

Accessors

alt button buttonStates clickCount control delta eventButton isAltHeldDown isControlHeldDown isMetaHeldDown isShiftHeldDown isUsed meta mouseWheelScrollDeltaX mouseWheelScrollDeltaY pointerEventType screenPosition scrollDeltaX scrollDeltaY shift

Methods

clone isEqual isEqual

Constructors

constructor

  • new PointerEvent(screenPosition?, delta?, buttonStates?, eventButton?, pointerEventType?, clickCount?, isShiftHeldDown?, isControlHeldDown?, isAltHeldDown?, isMetaHeldDown?, mouseWheelScrollDeltaX?, mouseWheelScrollDeltaY?, isUsed?): PointerEvent

  • Parameters

    • OptionalscreenPosition: Immutable<Vector2>
    • Optionaldelta: Immutable<Vector2>
    • OptionalbuttonStates: Iterable<boolean>
    • OptionaleventButton: EnumValue<PointerButton, number>
    • OptionalpointerEventType: EnumValue<PointerEventType, number>
    • OptionalclickCount: number
    • OptionalisShiftHeldDown: boolean
    • OptionalisControlHeldDown: boolean
    • OptionalisAltHeldDown: boolean
    • OptionalisMetaHeldDown: boolean
    • OptionalmouseWheelScrollDeltaX: number
    • OptionalmouseWheelScrollDeltaY: number
    • OptionalisUsed: boolean

    Returns PointerEvent

Properties

Protected_buttonStates

_buttonStates: boolean[]

Protected_clickCount

_clickCount: number

Protected_delta

_delta: Vector2

Protected_eventButton

_eventButton: EnumValue<PointerButton, number>

Protected_isAltHeldDown

_isAltHeldDown: boolean

Protected_isControlHeldDown

_isControlHeldDown: boolean

Protected_isMetaHeldDown

_isMetaHeldDown: boolean

Protected_isShiftHeldDown

_isShiftHeldDown: boolean

Protected_isUsed

_isUsed: boolean

Protected_mouseWheelScrollDeltaX

_mouseWheelScrollDeltaX: number

Protected_mouseWheelScrollDeltaY

_mouseWheelScrollDeltaY: number

Protected_pointerEventType

_pointerEventType: EnumValue<PointerEventType, number>

Protected_screenPosition

_screenPosition: Vector2

Accessors

alt

  • get alt(): boolean

  • Is alt button on the keyboard being held down.

    Returns boolean

button

  • get button(): EnumValue<PointerButton, number>

  • Button that triggered the pointer event. Might be irrelevant depending on event type. (for example move events don't correspond to a button.

    Returns EnumValue<PointerButton, number>

buttonStates

  • get buttonStates(): boolean[]

  • States of the pointer buttons (for example mouse buttons).

    Returns boolean[]

clickCount

  • get clickCount(): number

  • Number of consecutive mouse clicks, for double-clicks, etc.

    Returns number

control

  • get control(): boolean

  • Is control button on the keyboard being held down.

    Returns boolean

delta

  • get delta(): Vector2

  • Change in movement since last sent event.

    Returns Vector2

eventButton

  • get eventButton(): EnumValue<PointerButton, number>

  • Button that triggered the pointer event. Might be irrelevant depending on event type. (for example move events don't correspond to a button.

    Returns EnumValue<PointerButton, number>

isAltHeldDown

  • get isAltHeldDown(): boolean

  • Is alt button on the keyboard being held down.

    Returns boolean

isControlHeldDown

  • get isControlHeldDown(): boolean

  • Is control button on the keyboard being held down.

    Returns boolean

isMetaHeldDown

  • get isMetaHeldDown(): boolean

  • Is meta (win on Windows, command on macOS) button on the keyboard being held down.

    Returns boolean

isShiftHeldDown

  • get isShiftHeldDown(): boolean

  • Is shift button on the keyboard being held down.

    Returns boolean

isUsed

  • get isUsed(): boolean

  • Returns boolean

meta

  • get meta(): boolean

  • Is meta button on the keyboard being held down.

    Returns boolean

mouseWheelScrollDeltaX

  • get mouseWheelScrollDeltaX(): number

  • Mouse scroll delta X. Only relevant for move events.

    Returns number

mouseWheelScrollDeltaY

  • get mouseWheelScrollDeltaY(): number

  • Mouse scroll delta Y. Only relevant for move events.

    Returns number

pointerEventType

screenPosition

  • get screenPosition(): Vector2

  • Screen position where the input event occurred.

    Returns Vector2

scrollDeltaX

  • get scrollDeltaX(): number

  • Horizontal mouse/trackpad delta. Only relevant for move events.

    Returns number

scrollDeltaY

  • get scrollDeltaY(): number

  • Vertical mouse/trackpad delta. Only relevant for move events.

    Returns number

shift

  • get shift(): boolean

  • Is shift button on the keyboard being held down.

    Returns boolean

Methods

clone

  • clone(): PointerEvent

  • Clones this instance and returns a new PointerEvent with identical values.

    Returns PointerEvent

isEqual

  • isEqual(this, other): boolean

  • Determines if this PointerEvent instance is equal to the other instance.

    Parameters

    Returns boolean

StaticisEqual

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods