Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

Input.GetMouseButton

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

public static method GetMouseButton(button: int): bool;
public static bool GetMouseButton(int button);

Description

Returns whether the given mouse button is held down.

button values are 0 for left button, 1 for right button, 2 for the middle button.

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

function Update() { if(Input.GetMouseButton(0)) Debug.Log("Pressed left click."); if(Input.GetMouseButton(1)) Debug.Log("Pressed right click."); if(Input.GetMouseButton(2)) Debug.Log("Pressed middle click."); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update() { if (Input.GetMouseButton(0)) Debug.Log("Pressed left click."); if (Input.GetMouseButton(1)) Debug.Log("Pressed right click."); if (Input.GetMouseButton(2)) Debug.Log("Pressed middle click."); } }

Did you find this page useful? Please give it a rating: