Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

EventSystem.IsPointerOverGameObject

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

Switch to Manual
public function IsPointerOverGameObject(): bool;
public bool IsPointerOverGameObject();
public function IsPointerOverGameObject(pointerId: int): bool;
public bool IsPointerOverGameObject(int pointerId);

Parameters

pointerId Pointer (touch / mouse) id.

Description

Is the pointer with the given id over an EventSystem object?

function Update()
	{
		if(Input.GetMouseButtonDown(0))
		{
			if(!EventSystems.EventSystem.current.IsPointerOverGameObject())
			{
				Debug.Log("Did not Click on the UI");
			}
		}
	}
using UnityEngine;
using System.Collections;
using UnityEngine.EventSystems;

public class example : MonoBehaviour {

void Update () { // Check if the left mouse button was clicked if(Input.GetMouseButtonDown(0)) { // Check if the mouse was clicked over a UI element if(!EventSystem.current.IsPointerOverGameObject()) { Debug.Log("Did not Click on the UI"); } } } }

Note on C# that they will need to add "using UnityEngine.EventSystems;" Note that with C# you will need to add "using UnityEngine.EventSystems;".