Version: 2020.2
LanguageEnglish
  • C#

IMouseEvent

interface in UnityEngine.UIElements

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

Interface for mouse events.

Properties

actionKeyReturns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms.
altKeyReturn true if the Alt key is pressed.
buttonInteger that indicates which mouse button is pressed: 0 is the left button, 1 is the right button, 2 is the middle button.
clickCountThe number of times the button is pressed.
commandKeyReturn true if the Windows/Command key is pressed.
ctrlKeyReturn true if the Ctrl key is pressed.
localMousePositionThe mouse position in the current target coordinate system.
modifiersFlag set holding the pressed modifier keys (Alt, Ctrl, Shift, Windows/Command).
mouseDeltaMouse position difference between the last mouse event and this one.
mousePositionThe mouse position in the panel coordinate system.
pressedButtonsA bitmask that describes the currently pressed buttons.
shiftKeyReturn true if the Shift key is pressed.