Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IMouseEvent

Interface for mouse events.
Read time 1 minuteLast updated 9 days ago

Definition

public interface IMouseEvent

Remarks

Refer to the Mouse events manual page for more information and examples.

Properties

Property

Description

actionKeyReturns true if the platform-specific action key is pressed.
altKeyReturn true if the Alt key is pressed.
buttonA value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event.
clickCountThe number of times a button is pressed consecutively.
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).
mouseDeltaGets the difference between the mouse's position during the previous mouse event and its position during the current mouse event.
mousePositionThe mouse position in the panel coordinate system.
pressedButtonsA bitmask that describes the currently pressed buttons.
shiftKeyReturn true if the Shift key is pressed.