UserInputService

Class fields

Field	XML type	Value
`Name`	string	UserInputService

Properties

AccelerometerEnabled

bool

Field	XML type	Value
`Name`	string	AccelerometerEnabled
`summary`	string	Returns true if the local device has an accelerometer, false otherwise.

GamepadEnabled

bool

Field	XML type	Value
`Name`	string	GamepadEnabled

GyroscopeEnabled

bool

Field	XML type	Value
`Name`	string	GyroscopeEnabled
`summary`	string	Returns true if the local device has an gyroscope, false otherwise.

KeyboardEnabled

bool

Field	XML type	Value
`Name`	string	KeyboardEnabled
`summary`	string	Returns true if the local device accepts keyboard input, false otherwise.

ModalEnabled

bool

Field	XML type	Value
`Name`	string	ModalEnabled

MouseBehavior

MouseBehavior

Field	XML type	Value
`Name`	string	MouseBehavior

MouseEnabled

bool

Field	XML type	Value
`Name`	string	MouseEnabled
`summary`	string	Returns true if the local device accepts mouse input, false otherwise.

MouseIconEnabled

bool

Field	XML type	Value
`Name`	string	MouseIconEnabled

OverrideMouseIconBehavior

OverrideMouseIconBehavior

Field	XML type	Value
`Name`	string	OverrideMouseIconBehavior

TouchEnabled

bool

Field	XML type	Value
`Name`	string	TouchEnabled
`summary`	string	Returns true if the local device accepts touch input, false otherwise.

UserHeadCFrame

CoordinateFrame

Field	XML type	Value
`Name`	string	UserHeadCFrame

VREnabled

bool

Field	XML type	Value
`Name`	string	VREnabled

Functions

GamepadSupports

(gamepadNum: UserInputType, gamepadKeyCode: KeyCode) → bool

Field	XML type	Value
`Name`	string	GamepadSupports

GetConnectedGamepads

() → Array

Field	XML type	Value
`Name`	string	GetConnectedGamepads

GetDeviceAcceleration

() → Instance

Field	XML type	Value
`Name`	string	GetDeviceAcceleration
`summary`	string	Returns an InputObject that describes the device's current acceleration. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. The delta property describes the amount of rotation that last happened. This event only fires locally.

GetDeviceGravity

() → Instance

Field	XML type	Value
`Name`	string	GetDeviceGravity
`summary`	string	Returns an InputObject that describes the device's current gravity vector. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. The delta property describes the amount of rotation that last happened. This event only fires locally.

GetDeviceRotation

() → Tuple

Field	XML type	Value
`Name`	string	GetDeviceRotation
`summary`	string	Returns an InputObject and a Vector4 that describes the device's current rotation vector. This is fired with an InputObject, which has type Enum.InputType.Gyroscope, and position that shows total rotation in each local device axis. The delta property describes the amount of rotation that last happened. The Vector4 is the device's current quaternion rotation in reference to it's default reference frame. This event only fires locally.

GetFocusedTextBox

() → Instance

Field	XML type	Value
`Name`	string	GetFocusedTextBox

GetGamepadConnected

(gamepadNum: UserInputType) → bool

Field	XML type	Value
`Name`	string	GetGamepadConnected

GetGamepadState

(gamepadNum: UserInputType) → Array

Field	XML type	Value
`Name`	string	GetGamepadState

GetKeysPressed

() → Array

Field	XML type	Value
`Name`	string	GetKeysPressed

GetLastInputType

() → UserInputType

Field	XML type	Value
`Name`	string	GetLastInputType

GetNavigationGamepads

() → Array

Field	XML type	Value
`Name`	string	GetNavigationGamepads

GetPlatform

() → Platform

Field	XML type	Value
`Name`	string	GetPlatform

GetSupportedGamepadKeyCodes

(gamepadNum: UserInputType) → Array

Field	XML type	Value
`Name`	string	GetSupportedGamepadKeyCodes

GetUserCFrame

(type: UserCFrame) → CoordinateFrame

Field	XML type	Value
`Name`	string	GetUserCFrame

IsKeyDown

(keyCode: KeyCode) → bool

Field	XML type	Value
`Name`	string	IsKeyDown

IsNavigationGamepad

(gamepadEnum: UserInputType) → bool

Field	XML type	Value
`Name`	string	IsNavigationGamepad

RecenterUserHeadCFrame

() → void

Field	XML type	Value
`Name`	string	RecenterUserHeadCFrame

SetNavigationGamepad

(gamepadEnum: UserInputType, enabled: bool) → void

Field	XML type	Value
`Name`	string	SetNavigationGamepad

Events

DeviceAccelerationChanged

(acceleration: Instance) → void

Field	XML type	Value
`Name`	string	DeviceAccelerationChanged
`summary`	string	Fired when a user moves a device that has an accelerometer. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. This event only fires locally.

