Called when the mouse enters the Collider.
The corresponding OnMouseOver function is called while the mouse stays over the object and OnMouseExit is called when it moves away.
// Change the mesh color in response to mouse actions.
using UnityEngine; using System.Collections;
public class ExampleClass : MonoBehaviour { public Renderer rend;
void Start() { rend = GetComponent<Renderer>(); }
// The mesh goes red when the mouse is over it... void OnMouseEnter() { rend.material.color = Color.red; }
// ...the red fades out to cyan as the mouse is held over... void OnMouseOver() { rend.material.color -= new Color(0.1F, 0, 0) * Time.deltaTime; }
// ...and the mesh finally turns white when the mouse moves away. void OnMouseExit() { rend.material.color = Color.white; } }
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.
OnMouseEnter can be a co-routine, simply use the yield statement in the function.
This event is sent to all scripts attached to the Collider.
See Also: OnMouseOver, OnMouseExit.
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.