s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
results
Game Jam III
Crowned
Sat 3 Oct
Winner
🏆 GAMMA ☢ TEAM
Theme
One More Round
This jam is over. The next one will show up here.
See the results
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
Get s&box
Sign in with Steam
Api
Input
Mouse
chevron_left
Input
class
Mouse
Static Properties
data_object
Active
data_object
CursorType
data_object
Delta
data_object
Position
data_object
Velocity
data_object
Visibility
remove_circle
Visible
Mouse
Gives access to mouse position etc
class
Sandbox
.
static
sealed
abstract
Sandbox.Engine
data_object
Static Properties
7
Active
bool
Whether the local clients' cursor is active or not, meaning it can interact with UI elements, etc.
CursorType
string
Sets the cursor type used when the UI hasn't claimed the cursor (e.g. when the mouse falls through the UI onto the world). UI panel hover cursors take precedence over this.
Delta
Vector2
Change in local clients' cursor position since last frame.
Position
Vector2
Access to local clients' cursor position, relative to game windows' top left corner.
Velocity
Vector2
Visibility
MouseVisibility
The visibility state of the mouse cursor. Auto will only show the mouse when clickable UI elements are visible.
Visible
obsolete
bool
DEPRECATED. Use Mouse.Visibility instead.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.