RSX Code Reference
    Preparing search index...
    • rsx
    • PointerEvent

    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.

    Index
    constructor
    _buttonStates _clickCount _delta _eventButton _isAltHeldDown _isControlHeldDown _isMetaHeldDown _isShiftHeldDown _isUsed _mouseWheelScrollDeltaX _mouseWheelScrollDeltaY _pointerEventType _screenPosition
    alt button buttonStates clickCount control delta eventButton isAltHeldDown isControlHeldDown isMetaHeldDown isShiftHeldDown isUsed meta mouseWheelScrollDeltaX mouseWheelScrollDeltaY pointerEventType screenPosition scrollDeltaX scrollDeltaY shift
    clone isEqual isEqual

    • Parameters

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

      Returns PointerEvent

    Protected_buttonStates

    _buttonStates: boolean[]

    Protected_clickCount

    _clickCount: number

    Protected_delta

    _delta: Vector2

    Protected_eventButton

    _eventButton: EnumValue<PointerButton>

    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>

    Protected_screenPosition

    _screenPosition: Vector2
    • get alt(): boolean

      Is alt button on the keyboard being held down.

      Returns boolean

    • get buttonStates(): boolean[]

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

      Returns boolean[]

    • get clickCount(): number

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

      Returns number

    • get control(): boolean

      Is control button on the keyboard being held down.

      Returns boolean

    • get delta(): Vector2

      Change in movement since last sent event.

      Returns Vector2

    • get eventButton(): EnumValue<PointerButton>

      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>

    • get isAltHeldDown(): boolean

      Is alt button on the keyboard being held down.

      Returns boolean

    • get isControlHeldDown(): boolean

      Is control button on the keyboard being held down.

      Returns boolean

    • get isMetaHeldDown(): boolean

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

      Returns boolean

    • get isShiftHeldDown(): boolean

      Is shift button on the keyboard being held down.

      Returns boolean

    • get isUsed(): boolean

      Returns boolean

    • get meta(): boolean

      Is meta button on the keyboard being held down.

      Returns boolean

    • get mouseWheelScrollDeltaX(): number

      Mouse scroll delta X. Only relevant for move events.

      Returns number

    • get mouseWheelScrollDeltaY(): number

      Mouse scroll delta Y. Only relevant for move events.

      Returns number

    • get screenPosition(): Vector2

      Screen position where the input event occurred.

      Returns Vector2

    • get scrollDeltaX(): number

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

      Returns number

    • get scrollDeltaY(): number

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

      Returns number

    • get shift(): boolean

      Is shift button on the keyboard being held down.

      Returns boolean

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

      Returns PointerEvent

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods