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

Script language

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

MonoBehaviour.OnMouseDrag()

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

OnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse.

OnMouseDrag is called every frame while the mouse is down.

// Darken the material color while user holds down the mouse.
var rend: Renderer;

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

function OnMouseDrag () { rend.material.color -= Color.white * Time.deltaTime; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Renderer rend; void Start() { rend = GetComponent<Renderer>(); } void OnMouseDrag() { rend.material.color -= Color.white * Time.deltaTime; } }

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.

OnMouseDrag 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.