Legacy Documentation: Version 2018.1 (Go to current version)
  • C#
  • JS

Script language

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


Suggest a change


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.


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.



public var button: int;
public int button;


Which mouse button was pressed.

0 means left mouse button, 1 means right mouse button, 2 means middle mouse button. Used in EventType.MouseDown and EventType.MouseUp events.

// Detect which mouse button is currently pressed
// and print it.
function OnGUI() {
    var e : Event = Event.current;
    if(e.button == 0 && e.isMouse){
        Debug.Log("Left Click");
    } else if(e.button == 1) {
        Debug.Log("Right Click");
    } else if (e.button == 2) {
        Debug.Log("Middle Click");
    } else if (e.button > 2) {
        Debug.Log("Another button in the mouse clicked");
no example available in C#

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