Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

Input.GetMouseButtonDown

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

Declaration

public static bool GetMouseButtonDown(int button);

Description

Returns true during the frame the user pressed the given mouse button.

Note: This API is part of the legacy Input class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).

Call this function from the Update function, since the state gets reset each frame. It will not return true until the user has released the mouse button and pressed it again. button values are 0 for left button, 1 for right button, 2 for the middle button.

using UnityEngine;
using System.Collections;

// Detects clicks from the mouse and prints a message // depending on the click detected.

public class ExampleClass : MonoBehaviour { void Update() { if (Input.GetMouseButtonDown(0)) Debug.Log("Pressed left-click.");

if (Input.GetMouseButtonDown(1)) Debug.Log("Pressed right-click.");

if (Input.GetMouseButtonDown(2)) Debug.Log("Pressed middle-click."); } }