Interface IPointerEventHandler

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

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

Hierarchy (view full)

IPointerDownHandler
IPointerUpHandler
IPointerEnterHandler
IPointerMoveHandler
IPointerExitHandler
IPointerClickHandler
- IPointerEventHandler

Implemented by

Index

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
- args: PointerEventData
Returns any
Inherited from IPointerClickHandler.onPointerClick

`Optional`onPointerDown

onPointerDown(args): any
Called when a button is started to being pressed on an object (or a child object)
Parameters
- args: PointerEventData
Returns any
Inherited from IPointerDownHandler.onPointerDown

`Optional`onPointerEnter

onPointerEnter(args): any
Called when a pointer (mouse, touch, xr controller) starts pointing on/hovering an object (or a child object)
Parameters
- args: PointerEventData
Returns any
Inherited from IPointerEnterHandler.onPointerEnter

`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
- args: PointerEventData
Returns any
Inherited from IPointerExitHandler.onPointerExit

`Optional`onPointerMove

onPointerMove(args): any
Called when a pointer (mouse, touch, xr controller) is moving over an object (or a child object)
Parameters
- args: PointerEventData
Returns any
Inherited from IPointerMoveHandler.onPointerMove

`Optional`onPointerUp

onPointerUp(args): any
Called when a button is released (which was previously pressed in onPointerDown)
Parameters
- args: PointerEventData
Returns any
Inherited from IPointerUpHandler.onPointerUp