public static abstract sealed class Sandbox.Mouse
Gives access to mouse position etc
Related Guides
Broader workflow and conceptual references connected to this API.
There are various interfaces that can be given to components for specific purposes.
You can broadcast and listen to events in your scene using interfaces.
Input is accessed using theโฆ Input class!
The scope based system works by creating a snapshot of a change set when the scope is entered and another one when the scope is disposed of. The system will automatically take care of restoring the state on undo/redo.
Properties
Showing 7 properties
public static bool Sandbox.Mouse.Active { get; set; }
Whether the local clients' cursor is active or not, meaning it can interact with UI elements, etc.
public static string Sandbox.Mouse.CursorType { get; set; }
Sets the cursor type until another panel stomps this value. Doesn't affect main menu.
public static Vector2 Sandbox.Mouse.Delta { get; set; }
Change in local clients' cursor position since last frame.
public static Vector2 Sandbox.Mouse.Position { get; set; }
Access to local clients' cursor position, relative to game windows' top left corner.
public static Sandbox.MouseVisibility Sandbox.Mouse.Visibility { get; set; }
The visibility state of the mouse cursor. Auto will only show the mouse when clickable UI elements are visible.
public static bool Sandbox.Mouse.Visible { get; set; }Obsolete
DEPRECATED. Use Mouse.Visibility instead.
Obsolete: This API member is obsolete.
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.Mouse |