Unity - Scripting API: MouseButton

enumeration

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

Description

Enumerates the mouse buttons to identify specific mouse button interactions.

Use this enumeration for mouse-related events to identify and respond to specific mouse button interactions. For example, you can check the Button property of a mouse event to determine which button triggered the event.

Additional resources: Button, MouseDownEvent, PointerDownEvent

The following example shows how to use the MouseButton enumeration.

Properties

Property Description
LeftMouse Represents the left mouse button. Typically used for selection or activation.
RightMouse Represents the right mouse button. Typically used to open context menus.
MiddleMouse Represents the middle mouse button.