Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.OnMouseExit()

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

Description

Called when the mouse is not any longer over the GUIElement or Collider.

A call to OnMouseExit follows the corresponding calls to OnMouseEnter and OnMouseOver.

This function is not called on objects that belong to Ignore Raycast layer.

This function is called on Colliders marked as Trigger if and only if Physics.queriesHitTriggers is true.

You can use OnMouseExit as a co-routine if you add a yield statement somewhere in the function. This event is sent to all scripts attached to the Collider or GUIElement.

no example available in JavaScript
//Attach this script to a GameObject to have it output messages when your mouse hovers over it.
using UnityEngine;

public class OnMouseOverExample : MonoBehaviour { void OnMouseOver() { //If your mouse hovers over the GameObject with the script attached, output this message Debug.Log("Mouse is over GameObject."); }

void OnMouseExit() { //The mouse is no longer hovering over the GameObject so output this message each frame Debug.Log("Mouse is no longer on GameObject."); } }

Did you find this page useful? Please give it a rating: