Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PointerEventData

Namespace: UnityEngine.EventSystems

/

Inherits from: EventSystems.BaseEventData

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Event payload associated with pointer (mouse / touch) events.

Variables

button Which input button triggerd the event.
clickCount Number of clicks in a row.
clickTime The last time a click event was sent.
delta Pointer delta since last update.
dragging Is the pointer being dragged.
enterEventCamera The camera associated with the last OnPointerEnter event.
lastPress The GameObject that was pressed on last.
pointerCurrentRaycast RaycastResult associated with the current event.
pointerDrag The object that is receiving 'OnDrag'.
pointerEnter The object that received 'OnPointerEnter'.
pointerId Id of the pointer (touch id).
pointerPress The GameObject that received the OnPointerDown.
pointerPressRaycast RaycastResult associated with the pointer press.
position Current pointer position.
pressEventCamera The camera associated with the last OnPointerPress event.
pressPosition Position of the press.
rawPointerPress The object that the press happened on even if it can not handle the press event.
scrollDelta The amount of scroll since the last update.
useDragThreshold Should a drag threshold be used?
worldNormal World-space normal where a ray cast into the screen hits something.
worldPosition World-space position where a ray cast into the screen hits something.

Functions

IsPointerMoving Is the pointer moving.
IsScrolling Is scroll being used on the input device.

Inherited members

Variables

currentInputModule A reference to the BaseInputModule that sent this event.
selectedObject The object currently considered selected by the EventSystem.
used Has the event been marked as used?

Functions

Reset Reset the Event to the default state.
Use Use the event.