Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetMouseButton(int)

Returns whether the given mouse button is held down.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.InputLegacyModule
public static bool GetMouseButton(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.
The button values are: 0 for the left button, 1 for the right button, 2 for the middle button. The return is 
true
when the mouse button is pressed down, and 
false
when released.

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.GetMouseButton(0))        {            Debug.Log("The left mouse button is being held down.");        }        if (Input.GetMouseButton(1))        {            Debug.Log("The right mouse button is being held down.");        }        if (Input.GetMouseButton(2))        {            Debug.Log("The middle mouse button is being held down.");        }    }}