Version: 5.4 (switch to 5.5b)
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.OnMouseEnter()

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

Description

Called when the mouse enters the GUIElement or 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.
var rend: Renderer;

function Start() { rend = GetComponent.<Renderer>(); }

// The mesh goes red when the mouse is over it... function OnMouseEnter () { rend.material.color = Color.red; }

// ...the red fades out to cyan as the mouse is held over... function OnMouseOver () { rend.material.color -= Color(0.1, 0, 0) * Time.deltaTime; }

// ...and the mesh finally turns white when the mouse moves away. function OnMouseExit () { rend.material.color = Color.white; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Renderer rend; void Start() { rend = GetComponent<Renderer>(); } void OnMouseEnter() { rend.material.color = Color.red; } void OnMouseOver() { rend.material.color -= new Color(0.1F, 0, 0) * Time.deltaTime; } 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 or GUIElement.

See Also: OnMouseOver, OnMouseExit.