Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

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

Switch to Manual

Description

OnMouseEnter is called when the mouse entered the GUIElement or Collider.

	// Attach this script to a mesh to make
	// it red when the mouse is over the mesh

function OnMouseEnter () { renderer.material.color = Color.red; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void OnMouseEnter() {
        renderer.material.color = Color.red;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def OnMouseEnter() as void:
		renderer.material.color = Color.red

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

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.