Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetMouseButtonDown(int)

Returns true during the frame the user pressed the given mouse button.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.InputLegacyModule
public static bool GetMouseButtonDown(int button)

Parameters

button

int

Returns

Type

Description

bool

Remarks

Note: This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input.
Call this function from the MonoBehaviour.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.

Examples

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