UserInputService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (77)

Type	Member	History
bool	AccelerometerEnabled	168
Vector2	BottomBarSize	314 469
bool	GamepadEnabled
bool	GazeSelectionEnabled	262
bool	GyroscopeEnabled	168
bool	KeyboardEnabled
bool	LegacyInputEventsEnabled	334 469
bool	ModalEnabled	118 493
MouseBehavior	MouseBehavior	158
float	MouseDeltaSensitivity	246
bool	MouseEnabled
Content	MouseIcon	563
bool	MouseIconEnabled	158
Vector2	NavBarSize	314 469
double	OnScreenKeyboardAnimationDuration	308 469
Vector2	OnScreenKeyboardPosition	281
Vector2	OnScreenKeyboardSize	281
bool	OnScreenKeyboardVisible	281
OverrideMouseIconBehavior	OverrideMouseIconBehavior	208 469
Vector2	RightBarSize	360 469
Vector2	StatusBarSize	314 469
bool	TouchEnabled
CFrame	UserHeadCFrame	229 236
bool	VREnabled	230
bool	GamepadSupports (UserInputType gamepadNum, KeyCode gamepadKeyCode)	185
Array	GetConnectedGamepads ()	217
InputObject	GetDeviceAcceleration ()	168 483
InputObject	GetDeviceGravity ()	168 483
Tuple	GetDeviceRotation ()	168
DeviceType	GetDeviceType ()	377
TextBox	GetFocusedTextBox ()	213 483
bool	GetGamepadConnected (UserInputType gamepadNum)	185
Array	GetGamepadState (UserInputType gamepadNum)	185
Array	GetKeysPressed ()	189 188 189
UserInputType	GetLastInputType ()	208 226
Array	GetMouseButtonsPressed ()	297
Vector2	GetMouseDelta ()	297
Vector2	GetMouseLocation ()	297
Array	GetNavigationGamepads ()	217
Platform	GetPlatform ()	156
string	GetStringForKeyCode (KeyCode keyCode)	379
Array	GetSupportedGamepadKeyCodes (UserInputType gamepadNum)	185
CFrame	GetUserCFrame (UserCFrame type)	236
bool	IsGamepadButtonDown (UserInputType gamepadNum, KeyCode gamepadKeyCode)	330
bool	IsKeyDown (KeyCode keyCode)	189 188 189
bool	IsMouseButtonPressed (UserInputType mouseButton)	297
bool	IsNavigationGamepad (UserInputType gamepadEnum)	207
void	RecenterUserHeadCFrame ()	234
void	SendAppUISizes (Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize, Vector2 rightBarSize)	315 360
void	SetNavigationGamepad (UserInputType gamepadEnum, bool enabled)	207
	DeviceAccelerationChanged (InputObject acceleration)	168 483
	DeviceGravityChanged (InputObject gravity)	168 483
	DeviceRotationChanged (InputObject rotation, CFrame cframe)	168 483
	GamepadConnected (UserInputType gamepadNum)	185
	GamepadDisconnected (UserInputType gamepadNum)	185
	InputBegan (InputObject input, bool gameProcessedEvent)	128 133 138 161 483
	InputChanged (InputObject input, bool gameProcessedEvent)	128 133 138 161 483
	InputEnded (InputObject input, bool gameProcessedEvent)	128 133 138 161 483
	JumpRequest ()	113 118
	LastInputTypeChanged (UserInputType lastInputType)	208 226
	PointerAction (float wheel, Vector2 pan, float pinch, bool gameProcessedEvent)	398
	StatusBarTapped (Vector2 position)	322
	TextBoxFocusReleased (TextBox textboxReleased)	161 483
	TextBoxFocused (TextBox textboxFocused)	161 483
	TouchEnded (InputObject touch, bool gameProcessedEvent)	113 128 133 138 161 483
	TouchLongPress (Array touchPositions, UserInputState state, bool gameProcessedEvent)	113 128 128 130 131 138 161
	TouchMoved (InputObject touch, bool gameProcessedEvent)	113 128 133 138 161 483
	TouchPan (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state, bool gameProcessedEvent)	130 131 138 161
	TouchPinch (Array touchPositions, float scale, float velocity, UserInputState state, bool gameProcessedEvent)	113 128 130 131 138 161
	TouchRotate (Array touchPositions, float rotation, float velocity, UserInputState state, bool gameProcessedEvent)	113 128 130 131 138 161
	TouchStarted (InputObject touch, bool gameProcessedEvent)	113 128 133 138 161 483
	TouchSwipe (SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent)	113 128 128 138 161
	TouchTap (Array touchPositions, bool gameProcessedEvent)	113 128 131 138 161
	TouchTapInWorld (Vector2 position, bool processedByUI)	297
	UserCFrameChanged (UserCFrame type, CFrame value)	236
	WindowFocusReleased ()	189 188 189
	WindowFocused ()	189 188 189
