Version: 2022.2
LanguageEnglish
  • C#

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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> 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

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

OnMouseDrag is called every frame while the mouse is down.

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; } }

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

This function is called on Colliders and 2D Colliders marked as trigger when the following properties are set to true:

- For 3D physics: Physics.queriesHitTriggers

- For 2D physics: Physics2D.queriesHitTriggers

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.