UserInputService

Show Deprecated

Not Creatable

Service

Not Replicated

Summary

Properties

AccelerometerEnabled:boolean
Read Only
Not Replicated
Read Parallel
GamepadEnabled:boolean
Read Only
Not Replicated
Read Parallel
GyroscopeEnabled:boolean
Read Only
Not Replicated
Read Parallel
KeyboardEnabled:boolean
Read Only
Not Replicated
Read Parallel
MouseBehavior:Enum.MouseBehavior
Read Parallel
MouseDeltaSensitivity:number
Not Replicated
Read Parallel
MouseEnabled:boolean
Read Only
Not Replicated
Read Parallel
MouseIcon:ContentId
Read Parallel
MouseIconEnabled:boolean
Read Parallel
OnScreenKeyboardPosition:Vector2
Read Only
Not Replicated
Read Parallel
OnScreenKeyboardSize:Vector2
Read Only
Not Replicated
Read Parallel
OnScreenKeyboardVisible:boolean
Read Only
Not Replicated
Read Parallel
PreferredInput:Enum.PreferredInput
Read Only
Not Replicated
Read Parallel
TouchEnabled:boolean
Read Only
Not Replicated
Read Parallel
VREnabled:boolean
Read Only
Not Replicated
Read Parallel

View all inherited from Instance

View all inherited from Object

Methods

GamepadSupports(gamepadNum : Enum.UserInputType,gamepadKeyCode : Enum.KeyCode):boolean
GetConnectedGamepads():Array
GetDeviceAcceleration():InputObject
GetDeviceGravity():InputObject
GetDeviceRotation():Tuple
GetFocusedTextBox():TextBox
GetGamepadConnected(gamepadNum : Enum.UserInputType):boolean
GetGamepadState(gamepadNum : Enum.UserInputType):Array
GetImageForKeyCode(keyCode : Enum.KeyCode):ContentId
GetKeysPressed():Array
GetLastInputType():Enum.UserInputType
GetMouseButtonsPressed():Array
GetMouseDelta():Vector2
GetMouseLocation():Vector2
GetNavigationGamepads():Array
GetStringForKeyCode(keyCode : Enum.KeyCode):string
GetSupportedGamepadKeyCodes(gamepadNum : Enum.UserInputType):Array
IsGamepadButtonDown(gamepadNum : Enum.UserInputType,gamepadKeyCode : Enum.KeyCode):boolean
IsKeyDown(keyCode : Enum.KeyCode):boolean
IsMouseButtonPressed(mouseButton : Enum.UserInputType):boolean
IsNavigationGamepad(gamepadEnum : Enum.UserInputType):boolean
RecenterUserHeadCFrame():()
SetNavigationGamepad(gamepadEnum : Enum.UserInputType,enabled : boolean):()

View all inherited from Instance

View all inherited from Object

Events

DeviceAccelerationChanged(acceleration : InputObject):RBXScriptSignal
DeviceGravityChanged(gravity : InputObject):RBXScriptSignal
DeviceRotationChanged(rotation : InputObject,cframe : CFrame):RBXScriptSignal
GamepadConnected(gamepadNum : Enum.UserInputType):RBXScriptSignal
GamepadDisconnected(gamepadNum : Enum.UserInputType):RBXScriptSignal
InputBegan(input : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
InputChanged(input : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
InputEnded(input : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
JumpRequest():RBXScriptSignal
LastInputTypeChanged(lastInputType : Enum.UserInputType):RBXScriptSignal
PointerAction(wheel : number,pan : Vector2,pinch : number,gameProcessedEvent : boolean):RBXScriptSignal
TextBoxFocusReleased(textboxReleased : TextBox):RBXScriptSignal
TextBoxFocused(textboxFocused : TextBox):RBXScriptSignal
TouchDrag(dragDirection : Enum.SwipeDirection,numberOfTouches : number,gameProcessedEvent : boolean):RBXScriptSignal
TouchEnded(touch : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
TouchLongPress(touchPositions : Array,state : Enum.UserInputState,gameProcessedEvent : boolean):RBXScriptSignal
TouchMoved(touch : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
TouchPan(touchPositions : Array,totalTranslation : Vector2,velocity : Vector2,state : Enum.UserInputState,gameProcessedEvent : boolean):RBXScriptSignal
TouchPinch(touchPositions : Array,scale : number,velocity : number,state : Enum.UserInputState,gameProcessedEvent : boolean):RBXScriptSignal
TouchRotate(touchPositions : Array,rotation : number,velocity : number,state : Enum.UserInputState,gameProcessedEvent : boolean):RBXScriptSignal
TouchStarted(touch : InputObject,gameProcessedEvent : boolean):RBXScriptSignal
TouchSwipe(swipeDirection : Enum.SwipeDirection,numberOfTouches : number,gameProcessedEvent : boolean):RBXScriptSignal
TouchTap(touchPositions : Array,gameProcessedEvent : boolean):RBXScriptSignal
TouchTapInWorld(position : Vector2,processedByUI : boolean):RBXScriptSignal
WindowFocusReleased():RBXScriptSignal
WindowFocused():RBXScriptSignal

UserInputService

Summary

Properties

Methods

Events

Properties

Methods

Events

On this page