Called every frame while the mouse is over the Collider.
A call to OnMouseEnter occurs on the first frame the mouse is over the object.
OnMouseOver is then called each frame until the mouse moves away, at which point OnMouseExit
is called.
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.
OnMouseOver can be a co-routine, simply use the yield statement in the function.
This event is sent to all scripts attached to the Collider.
//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."); } }
Another example:
// This second example changes the GameObject's color to red when the mouse hovers over it // Ensure the GameObject has a MeshRenderer
using UnityEngine;
public class OnMouseOverColor : MonoBehaviour { //When the mouse hovers over the GameObject, it turns to this color (red) Color m_MouseOverColor = Color.red;
//This stores the GameObject’s original color Color m_OriginalColor;
//Get the GameObject’s mesh renderer to access the GameObject’s material and color MeshRenderer m_Renderer;
void Start() { //Fetch the mesh renderer component from the GameObject m_Renderer = GetComponent<MeshRenderer>(); //Fetch the original color of the GameObject m_OriginalColor = m_Renderer.material.color; }
void OnMouseOver() { // Change the color of the GameObject to red when the mouse is over GameObject m_Renderer.material.color = m_MouseOverColor; }
void OnMouseExit() { // Reset the color of the GameObject back to normal m_Renderer.material.color = m_OriginalColor; } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.