Api Editor MouseEvent
struct

MouseEvent

public sealed struct MouseEvent

Information about a Widgets mouse event.

Properties

Name Type Description
LeftMouseButton Boolean Whether the event was triggered by the left mouse button.
RightMouseButton Boolean Whether the event was triggered by the left mouse button.
MiddleMouseButton Boolean Whether the event was triggered by the left mouse button.
ButtonState MouseButtons The current mouse button state.
Button MouseButtons The mouse button that triggered the event.
LocalPosition Vector2 Position of the mouse cursor relative to the widgets top left corner.
WindowPosition Vector2 Position of the mouse cursor relative to the top left corner of the window the widget belongs to.
ScreenPosition Vector2 Absolute position of the mouse cursor on the screen.
KeyboardModifiers KeyboardModifiers The keyboard modifier keys that were held down at the moment the event triggered.
HasShift Boolean Whether Shift key was being held down at the time of the event.
HasCtrl Boolean Whether Control key was being held down at the time of the event.
HasAlt Boolean Whether Alt key was being held down at the time of the event.
Accepted Boolean Whether this event should be propagated to parent widgets () or not ().
IsDoubleClick Boolean Whether this mouse event was a double click.
Assembly: Sandbox.Tools Namespace: Editor Full Name: Editor.MouseEvent