MouseEventclass

Information about a `Editor.Widget`s mouse event.

objectMouseEvent
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public sealed struct Editor.MouseEvent

Properties14

Showing 14 properties

public bool Editor.MouseEvent.Accepted { get; set; }PUBLICGETSET

Whether this event should be propagated to parent widgets () or not ().

Returns:bool

public bool Editor.MouseEvent.HasAlt { get; set; }PUBLICGETSET

Whether `Alt` key was being held down at the time of the event.

Returns:bool

public bool Editor.MouseEvent.HasCtrl { get; set; }PUBLICGETSET

Whether `Control` key was being held down at the time of the event.

Returns:bool

public bool Editor.MouseEvent.HasShift { get; set; }PUBLICGETSET

Whether `Shift` key was being held down at the time of the event.

Returns:bool

public bool Editor.MouseEvent.IsDoubleClick { get; set; }PUBLICGETSET

Whether this mouse event was a double click.

Returns:bool

public bool Editor.MouseEvent.LeftMouseButton { get; set; }PUBLICGETSET

Whether the event was triggered by the left mouse button.

Returns:bool

public Vector2 Editor.MouseEvent.LocalPosition { get; set; }PUBLICGETSET

Position of the mouse cursor relative to the widgets top left corner.

Returns:Vector2

public bool Editor.MouseEvent.MiddleMouseButton { get; set; }PUBLICGETSET

Whether the event was triggered by the left mouse button.

Returns:bool

public bool Editor.MouseEvent.RightMouseButton { get; set; }PUBLICGETSET

Whether the event was triggered by the left mouse button.

Returns:bool

public Vector2 Editor.MouseEvent.ScreenPosition { get; set; }PUBLICGETSET

Absolute position of the mouse cursor on the screen.

Returns:Vector2

public Vector2 Editor.MouseEvent.WindowPosition { get; set; }PUBLICGETSET

Position of the mouse cursor relative to the top left corner of the window the widget belongs to.

Returns:Vector2

On this page