51 members inherited from Instance

Removed member index (9)

Type	Member	History
bool	InCameraGesture	150 220
bool	IsVREnabled	229 230 240
bool	OverrideMouseIconEnabled	168 220
bool	TouchControlsEnabled	115 118
bool	IsLuaTouchControls ()	131 230
bool	IsStudioTouchEmulationEnabled ()	171 230
void	RotateCamera (Vector2 positionDelta)	131 230
void	ZoomCamera (float zoomDelta)	131 230
	ProcessedEvent (Instance inputObject, bool processed)	143 230

563 Add UserInputService.MouseIcon
493 Change Tags of UserInputService.ModalEnabled from [] to [Deprecated]
483 Change ReturnType of UserInputService.GetDeviceAcceleration from Instance to InputObject
483 Change ReturnType of UserInputService.GetDeviceGravity from Instance to InputObject
483 Change ReturnType of UserInputService.GetFocusedTextBox from Instance to TextBox
483 Change Parameters of UserInputService.DeviceAccelerationChanged from (Instance acceleration) to (InputObject acceleration)
483 Change Parameters of UserInputService.DeviceGravityChanged from (Instance gravity) to (InputObject gravity)
483 Change Parameters of UserInputService.DeviceRotationChanged from (Instance rotation, CFrame cframe) to (InputObject rotation, CFrame cframe)
483 Change Parameters of UserInputService.InputBegan from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
483 Change Parameters of UserInputService.InputChanged from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
483 Change Parameters of UserInputService.InputEnded from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
483 Change Parameters of UserInputService.TextBoxFocusReleased from (Instance textboxReleased) to (TextBox textboxReleased)
483 Change Parameters of UserInputService.TextBoxFocused from (Instance textboxFocused) to (TextBox textboxFocused)
483 Change Parameters of UserInputService.TouchEnded from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
483 Change Parameters of UserInputService.TouchMoved from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
483 Change Parameters of UserInputService.TouchStarted from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
469 Change Tags of UserInputService.BottomBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of UserInputService.LegacyInputEventsEnabled from [] to [Hidden]
469 Change Tags of UserInputService.NavBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of UserInputService.OnScreenKeyboardAnimationDuration from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of UserInputService.OverrideMouseIconBehavior from [] to [Hidden]
469 Change Tags of UserInputService.RightBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of UserInputService.StatusBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
398 Add UserInputService.PointerAction
379 Add UserInputService.GetStringForKeyCode
377 Add UserInputService.GetDeviceType
360 Add UserInputService.RightBarSize
360 Change Parameters of UserInputService.SendAppUISizes from (Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize) to (Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize, Vector2 rightBarSize)
334 Add UserInputService.LegacyInputEventsEnabled
330 Add UserInputService.IsGamepadButtonDown
322 Add UserInputService.StatusBarTapped
315 Add UserInputService.SendAppUISizes
314 Add UserInputService.BottomBarSize
314 Add UserInputService.NavBarSize
314 Add UserInputService.StatusBarSize
308 Add UserInputService.OnScreenKeyboardAnimationDuration
297 Add UserInputService.GetMouseButtonsPressed
297 Add UserInputService.GetMouseDelta
297 Add UserInputService.GetMouseLocation
297 Add UserInputService.IsMouseButtonPressed
297 Add UserInputService.TouchTapInWorld
281 Add UserInputService.OnScreenKeyboardPosition
281 Add UserInputService.OnScreenKeyboardSize
281 Add UserInputService.OnScreenKeyboardVisible
262 Add UserInputService.GazeSelectionEnabled
246 Add UserInputService.MouseDeltaSensitivity
240 Remove UserInputService.IsVREnabled
236 Change Tags of UserInputService.UserHeadCFrame from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
236 Add UserInputService.GetUserCFrame
236 Add UserInputService.UserCFrameChanged
234 Add UserInputService.RecenterUserHeadCFrame
230 Change Tags of UserInputService.IsVREnabled from [ReadOnly] to [ReadOnly, Deprecated]
230 Add UserInputService.VREnabled
230 Remove UserInputService.IsLuaTouchControls
230 Remove UserInputService.IsStudioTouchEmulationEnabled
230 Remove UserInputService.RotateCamera
230 Remove UserInputService.ZoomCamera
230 Remove UserInputService.ProcessedEvent
229 Add UserInputService.IsVREnabled
229 Add UserInputService.UserHeadCFrame
226 Change Security of UserInputService.GetLastInputType from RobloxScriptSecurity to None
226 Change Security of UserInputService.LastInputTypeChanged from RobloxScriptSecurity to None
220 Remove UserInputService.InCameraGesture
220 Remove UserInputService.OverrideMouseIconEnabled
217 Add UserInputService.GetConnectedGamepads
217 Add UserInputService.GetNavigationGamepads
213 Add UserInputService.GetFocusedTextBox
208 Add UserInputService.OverrideMouseIconBehavior
208 Add UserInputService.GetLastInputType
208 Add UserInputService.LastInputTypeChanged
207 Add UserInputService.IsNavigationGamepad
207 Add UserInputService.SetNavigationGamepad
189 Add UserInputService.GetKeysPressed
189 Add UserInputService.IsKeyDown
189 Add UserInputService.WindowFocusReleased
189 Add UserInputService.WindowFocused
188 Remove UserInputService.GetKeysPressed
188 Remove UserInputService.IsKeyDown
188 Remove UserInputService.WindowFocusReleased
188 Remove UserInputService.WindowFocused
189 Add UserInputService.GetKeysPressed
189 Add UserInputService.IsKeyDown
189 Add UserInputService.WindowFocusReleased
189 Add UserInputService.WindowFocused
185 Add UserInputService.GamepadSupports
185 Add UserInputService.GetGamepadConnected
185 Add UserInputService.GetGamepadState
185 Add UserInputService.GetSupportedGamepadKeyCodes
185 Add UserInputService.GamepadConnected
185 Add UserInputService.GamepadDisconnected
171 Add UserInputService.IsStudioTouchEmulationEnabled
168 Add UserInputService.AccelerometerEnabled
168 Add UserInputService.GyroscopeEnabled
168 Add UserInputService.OverrideMouseIconEnabled
168 Add UserInputService.GetDeviceAcceleration
168 Add UserInputService.GetDeviceGravity
168 Add UserInputService.GetDeviceRotation
168 Add UserInputService.DeviceAccelerationChanged
168 Add UserInputService.DeviceGravityChanged
168 Add UserInputService.DeviceRotationChanged
161 Change Parameters of UserInputService.InputBegan from (Instance input) to (Instance input, bool gameProcessedEvent)
161 Change Parameters of UserInputService.InputChanged from (Instance input) to (Instance input, bool gameProcessedEvent)
161 Change Parameters of UserInputService.InputEnded from (Instance input) to (Instance input, bool gameProcessedEvent)
161 Add UserInputService.TextBoxFocusReleased
161 Add UserInputService.TextBoxFocused
161 Change Parameters of UserInputService.TouchEnded from (Instance touch) to (Instance touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchLongPress from (Array touchPositions, UserInputState state) to (Array touchPositions, UserInputState state, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchMoved from (Instance touch) to (Instance touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchPan from (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchPinch from (Array touchPositions, float scale, float velocity, UserInputState state) to (Array touchPositions, float scale, float velocity, UserInputState state, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchRotate from (Array touchPositions, float rotation, float velocity, UserInputState state) to (Array touchPositions, float rotation, float velocity, UserInputState state, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchStarted from (Instance touch) to (Instance touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchSwipe from (SwipeDirection swipeDirection, int numberOfTouches) to (SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchTap from (Array touchPositions) to (Array touchPositions, bool gameProcessedEvent)
158 Add UserInputService.MouseBehavior
158 Add UserInputService.MouseIconEnabled
156 Add UserInputService.GetPlatform
150 Add UserInputService.InCameraGesture
143 Add UserInputService.ProcessedEvent
138 Change Security of UserInputService.InputBegan from RobloxScriptSecurity to None
138 Change Security of UserInputService.InputChanged from RobloxScriptSecurity to None
138 Change Security of UserInputService.InputEnded from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchEnded from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchLongPress from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchMoved from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchPan from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchPinch from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchRotate from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchStarted from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchSwipe from RobloxScriptSecurity to None
138 Change Security of UserInputService.TouchTap from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.InputBegan from (InputObject input) to (Instance input)
133 Change Parameters of UserInputService.InputChanged from (InputObject input) to (Instance input)
133 Change Parameters of UserInputService.InputEnded from (InputObject input) to (Instance input)
133 Change Parameters of UserInputService.TouchEnded from (InputObject touch) to (Instance touch)
133 Change Parameters of UserInputService.TouchMoved from (InputObject touch) to (Instance touch)
133 Change Parameters of UserInputService.TouchStarted from (InputObject touch) to (Instance touch)
131 Add UserInputService.IsLuaTouchControls
131 Add UserInputService.RotateCamera
131 Add UserInputService.ZoomCamera
131 Change Parameters of UserInputService.TouchLongPress from (UserInputState position, Vector2 state) to (Array touchPositions, UserInputState state)
131 Change Parameters of UserInputService.TouchPan from (Vector2 totalTranslation, Vector2 velocity, int numberOfTouches, UserInputState state, Vector2 position) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state)
131 Change Parameters of UserInputService.TouchPinch from (float scale, float velocity, UserInputState state, Vector2 position) to (Array touchPositions, float scale, float velocity, UserInputState state)
131 Change Parameters of UserInputService.TouchRotate from (float rotation, float velocity, UserInputState state, Vector2 position) to (Array touchPositions, float rotation, float velocity, UserInputState state)
131 Change Parameters of UserInputService.TouchTap from (Vector2 position) to (Array touchPositions)
130 Change Parameters of UserInputService.TouchLongPress from (Vector2 position, UserInputState state) to (UserInputState position, Vector2 state)
130 Add UserInputService.TouchPan
130 Change Parameters of UserInputService.TouchPinch from (float scale, float velocity) to (float scale, float velocity, UserInputState state, Vector2 position)
130 Change Parameters of UserInputService.TouchRotate from (float rotation, float velocity) to (float rotation, float velocity, UserInputState state, Vector2 position)
128 Add UserInputService.InputBegan
128 Add UserInputService.InputChanged
128 Add UserInputService.InputEnded
128 Change Security of UserInputService.TouchEnded from RobloxSecurity to RobloxScriptSecurity
128 Change Parameters of UserInputService.TouchLongPress from (Vector2 position) to (Vector2 position, UserInputState state)
128 Change Security of UserInputService.TouchLongPress from RobloxSecurity to RobloxScriptSecurity
128 Change Security of UserInputService.TouchMoved from RobloxSecurity to RobloxScriptSecurity
128 Change Security of UserInputService.TouchPinch from RobloxSecurity to RobloxScriptSecurity
128 Change Security of UserInputService.TouchRotate from RobloxSecurity to RobloxScriptSecurity
128 Change Security of UserInputService.TouchStarted from RobloxSecurity to RobloxScriptSecurity
128 Change Parameters of UserInputService.TouchSwipe from (SwipeDirection swipeDirection) to (SwipeDirection swipeDirection, int numberOfTouches)
128 Change Security of UserInputService.TouchSwipe from RobloxSecurity to RobloxScriptSecurity
128 Change Security of UserInputService.TouchTap from RobloxSecurity to RobloxScriptSecurity
118 Add UserInputService.ModalEnabled
118 Remove UserInputService.TouchControlsEnabled
118 Change Security of UserInputService.JumpRequest from RobloxPlaceSecurity to None
115 Add UserInputService.TouchControlsEnabled
113 Add UserInputService.JumpRequest
113 Add UserInputService.TouchEnded
113 Add UserInputService.TouchLongPress
113 Add UserInputService.TouchMoved
113 Add UserInputService.TouchPinch
113 Add UserInputService.TouchRotate
113 Add UserInputService.TouchStarted
113 Add UserInputService.TouchSwipe
113 Add UserInputService.TouchTap
80 Add UserInputService
79 Remove UserInputService
80 Add UserInputService

Members

AccelerometerEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

History

168 Add UserInputService.AccelerometerEnabled

Tags: [ReadOnly, NotReplicated]

BottomBarSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.BottomBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
314 Add UserInputService.BottomBarSize

Tags: [Hidden, ReadOnly, NotReplicated]

DeviceAccelerationChanged On DevHub

Parameters	1

Name	Type	Default
acceleration	InputObject	none

History

483 Change Parameters of UserInputService.DeviceAccelerationChanged from (Instance acceleration) to (InputObject acceleration)
168 Add UserInputService.DeviceAccelerationChanged

DeviceGravityChanged On DevHub

Parameters	1

Name	Type	Default
gravity	InputObject	none

History

483 Change Parameters of UserInputService.DeviceGravityChanged from (Instance gravity) to (InputObject gravity)
168 Add UserInputService.DeviceGravityChanged

DeviceRotationChanged On DevHub

Parameters	2

Name	Type	Default
rotation	InputObject	none
cframe	CFrame	none

History

483 Change Parameters of UserInputService.DeviceRotationChanged from (Instance rotation, CFrame cframe) to (InputObject rotation, CFrame cframe)
168 Add UserInputService.DeviceRotationChanged

GamepadConnected On DevHub

Parameters	1

Name	Type	Default
gamepadNum	UserInputType	none

History

185 Add UserInputService.GamepadConnected

GamepadDisconnected On DevHub

Parameters	1

Name	Type	Default
gamepadNum	UserInputType	none

History

185 Add UserInputService.GamepadDisconnected

GamepadEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

Tags: [ReadOnly, NotReplicated]

GamepadSupports On DevHub

Parameters	2

Name	Type	Default
gamepadNum	UserInputType	none
gamepadKeyCode	KeyCode	none

Return Type	bool

History

185 Add UserInputService.GamepadSupports

GazeSelectionEnabled On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

262 Add UserInputService.GazeSelectionEnabled

Tags: [Hidden, NotReplicated]

GetConnectedGamepads On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array

History

217 Add UserInputService.GetConnectedGamepads

GetDeviceAcceleration On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	InputObject

History

483 Change ReturnType of UserInputService.GetDeviceAcceleration from Instance to InputObject
168 Add UserInputService.GetDeviceAcceleration

GetDeviceGravity On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	InputObject

History

483 Change ReturnType of UserInputService.GetDeviceGravity from Instance to InputObject
168 Add UserInputService.GetDeviceGravity

GetDeviceRotation On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

168 Add UserInputService.GetDeviceRotation

GetDeviceType On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	DeviceType
Security	RobloxScriptSecurity

History

377 Add UserInputService.GetDeviceType

GetFocusedTextBox On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	TextBox

History

483 Change ReturnType of UserInputService.GetFocusedTextBox from Instance to TextBox
213 Add UserInputService.GetFocusedTextBox

GetGamepadConnected On DevHub

Parameters	1

Name	Type	Default
gamepadNum	UserInputType	none

Return Type	bool

History

185 Add UserInputService.GetGamepadConnected

GetGamepadState On DevHub

Parameters	1

Name	Type	Default
gamepadNum	UserInputType	none

Return Type	Array

History

185 Add UserInputService.GetGamepadState

GetKeysPressed On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array

History

189 Add UserInputService.GetKeysPressed
188 Remove UserInputService.GetKeysPressed
189 Add UserInputService.GetKeysPressed

GetLastInputType On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	UserInputType

History

226 Change Security of UserInputService.GetLastInputType from RobloxScriptSecurity to None
208 Add UserInputService.GetLastInputType

GetMouseButtonsPressed On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array

History

297 Add UserInputService.GetMouseButtonsPressed

GetMouseDelta On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Vector2

History

297 Add UserInputService.GetMouseDelta

GetMouseLocation On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Vector2

History

297 Add UserInputService.GetMouseLocation

GetNavigationGamepads On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array

History

217 Add UserInputService.GetNavigationGamepads

GetPlatform On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Platform
Security	RobloxScriptSecurity

History

156 Add UserInputService.GetPlatform

GetStringForKeyCode On DevHub

Parameters	1

Name	Type	Default
keyCode	KeyCode	none

Return Type	string

History

379 Add UserInputService.GetStringForKeyCode

GetSupportedGamepadKeyCodes On DevHub

Parameters	1

Name	Type	Default
gamepadNum	UserInputType	none

Return Type	Array

History

185 Add UserInputService.GetSupportedGamepadKeyCodes

GetUserCFrame On DevHub

Parameters	1

Name	Type	Default
type	UserCFrame	none

Return Type	CFrame

History

236 Add UserInputService.GetUserCFrame

GyroscopeEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

History

168 Add UserInputService.GyroscopeEnabled

Tags: [ReadOnly, NotReplicated]

InputBegan On DevHub

Parameters	2

Name	Type	Default
input	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.InputBegan from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
161 Change Parameters of UserInputService.InputBegan from (Instance input) to (Instance input, bool gameProcessedEvent)
138 Change Security of UserInputService.InputBegan from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.InputBegan from (InputObject input) to (Instance input)
128 Add UserInputService.InputBegan

InputChanged On DevHub

Parameters	2

Name	Type	Default
input	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.InputChanged from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
161 Change Parameters of UserInputService.InputChanged from (Instance input) to (Instance input, bool gameProcessedEvent)
138 Change Security of UserInputService.InputChanged from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.InputChanged from (InputObject input) to (Instance input)
128 Add UserInputService.InputChanged

InputEnded On DevHub

Parameters	2

Name	Type	Default
input	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.InputEnded from (Instance input, bool gameProcessedEvent) to (InputObject input, bool gameProcessedEvent)
161 Change Parameters of UserInputService.InputEnded from (Instance input) to (Instance input, bool gameProcessedEvent)
138 Change Security of UserInputService.InputEnded from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.InputEnded from (InputObject input) to (Instance input)
128 Add UserInputService.InputEnded

IsGamepadButtonDown On DevHub

Parameters	2

Name	Type	Default
gamepadNum	UserInputType	none
gamepadKeyCode	KeyCode	none

Return Type	bool

History

330 Add UserInputService.IsGamepadButtonDown

IsKeyDown On DevHub

Parameters	1

Name	Type	Default
keyCode	KeyCode	none

Return Type	bool

History

IsMouseButtonPressed On DevHub

Parameters	1

Name	Type	Default
mouseButton	UserInputType	none

Return Type	bool

History

297 Add UserInputService.IsMouseButtonPressed

IsNavigationGamepad On DevHub

Parameters	1

Name	Type	Default
gamepadEnum	UserInputType	none

Return Type	bool

History

207 Add UserInputService.IsNavigationGamepad

JumpRequest On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

118 Change Security of UserInputService.JumpRequest from RobloxPlaceSecurity to None
113 Add UserInputService.JumpRequest

KeyboardEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

Tags: [ReadOnly, NotReplicated]

LastInputTypeChanged On DevHub

Parameters	1

Name	Type	Default
lastInputType	UserInputType	none

History

226 Change Security of UserInputService.LastInputTypeChanged from RobloxScriptSecurity to None
208 Add UserInputService.LastInputTypeChanged

LegacyInputEventsEnabled On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	Behavior
Can Load	true
Can Save	true

History

469 Change Tags of UserInputService.LegacyInputEventsEnabled from [] to [Hidden]
334 Add UserInputService.LegacyInputEventsEnabled

Tags: [Hidden]

ModalEnabled On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category	Behavior
Can Load	false
Can Save	false

History

493 Change Tags of UserInputService.ModalEnabled from [] to [Deprecated]
118 Add UserInputService.ModalEnabled

Tags: [Deprecated]

MouseBehavior On DevHub

Value Type	MouseBehavior
Category	Data
Can Load	true
Can Save	true

History

158 Add UserInputService.MouseBehavior

MouseDeltaSensitivity On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	true
Can Save	false

History

246 Add UserInputService.MouseDeltaSensitivity

Tags: [NotReplicated]

MouseEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

Tags: [ReadOnly, NotReplicated]

MouseIcon On DevHub

Value Type	Content
Category	Data
Can Load	true
Can Save	true

History

563 Add UserInputService.MouseIcon

MouseIconEnabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

History

158 Add UserInputService.MouseIconEnabled

NavBarSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.NavBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
314 Add UserInputService.NavBarSize

Tags: [Hidden, ReadOnly, NotReplicated]

OnScreenKeyboardAnimationDuration On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	double
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.OnScreenKeyboardAnimationDuration from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
308 Add UserInputService.OnScreenKeyboardAnimationDuration

Tags: [Hidden, ReadOnly, NotReplicated]

OnScreenKeyboardPosition On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Category	Data
Can Load	false
Can Save	false

History

281 Add UserInputService.OnScreenKeyboardPosition

Tags: [ReadOnly, NotReplicated]

OnScreenKeyboardSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Category	Data
Can Load	false
Can Save	false

History

281 Add UserInputService.OnScreenKeyboardSize

Tags: [ReadOnly, NotReplicated]

OnScreenKeyboardVisible On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

281 Add UserInputService.OnScreenKeyboardVisible

Tags: [ReadOnly, NotReplicated]

OverrideMouseIconBehavior On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	OverrideMouseIconBehavior
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.OverrideMouseIconBehavior from [] to [Hidden]
208 Add UserInputService.OverrideMouseIconBehavior

Tags: [Hidden]

PointerAction On DevHub

Parameters	4

Name	Type	Default
wheel	float	none
pan	Vector2	none
pinch	float	none
gameProcessedEvent	bool	none

History

398 Add UserInputService.PointerAction

RecenterUserHeadCFrame On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

234 Add UserInputService.RecenterUserHeadCFrame

RightBarSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.RightBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
360 Add UserInputService.RightBarSize

Tags: [Hidden, ReadOnly, NotReplicated]

SendAppUISizes On DevHub

Parameters	4

Name	Type	Default
statusBarSize	Vector2	none
navBarSize	Vector2	none
bottomBarSize	Vector2	none
rightBarSize	Vector2	none

Return Type	void
Security	RobloxScriptSecurity

History

360 Change Parameters of UserInputService.SendAppUISizes from (Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize) to (Vector2 statusBarSize, Vector2 navBarSize, Vector2 bottomBarSize, Vector2 rightBarSize)
315 Add UserInputService.SendAppUISizes

SetNavigationGamepad On DevHub

Parameters	2

Name	Type	Default
gamepadEnum	UserInputType	none
enabled	bool	none

Return Type	void

History

207 Add UserInputService.SetNavigationGamepad

StatusBarSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Vector2
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of UserInputService.StatusBarSize from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
314 Add UserInputService.StatusBarSize

Tags: [Hidden, ReadOnly, NotReplicated]

StatusBarTapped On DevHub

Parameters	1

Name	Type	Default
position	Vector2	none

Security	RobloxScriptSecurity

History

322 Add UserInputService.StatusBarTapped

TextBoxFocusReleased On DevHub

Parameters	1

Name	Type	Default
textboxReleased	TextBox	none

History

483 Change Parameters of UserInputService.TextBoxFocusReleased from (Instance textboxReleased) to (TextBox textboxReleased)
161 Add UserInputService.TextBoxFocusReleased

TextBoxFocused On DevHub

Parameters	1

Name	Type	Default
textboxFocused	TextBox	none

History

483 Change Parameters of UserInputService.TextBoxFocused from (Instance textboxFocused) to (TextBox textboxFocused)
161 Add UserInputService.TextBoxFocused

TouchEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

Tags: [ReadOnly, NotReplicated]

TouchEnded On DevHub

Parameters	2

Name	Type	Default
touch	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.TouchEnded from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchEnded from (Instance touch) to (Instance touch, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchEnded from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.TouchEnded from (InputObject touch) to (Instance touch)
128 Change Security of UserInputService.TouchEnded from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchEnded

TouchLongPress On DevHub

Parameters	3

Name	Type	Default
touchPositions	Array	none
state	UserInputState	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchLongPress from (Array touchPositions, UserInputState state) to (Array touchPositions, UserInputState state, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchLongPress from RobloxScriptSecurity to None
131 Change Parameters of UserInputService.TouchLongPress from (UserInputState position, Vector2 state) to (Array touchPositions, UserInputState state)
130 Change Parameters of UserInputService.TouchLongPress from (Vector2 position, UserInputState state) to (UserInputState position, Vector2 state)
128 Change Parameters of UserInputService.TouchLongPress from (Vector2 position) to (Vector2 position, UserInputState state)
128 Change Security of UserInputService.TouchLongPress from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchLongPress

TouchMoved On DevHub

Parameters	2

Name	Type	Default
touch	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.TouchMoved from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchMoved from (Instance touch) to (Instance touch, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchMoved from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.TouchMoved from (InputObject touch) to (Instance touch)
128 Change Security of UserInputService.TouchMoved from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchMoved

TouchPan On DevHub

Parameters	5

Name	Type	Default
touchPositions	Array	none
totalTranslation	Vector2	none
velocity	Vector2	none
state	UserInputState	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchPan from (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchPan from RobloxScriptSecurity to None
131 Change Parameters of UserInputService.TouchPan from (Vector2 totalTranslation, Vector2 velocity, int numberOfTouches, UserInputState state, Vector2 position) to (Array touchPositions, Vector2 totalTranslation, Vector2 velocity, UserInputState state)
130 Add UserInputService.TouchPan

TouchPinch On DevHub

Parameters	5

Name	Type	Default
touchPositions	Array	none
scale	float	none
velocity	float	none
state	UserInputState	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchPinch from (Array touchPositions, float scale, float velocity, UserInputState state) to (Array touchPositions, float scale, float velocity, UserInputState state, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchPinch from RobloxScriptSecurity to None
131 Change Parameters of UserInputService.TouchPinch from (float scale, float velocity, UserInputState state, Vector2 position) to (Array touchPositions, float scale, float velocity, UserInputState state)
130 Change Parameters of UserInputService.TouchPinch from (float scale, float velocity) to (float scale, float velocity, UserInputState state, Vector2 position)
128 Change Security of UserInputService.TouchPinch from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchPinch

TouchRotate On DevHub

Parameters	5

Name	Type	Default
touchPositions	Array	none
rotation	float	none
velocity	float	none
state	UserInputState	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchRotate from (Array touchPositions, float rotation, float velocity, UserInputState state) to (Array touchPositions, float rotation, float velocity, UserInputState state, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchRotate from RobloxScriptSecurity to None
131 Change Parameters of UserInputService.TouchRotate from (float rotation, float velocity, UserInputState state, Vector2 position) to (Array touchPositions, float rotation, float velocity, UserInputState state)
130 Change Parameters of UserInputService.TouchRotate from (float rotation, float velocity) to (float rotation, float velocity, UserInputState state, Vector2 position)
128 Change Security of UserInputService.TouchRotate from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchRotate

TouchStarted On DevHub

Parameters	2

Name	Type	Default
touch	InputObject	none
gameProcessedEvent	bool	none

History

483 Change Parameters of UserInputService.TouchStarted from (Instance touch, bool gameProcessedEvent) to (InputObject touch, bool gameProcessedEvent)
161 Change Parameters of UserInputService.TouchStarted from (Instance touch) to (Instance touch, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchStarted from RobloxScriptSecurity to None
133 Change Parameters of UserInputService.TouchStarted from (InputObject touch) to (Instance touch)
128 Change Security of UserInputService.TouchStarted from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchStarted

TouchSwipe On DevHub

Parameters	3

Name	Type	Default
swipeDirection	SwipeDirection	none
numberOfTouches	int	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchSwipe from (SwipeDirection swipeDirection, int numberOfTouches) to (SwipeDirection swipeDirection, int numberOfTouches, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchSwipe from RobloxScriptSecurity to None
128 Change Parameters of UserInputService.TouchSwipe from (SwipeDirection swipeDirection) to (SwipeDirection swipeDirection, int numberOfTouches)
128 Change Security of UserInputService.TouchSwipe from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchSwipe

TouchTap On DevHub

Parameters	2

Name	Type	Default
touchPositions	Array	none
gameProcessedEvent	bool	none

History

161 Change Parameters of UserInputService.TouchTap from (Array touchPositions) to (Array touchPositions, bool gameProcessedEvent)
138 Change Security of UserInputService.TouchTap from RobloxScriptSecurity to None
131 Change Parameters of UserInputService.TouchTap from (Vector2 position) to (Array touchPositions)
128 Change Security of UserInputService.TouchTap from RobloxSecurity to RobloxScriptSecurity
113 Add UserInputService.TouchTap

TouchTapInWorld On DevHub

Parameters	2

Name	Type	Default
position	Vector2	none
processedByUI	bool	none

History

297 Add UserInputService.TouchTapInWorld

UserCFrameChanged On DevHub

Parameters	2

Name	Type	Default
type	UserCFrame	none
value	CFrame	none

History

236 Add UserInputService.UserCFrameChanged

UserHeadCFrame On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	CFrame
Category	Data
Can Load	false
Can Save	false

History

236 Change Tags of UserInputService.UserHeadCFrame from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
229 Add UserInputService.UserHeadCFrame

Tags: [ReadOnly, NotReplicated, Deprecated]

VREnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	true

History

230 Add UserInputService.VREnabled

Tags: [ReadOnly, NotReplicated]

WindowFocusReleased On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

189 Add UserInputService.WindowFocusReleased
188 Remove UserInputService.WindowFocusReleased
189 Add UserInputService.WindowFocusReleased

WindowFocused On DevHub

Parameters	0

Name	Type	Default
No parameters.

History

189 Add UserInputService.WindowFocused
188 Remove UserInputService.WindowFocused
189 Add UserInputService.WindowFocused

Removed members

InCameraGesture

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

220 Remove UserInputService.InCameraGesture
150 Add UserInputService.InCameraGesture

IsLuaTouchControls

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

230 Remove UserInputService.IsLuaTouchControls
131 Add UserInputService.IsLuaTouchControls

IsStudioTouchEmulationEnabled

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

IsVREnabled

This property is read-only. Its value can be read, but it cannot be modified.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category
Can Load	false
Can Save	false

History

240 Remove UserInputService.IsVREnabled
230 Change Tags of UserInputService.IsVREnabled from [ReadOnly] to [ReadOnly, Deprecated]
229 Add UserInputService.IsVREnabled

Tags: [ReadOnly, Deprecated]

OverrideMouseIconEnabled

Value Type	bool
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

ProcessedEvent

Parameters	2

Name	Type	Default
inputObject	Instance	none
processed	bool	none

Security	RobloxScriptSecurity

History

230 Remove UserInputService.ProcessedEvent
143 Add UserInputService.ProcessedEvent

RotateCamera

Parameters	1

Name	Type	Default
positionDelta	Vector2	none

Return Type	void
Security	RobloxScriptSecurity

History

230 Remove UserInputService.RotateCamera
131 Add UserInputService.RotateCamera

TouchControlsEnabled

Value Type	bool
Security	RobloxPlaceSecurity
Category
Can Load	false
Can Save	false

History

118 Remove UserInputService.TouchControlsEnabled
115 Add UserInputService.TouchControlsEnabled

ZoomCamera

Parameters	1

Name	Type	Default
zoomDelta	float	none

Return Type	void
Security	RobloxScriptSecurity

History

230 Remove UserInputService.ZoomCamera
131 Add UserInputService.ZoomCamera