Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Input.GetMouseButtonDown

static function GetMouseButtonDown(button: int): bool;
static bool GetMouseButtonDown(int button);
static def GetMouseButtonDown(button as int) as bool

Description

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

You need to 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.

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

function 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."); }

using UnityEngine;
using System.Collections;

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.");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		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.')