Interface IPointerEventHandler

Implement on your component to receive input events via the EventSystem component

interface IPointerEventHandler {
    onPointerClick?(args): any;
    onPointerDown?(args): any;
    onPointerEnter?(args): any;
    onPointerExit?(args): any;
    onPointerMove?(args): any;
    onPointerUp?(args): any;
}

Hierarchy

  • IPointerDownHandler
  • IPointerUpHandler
  • IPointerEnterHandler
  • IPointerMoveHandler
  • IPointerExitHandler
  • IPointerClickHandler
    • IPointerEventHandler

Implemented by

Methods

onPointerClick? onPointerDown? onPointerEnter? onPointerExit? onPointerMove? onPointerUp?

Methods

Optional onPointerClick

  • onPointerClick(args): any

  • Called when an object (or any child object) is clicked (needs a EventSystem in the scene)

    Parameters

    Returns any

Optional onPointerDown

  • onPointerDown(args): any

  • Called when a button is started to being pressed on an object (or a child object)

    Parameters

    Returns any

Optional onPointerEnter

  • onPointerEnter(args): any

  • Called when a pointer (mouse, touch, xr controller) starts pointing on/hovering an object (or a child object)

    Parameters

    Returns any

Optional onPointerExit

  • onPointerExit(args): any

  • Called when a pointer (mouse, touch, xr controller) exists an object (it was hovering the object before but now it's not anymore)

    Parameters

    Returns any

Optional onPointerMove

  • onPointerMove(args): any

  • Called when a pointer (mouse, touch, xr controller) is moving over an object (or a child object)

    Parameters

    Returns any

Optional onPointerUp

  • onPointerUp(args): any

  • Called when a button is released (which was previously pressed in onPointerDown)

    Parameters

    Returns any

Settings

Member Visibility

Theme

On This Page

onPointerClickonPointerDownonPointerEnteronPointerExitonPointerMoveonPointerUp

Generated using TypeDoc