Version: 2018.4
LanguageEnglish
  • C#

Button.OnPointerClick

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

Submission failed

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

Close

Cancel

Declaration

public void OnPointerClick(EventSystems.PointerEventData eventData);

Parameters

eventData Data passed in (Typically by the event system).

Description

Registered IPointerClickHandler callback.

Register button presses using the IPointerClickHandler. You can also use it to tell what type of click happened (left, right etc.). Make sure your Scene has an EventSystem. If not, go to Create>UI>Event System.

//Attatch this script to a Button GameObject
using UnityEngine;
using UnityEngine.EventSystems;

public class Example : MonoBehaviour, IPointerClickHandler { //Detect if a click occurs public void OnPointerClick(PointerEventData pointerEventData) { //Use this to tell when the user right-clicks on the Button if (pointerEventData.button == PointerEventData.InputButton.Right) { //Output to console the clicked GameObject's name and the following message. You can replace this with your own actions for when clicking the GameObject. Debug.Log(name + " Game Object Right Clicked!"); }

//Use this to tell when the user left-clicks on the Button if (pointerEventData.button == PointerEventData.InputButton.Left) { Debug.Log(name + " Game Object Left Clicked!"); } } }