Api
Input
Input
chevron_left Input
class
Input

Static Properties

data_objectActionNamesdata_objectAnalogLookdata_objectAnalogMovedata_objectControllerCountdata_objectEnableVirtualCursordata_objectEscapePresseddata_objectMotionDatadata_objectMouseCursorVisibledata_objectMouseDeltadata_objectMouseWheeldata_objectSuppresseddata_objectUsingControllerdata_objectVR

Static Methods

functionsClearfunctionsClearActionsfunctionsDownfunctionsGetActionsfunctionsGetAnalogfunctionsGetButtonOriginfunctionsGetGlyphfunctionsGetGroupNamefunctionsPlayerScopefunctionsPressedfunctionsReleaseActionfunctionsReleaseActionsfunctionsReleasedfunctionsSetActionfunctionsSetLastActionfunctionsStopAllHapticsfunctionsTriggerHaptics
Input
Allows querying of player button presses and other inputs.
class Sandbox .
staticsealedabstractSandbox.Engine

data_object Static Properties 13

ActionNames
IEnumerable`1
Names of all actions from the current game's input settings.
AnalogLook
Angles
Analog look value from the default input device. This is scaled by Preferences.Sensitivity - so you don't need to scale it afterwards.
AnalogMove
Vector3
Analog move value from the default input device.
ControllerCount
int
How many controllers are active right now?
EnableVirtualCursor
bool
Whether or not the Virtual Cursor should show when using a controller. Disable this to control the cursor manually.
EscapePressed
bool
True if escape was pressed
MotionData
InputMotionData
Current state of the current input device's motion sensor(s) if supported. This is only supported on: Dualshock 4+, Switch Controllers, Steam Controller, Steam Deck.
MouseCursorVisible
bool
Whether input is in cursor mode. Can be true even when Sandbox.Mouse.CursorType is "none".
MouseDelta
Vector2
Movement delta from the mouse.
MouseWheel
Vector2
The state of the mouse wheel.
Suppressed
bool
If the input is suppressed then everything will act like there is no input
UsingController
bool
Was the last button pressed a game controller button?
VR
VRInput
Virtual Reality specific input data.

functions Static Methods 17

Clear (action)
Remove this action, so it's no longer being pressed.
ClearActions ()
Clears the current input actions, so that none of them are active.
Down (action, complainOnMissing)
bool
Action is currently pressed down
GetActions ()
IEnumerable`1
Copies all input actions to be used publicly
GetAnalog (analog)
float
An analog input, when fetched, is between -1 and 1 (0 being default)
GetButtonOrigin (name, ignoreController)
string
Returns the name of a key bound to this InputAction For example: Input.GetButtonOrigin( "Undo" ) could return SPACE if using keyboard or A Button when using a controller.
GetGlyph (name, size, outline)
Texture
Get a glyph texture from the controller bound to the action. If no binding is found will return an 'UNBOUND' glyph.
GetGroupName (action)
string
Finds the Sandbox.InputAction.GroupName of the given action.
PlayerScope (player)
IDisposable
Push a specific player scope to be active.
Pressed (action)
bool
Action wasn't pressed but now it is
ReleaseAction (name)
Releases the action, and it won't be active again until it's pressed again.
ReleaseActions ()
Clears the current input actions, so that none of them are active. Unlike ClearActions this will unpress the buttons, so they won't be active again until they're pressed again.
Released (action)
bool
Action was pressed but now it isn't
SetAction (action, down)
SetLastAction (action, down)
StopAllHaptics ()
Stop all vibration events on the current controller.
TriggerHaptics (leftMotor, rightMotor, leftTrigger, rightTrigger, duration)
Trigger a haptic event on supported controllers including Xbox trigger impulse rumble.
one year ago
edited one year ago#1
Anthony
Member
JoinedAug 2022 Posts3 Score345
12 1 1 1
6 months ago
#2
sansirow555
Member
JoinedApr 2026 Posts2 Score335
nahh somebody posted kid named finger 💀  💀 
6 months ago
#3
Vasolix
Member
JoinedDec 2022 Posts2 Score935
So sus
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.