Version: 2022.3
LanguageEnglish
  • C#

MonoBehaviour.OnMouseUp()

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

OnMouseUp is called when the user has released the mouse button.

Note that OnMouseUp is called even if the mouse is not over the same Collider as the mouse has been pressed down on. For button-like behavior see: OnMouseUpAsButton.

// Register when mouse dragging has ended. OnMouseUp is called
// when the mouse button is released.

using UnityEngine;

public class ExampleClass : MonoBehaviour { void OnMouseUp() { // If your mouse hovers over the GameObject with the script attached, output this message Debug.Log("Drag ended!"); } }

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

OnMouseUp can be a co-routine. Simply use the yield statement in the function. This event is sent to all scripts attached to the Collider.

Additional resources: OnMouseDown, OnMouseDrag.