DeviceGravityChanged

(gravity: Instance) → void

Field	XML type	Value
`Name`	string	DeviceGravityChanged
`summary`	string	Fired when the force of gravity changes on a device that has an accelerometer. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. This event only fires locally.

DeviceRotationChanged

(rotation: Instance, cframe: CoordinateFrame) → void

Field	XML type	Value
`Name`	string	DeviceRotationChanged
`summary`	string	Fired when a user rotates a device that has an gyroscope. This is fired with an InputObject, which has type Enum.InputType.Gyroscope, and position that shows total rotation in each local device axis. The delta property describes the amount of rotation that last happened. A second argument of Vector4 is the device's current quaternion rotation in reference to it's default reference frame. This event only fires locally.

GamepadConnected

(gamepadNum: UserInputType) → void

Field	XML type	Value
`Name`	string	GamepadConnected

GamepadDisconnected

(gamepadNum: UserInputType) → void

Field	XML type	Value
`Name`	string	GamepadDisconnected

InputBegan

(input: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	InputBegan
`summary`	string	Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

InputChanged

(input: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	InputChanged
`summary`	string	Fired when a user changes interacting via a Human-Computer Interface device (Mouse move, touch move, mouse wheel, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

InputEnded

(input: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	InputEnded
`summary`	string	Fired when a user stops interacting via a Human-Computer Interface device (Mouse button up, touch end, keyboard button up, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

JumpRequest

() → void

Field	XML type	Value
`Name`	string	JumpRequest

LastInputTypeChanged

(lastInputType: UserInputType) → void

Field	XML type	Value
`Name`	string	LastInputTypeChanged

TextBoxFocusReleased

(textboxReleased: Instance) → void

Field	XML type	Value
`Name`	string	TextBoxFocusReleased
`summary`	string	Fired when a user stops text entry into a textbox (usually by pressing return or clicking/tapping somewhere else on the screen). Argument is the textbox that was taken out of focus. This event only fires locally.

TextBoxFocused

(textboxFocused: Instance) → void

Field	XML type	Value
`Name`	string	TextBoxFocused
`summary`	string	Fired when a user clicks/taps on a textbox to begin text entry. Argument is the textbox that was put in focus. This also fires if a textbox forces focus on the user. This event only fires locally.

TouchEnded

(touch: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchEnded
`summary`	string	Fired when a user moves their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

TouchLongPress

(touchPositions: Array, state: UserInputState, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchLongPress
`summary`	string	Fired when a user holds at least one finger for a short amount of time on the same screen position on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. This event will always fire regardless of game state.

TouchMoved

(touch: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchMoved
`summary`	string	Fired when a user moves their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

TouchPan

(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchPan
`summary`	string	Fired when a user drags at least one finger on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'totalTranslation' is a Vector2, indicating how far the pan gesture has gone from its starting point. 'velocity' is a Vector2 that indicates how quickly the gesture is being performed in each dimension. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. This event will always fire regardless of game state.

TouchPinch

(touchPositions: Array, scale: float, velocity: float, state: UserInputState, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchPinch
`summary`	string	Fired when a user pinches their fingers on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the pinch gesture. 'scale' is a float that indicates the difference from the beginning of the pinch gesture. 'velocity' is a float indicating how quickly the pinch gesture is happening. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. This event will always fire regardless of game state.

TouchRotate

(touchPositions: Array, rotation: float, velocity: float, state: UserInputState, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchRotate
`summary`	string	Fired when a user rotates two fingers on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'rotation' is a float indicating how much the rotation has gone from the start of the gesture. 'velocity' is a float that indicates how quickly the gesture is being performed. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. This event will always fire regardless of game state.

TouchStarted

(touch: Instance, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchStarted
`summary`	string	Fired when a user places their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.

TouchSwipe

(swipeDirection: SwipeDirection, numberOfTouches: int, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchSwipe
`summary`	string	Fired when a user swipes their fingers on a TouchEnabled device. 'swipeDirection' is an Enum.SwipeDirection, indicating the direction the user swiped. 'numberOfTouches' is an int that indicates how many touches were involved with the gesture. This event only fires locally. This event will always fire regardless of game state.

TouchTap

(touchPositions: Array, gameProcessedEvent: bool) → void

Field	XML type	Value
`Name`	string	TouchTap
`summary`	string	Fired when a user taps their finger on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the tap gesture. This event only fires locally. This event will always fire regardless of game state.

UserCFrameChanged

(type: UserCFrame, value: CoordinateFrame) → void

Field	XML type	Value
`Name`	string	UserCFrameChanged

WindowFocusReleased

() → void

Field	XML type	Value
`Name`	string	WindowFocusReleased

WindowFocused

() → void

Field	XML type	Value
`Name`	string	WindowFocused