UserInputService
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 77
Removed member index 10
| History | Member | |
|---|---|---|
| 220 | InCameraGesture: bool | |
| 240 | IsVREnabled: bool | |
| 220 | OverrideMouseIconEnabled: bool | |
| 118 | TouchControlsEnabled: bool | |
| 230 | IsLuaTouchControls(): bool | |
| 230 | IsStudioTouchEmulationEnabled(): bool | |
| 230 | RotateCamera(positionDelta: Vector2): void | |
| 230 | ZoomCamera(zoomDelta: float): void | |
| 230 | ProcessedEvent(inputObject: Instance, processed: bool) |
History 318
- 605 Change Tags of UserCFrameChanged from [] to [Deprecated]
- 605 Change PreferredDescriptor of UserCFrameChanged from to UserCFrameChanged
- 605 Change Tags of GetUserCFrame from [] to [Deprecated]
- 605 Change PreferredDescriptor of GetUserCFrame from to GetUserCFrame
- 594 Add GetImageForKeyCode
- 573 Change ReturnType of SetNavigationGamepad from void to null
- 573 Change ReturnType of SendAppUISizes from void to null
- 573 Change ReturnType of RecenterUserHeadCFrame from void to null
- 572 Remove
- 563 Add MouseIcon
- 553 Change Default of VREnabled from to
- 553 Change Default of UserHeadCFrame from to
- 553 Change Default of TouchEnabled from to
- 553 Change Default of from to
- 553 Change Default of from to
- 553 Change Default of from to
- 553 Change Default of OnScreenKeyboardVisible from to
- 553 Change Default of OnScreenKeyboardSize from to
- 553 Change Default of OnScreenKeyboardPosition from to
- 553 Change Default of from to
- 553 Change Default of from to
- 553 Change Default of MouseIconEnabled from to
- 553 Change Default of MouseEnabled from to
- 553 Change Default of MouseDeltaSensitivity from to
- 553 Change Default of MouseBehavior from to
- 553 Change PreferredDescriptor of ModalEnabled from to TouchControlsEnabled
- 553 Change Default of ModalEnabled from to
- 553 Change Default of from to
- 553 Change Default of KeyboardEnabled from to
- 553 Change Default of GyroscopeEnabled from to
- 553 Change Default of from to
- 553 Change Default of GamepadEnabled from to
- 553 Change Default of from to
- 553 Change Default of AccelerometerEnabled from to
- 493 Change Tags of ModalEnabled from [] to [Deprecated]
- 486 Change ThreadSafety of VREnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of UserHeadCFrame from ReadOnly to ReadSafe
- 486 Change ThreadSafety of TouchEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of OnScreenKeyboardVisible from ReadOnly to ReadSafe
- 486 Change ThreadSafety of OnScreenKeyboardSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of OnScreenKeyboardPosition from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MouseIconEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MouseEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MouseDeltaSensitivity from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MouseBehavior from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ModalEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of KeyboardEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of GyroscopeEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of GamepadEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AccelerometerEnabled from ReadOnly to ReadSafe
- 483 Change Parameters of TouchStarted from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of TouchMoved from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of TouchEnded from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of TextBoxFocused from (textboxFocused: Instance) to (textboxFocused: TextBox)
- 483 Change Parameters of TextBoxFocusReleased from (textboxReleased: Instance) to (textboxReleased: TextBox)
- 483 Change Parameters of InputEnded from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of InputChanged from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of InputBegan from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 483 Change Parameters of DeviceRotationChanged from (rotation: Instance, cframe: CFrame) to (rotation: InputObject, cframe: CFrame)
- 483 Change Parameters of DeviceGravityChanged from (gravity: Instance) to (gravity: InputObject)
- 483 Change Parameters of DeviceAccelerationChanged from (acceleration: Instance) to (acceleration: InputObject)
- 483 Change ReturnType of GetFocusedTextBox from Instance to TextBox
- 483 Change ReturnType of GetDeviceGravity from Instance to InputObject
- 483 Change ReturnType of GetDeviceAcceleration from Instance to InputObject
- 469 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 469 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 469 Change Tags of from [] to [Hidden]
- 469 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 469 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 469 Change Tags of from [] to [Hidden]
- 469 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 462 Change ThreadSafety of WindowFocused from to Unsafe
- 462 Change ThreadSafety of WindowFocusReleased from to Unsafe
- 462 Change ThreadSafety of UserCFrameChanged from to Unsafe
- 462 Change ThreadSafety of TouchTapInWorld from to Unsafe
- 462 Change ThreadSafety of TouchTap from to Unsafe
- 462 Change ThreadSafety of TouchSwipe from to Unsafe
- 462 Change ThreadSafety of TouchStarted from to Unsafe
- 462 Change ThreadSafety of TouchRotate from to Unsafe
- 462 Change ThreadSafety of TouchPinch from to Unsafe
- 462 Change ThreadSafety of TouchPan from to Unsafe
- 462 Change ThreadSafety of TouchMoved from to Unsafe
- 462 Change ThreadSafety of TouchLongPress from to Unsafe
- 462 Change ThreadSafety of TouchEnded from to Unsafe
- 462 Change ThreadSafety of TextBoxFocused from to Unsafe
- 462 Change ThreadSafety of TextBoxFocusReleased from to Unsafe
- 462 Change ThreadSafety of StatusBarTapped from to Unsafe
- 462 Change ThreadSafety of PointerAction from to Unsafe
- 462 Change ThreadSafety of LastInputTypeChanged from to Unsafe
- 462 Change ThreadSafety of JumpRequest from to Unsafe
- 462 Change ThreadSafety of InputEnded from to Unsafe
- 462 Change ThreadSafety of InputChanged from to Unsafe
- 462 Change ThreadSafety of InputBegan from to Unsafe
- 462 Change ThreadSafety of GamepadDisconnected from to Unsafe
- 462 Change ThreadSafety of GamepadConnected from to Unsafe
- 462 Change ThreadSafety of DeviceRotationChanged from to Unsafe
- 462 Change ThreadSafety of DeviceGravityChanged from to Unsafe
- 462 Change ThreadSafety of DeviceAccelerationChanged from to Unsafe
- 462 Change ThreadSafety of SetNavigationGamepad from to Unsafe
- 462 Change ThreadSafety of SendAppUISizes from to Unsafe
- 462 Change ThreadSafety of RecenterUserHeadCFrame from to Unsafe
- 462 Change ThreadSafety of IsNavigationGamepad from to Unsafe
- 462 Change ThreadSafety of IsMouseButtonPressed from to Unsafe
- 462 Change ThreadSafety of IsKeyDown from to Unsafe
- 462 Change ThreadSafety of IsGamepadButtonDown from to Unsafe
- 462 Change ThreadSafety of GetUserCFrame from to Unsafe
- 462 Change ThreadSafety of GetSupportedGamepadKeyCodes from to Unsafe
- 462 Change ThreadSafety of GetStringForKeyCode from to Unsafe
- 462 Change ThreadSafety of GetPlatform from to Unsafe
- 462 Change ThreadSafety of GetNavigationGamepads from to Unsafe
- 462 Change ThreadSafety of GetMouseLocation from to Unsafe
- 462 Change ThreadSafety of GetMouseDelta from to Unsafe
- 462 Change ThreadSafety of GetMouseButtonsPressed from to Unsafe
- 462 Change ThreadSafety of GetLastInputType from to Unsafe
- 462 Change ThreadSafety of GetKeysPressed from to Unsafe
- 462 Change ThreadSafety of GetGamepadState from to Unsafe
- 462 Change ThreadSafety of GetGamepadConnected from to Unsafe
- 462 Change ThreadSafety of GetFocusedTextBox from to Unsafe
- 462 Change ThreadSafety of GetDeviceType from to Unsafe
- 462 Change ThreadSafety of GetDeviceRotation from to Unsafe
- 462 Change ThreadSafety of GetDeviceGravity from to Unsafe
- 462 Change ThreadSafety of GetDeviceAcceleration from to Unsafe
- 462 Change ThreadSafety of GetConnectedGamepads from to Unsafe
- 462 Change ThreadSafety of GamepadSupports from to Unsafe
- 462 Change ThreadSafety of VREnabled from to ReadOnly
- 462 Change ThreadSafety of UserHeadCFrame from to ReadOnly
- 462 Change ThreadSafety of TouchEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of OnScreenKeyboardVisible from to ReadOnly
- 462 Change ThreadSafety of OnScreenKeyboardSize from to ReadOnly
- 462 Change ThreadSafety of OnScreenKeyboardPosition from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of MouseIconEnabled from to ReadOnly
- 462 Change ThreadSafety of MouseEnabled from to ReadOnly
- 462 Change ThreadSafety of MouseDeltaSensitivity from to ReadOnly
- 462 Change ThreadSafety of MouseBehavior from to ReadOnly
- 462 Change ThreadSafety of ModalEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of KeyboardEnabled from to ReadOnly
- 462 Change ThreadSafety of GyroscopeEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of GamepadEnabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of AccelerometerEnabled from to ReadOnly
- 398 Add PointerAction
- 379 Add GetStringForKeyCode
- 377 Add GetDeviceType
- 360 Change Parameters of SendAppUISizes from (statusBarSize: Vector2, navBarSize: Vector2, bottomBarSize: Vector2) to (statusBarSize: Vector2, navBarSize: Vector2, bottomBarSize: Vector2, rightBarSize: Vector2)
- 360 Add
- 334 Add
- 330 Add IsGamepadButtonDown
- 322 Add StatusBarTapped
- 315 Add SendAppUISizes
- 314 Add
- 314 Add
- 314 Add
- 308 Add
- 297 Add TouchTapInWorld
- 297 Add IsMouseButtonPressed
- 297 Add GetMouseLocation
- 297 Add GetMouseDelta
- 297 Add GetMouseButtonsPressed
- 281 Add OnScreenKeyboardVisible
- 281 Add OnScreenKeyboardSize
- 281 Add OnScreenKeyboardPosition
- 262 Add
- 246 Add MouseDeltaSensitivity
- 240 Remove IsVREnabled
- 236 Add UserCFrameChanged
- 236 Add GetUserCFrame
- 236 Change Tags of UserHeadCFrame from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 234 Add RecenterUserHeadCFrame
- 230 Remove ProcessedEvent
- 230 Remove ZoomCamera
- 230 Remove RotateCamera
- 230 Remove IsStudioTouchEmulationEnabled
- 230 Remove IsLuaTouchControls
- 230 Add VREnabled
- 230 Change Tags of IsVREnabled from [ReadOnly] to [ReadOnly, Deprecated]
- 229 Add UserHeadCFrame
- 229 Add IsVREnabled
- 226 Change Security of LastInputTypeChanged from RobloxScriptSecurity to None
- 226 Change Security of GetLastInputType from RobloxScriptSecurity to None
- 220 Remove OverrideMouseIconEnabled
- 220 Remove InCameraGesture
- 217 Add GetNavigationGamepads
- 217 Add GetConnectedGamepads
- 213 Add GetFocusedTextBox
- 208 Add LastInputTypeChanged
- 208 Add GetLastInputType
- 208 Add
- 207 Add SetNavigationGamepad
- 207 Add IsNavigationGamepad
- 189 Add WindowFocused
- 189 Add WindowFocusReleased
- 189 Add IsKeyDown
- 189 Add GetKeysPressed
- 188 Remove WindowFocused
- 188 Remove WindowFocusReleased
- 188 Remove IsKeyDown
- 188 Remove GetKeysPressed
- 189 Add WindowFocused
- 189 Add WindowFocusReleased
- 189 Add IsKeyDown
- 189 Add GetKeysPressed
- 185 Add GamepadDisconnected
- 185 Add GamepadConnected
- 185 Add GetSupportedGamepadKeyCodes
- 185 Add GetGamepadState
- 185 Add GetGamepadConnected
- 185 Add GamepadSupports
- 171 Add IsStudioTouchEmulationEnabled
- 168 Add DeviceRotationChanged
- 168 Add DeviceGravityChanged
- 168 Add DeviceAccelerationChanged
- 168 Add GetDeviceRotation
- 168 Add GetDeviceGravity
- 168 Add GetDeviceAcceleration
- 168 Add OverrideMouseIconEnabled
- 168 Add GyroscopeEnabled
- 168 Add AccelerometerEnabled
- 161 Change Parameters of TouchTap from (touchPositions: Array) to (touchPositions: Array, gameProcessedEvent: bool)
- 161 Change Parameters of TouchSwipe from (swipeDirection: SwipeDirection, numberOfTouches: int) to (swipeDirection: SwipeDirection, numberOfTouches: int, gameProcessedEvent: bool)
- 161 Change Parameters of TouchStarted from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 161 Change Parameters of TouchRotate from (touchPositions: Array, rotation: float, velocity: float, state: UserInputState) to (touchPositions: Array, rotation: float, velocity: float, state: UserInputState, gameProcessedEvent: bool)
- 161 Change Parameters of TouchPinch from (touchPositions: Array, scale: float, velocity: float, state: UserInputState) to (touchPositions: Array, scale: float, velocity: float, state: UserInputState, gameProcessedEvent: bool)
- 161 Change Parameters of TouchPan from (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState) to (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState, gameProcessedEvent: bool)
- 161 Change Parameters of TouchMoved from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 161 Change Parameters of TouchLongPress from (touchPositions: Array, state: UserInputState) to (touchPositions: Array, state: UserInputState, gameProcessedEvent: bool)
- 161 Change Parameters of TouchEnded from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 161 Add TextBoxFocused
- 161 Add TextBoxFocusReleased
- 161 Change Parameters of InputEnded from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 161 Change Parameters of InputChanged from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 161 Change Parameters of InputBegan from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 158 Add MouseIconEnabled
- 158 Add MouseBehavior
- 156 Add GetPlatform
- 150 Add InCameraGesture
- 143 Add ProcessedEvent
- 138 Change Security of TouchTap from RobloxScriptSecurity to None
- 138 Change Security of TouchSwipe from RobloxScriptSecurity to None
- 138 Change Security of TouchStarted from RobloxScriptSecurity to None
- 138 Change Security of TouchRotate from RobloxScriptSecurity to None
- 138 Change Security of TouchPinch from RobloxScriptSecurity to None
- 138 Change Security of TouchPan from RobloxScriptSecurity to None
- 138 Change Security of TouchMoved from RobloxScriptSecurity to None
- 138 Change Security of TouchLongPress from RobloxScriptSecurity to None
- 138 Change Security of TouchEnded from RobloxScriptSecurity to None
- 138 Change Security of InputEnded from RobloxScriptSecurity to None
- 138 Change Security of InputChanged from RobloxScriptSecurity to None
- 138 Change Security of InputBegan from RobloxScriptSecurity to None
- 133 Change Parameters of TouchStarted from (touch: InputObject) to (touch: Instance)
- 133 Change Parameters of TouchMoved from (touch: InputObject) to (touch: Instance)
- 133 Change Parameters of TouchEnded from (touch: InputObject) to (touch: Instance)
- 133 Change Parameters of InputEnded from (input: InputObject) to (input: Instance)
- 133 Change Parameters of InputChanged from (input: InputObject) to (input: Instance)
- 133 Change Parameters of InputBegan from (input: InputObject) to (input: Instance)
- 131 Change Parameters of TouchTap from (position: Vector2) to (touchPositions: Array)
- 131 Change Parameters of TouchRotate from (rotation: float, velocity: float, state: UserInputState, position: Vector2) to (touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
- 131 Change Parameters of TouchPinch from (scale: float, velocity: float, state: UserInputState, position: Vector2) to (touchPositions: Array, scale: float, velocity: float, state: UserInputState)
- 131 Change Parameters of TouchPan from (totalTranslation: Vector2, velocity: Vector2, numberOfTouches: int, state: UserInputState, position: Vector2) to (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
- 131 Change Parameters of TouchLongPress from (position: UserInputState, state: Vector2) to (touchPositions: Array, state: UserInputState)
- 131 Add ZoomCamera
- 131 Add RotateCamera
- 131 Add IsLuaTouchControls
- 130 Change Parameters of TouchRotate from (rotation: float, velocity: float) to (rotation: float, velocity: float, state: UserInputState, position: Vector2)
- 130 Change Parameters of TouchPinch from (scale: float, velocity: float) to (scale: float, velocity: float, state: UserInputState, position: Vector2)
- 130 Add TouchPan
- 130 Change Parameters of TouchLongPress from (position: Vector2, state: UserInputState) to (position: UserInputState, state: Vector2)
- 128 Change Security of TouchTap from RobloxSecurity to RobloxScriptSecurity
- 128 Change Security of TouchSwipe from RobloxSecurity to RobloxScriptSecurity
- 128 Change Parameters of TouchSwipe from (swipeDirection: SwipeDirection) to (swipeDirection: SwipeDirection, numberOfTouches: int)
- 128 Change Security of TouchStarted from RobloxSecurity to RobloxScriptSecurity
- 128 Change Security of TouchRotate from RobloxSecurity to RobloxScriptSecurity
- 128 Change Security of TouchPinch from RobloxSecurity to RobloxScriptSecurity
- 128 Change Security of TouchMoved from RobloxSecurity to RobloxScriptSecurity
- 128 Change Security of TouchLongPress from RobloxSecurity to RobloxScriptSecurity
- 128 Change Parameters of TouchLongPress from (position: Vector2) to (position: Vector2, state: UserInputState)
- 128 Change Security of TouchEnded from RobloxSecurity to RobloxScriptSecurity
- 128 Add InputEnded
- 128 Add InputChanged
- 128 Add InputBegan
- 118 Change Security of JumpRequest from RobloxPlaceSecurity to None
- 118 Remove TouchControlsEnabled
- 118 Add ModalEnabled
- 115 Add TouchControlsEnabled
- 113 Add TouchTap
- 113 Add TouchSwipe
- 113 Add TouchStarted
- 113 Add TouchRotate
- 113 Add TouchPinch
- 113 Add TouchMoved
- 113 Add TouchLongPress
- 113 Add TouchEnded
- 113 Add JumpRequest
- 80 Add TouchEnabled
- 80 Add MouseEnabled
- 80 Add KeyboardEnabled
- 80 Add GamepadEnabled
- 80 Add UserInputService
- 79 Remove UserInputService
- 80 Add TouchEnabled
- 80 Add MouseEnabled
- 80 Add KeyboardEnabled
- 80 Add GamepadEnabled
- 80 Add UserInputService
Members 77
AccelerometerEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 4
- 553 Change Default of AccelerometerEnabled from to
- 486 Change ThreadSafety of AccelerometerEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AccelerometerEnabled from to ReadOnly
- 168 Add AccelerometerEnabled
DeviceAccelerationChanged
| Parameters (1) | |
|---|---|
| acceleration | InputObject |
| Thread safety | Unsafe |
|---|
History 3
- 483 Change Parameters of DeviceAccelerationChanged from (acceleration: Instance) to (acceleration: InputObject)
- 462 Change ThreadSafety of DeviceAccelerationChanged from to Unsafe
- 168 Add DeviceAccelerationChanged
DeviceGravityChanged
| Parameters (1) | |
|---|---|
| gravity | InputObject |
| Thread safety | Unsafe |
|---|
History 3
- 483 Change Parameters of DeviceGravityChanged from (gravity: Instance) to (gravity: InputObject)
- 462 Change ThreadSafety of DeviceGravityChanged from to Unsafe
- 168 Add DeviceGravityChanged
DeviceRotationChanged
| Parameters (2) | |
|---|---|
| rotation | InputObject |
| cframe | CFrame |
| Thread safety | Unsafe |
|---|
History 3
- 483 Change Parameters of DeviceRotationChanged from (rotation: Instance, cframe: CFrame) to (rotation: InputObject, cframe: CFrame)
- 462 Change ThreadSafety of DeviceRotationChanged from to Unsafe
- 168 Add DeviceRotationChanged
GamepadConnected
| Parameters (1) | |
|---|---|
| gamepadNum | UserInputType |
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GamepadConnected from to Unsafe
- 185 Add GamepadConnected
GamepadDisconnected
| Parameters (1) | |
|---|---|
| gamepadNum | UserInputType |
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GamepadDisconnected from to Unsafe
- 185 Add GamepadDisconnected
GamepadEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 6
- 553 Change Default of GamepadEnabled from to
- 486 Change ThreadSafety of GamepadEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GamepadEnabled from to ReadOnly
- 80 Add GamepadEnabled
- 79 Remove UserInputService
- 80 Add GamepadEnabled
GamepadSupports
| Parameters (2) | ||
|---|---|---|
| gamepadNum | UserInputType | |
| gamepadKeyCode | KeyCode | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GamepadSupports from to Unsafe
- 185 Add GamepadSupports
GetConnectedGamepads
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetConnectedGamepads from to Unsafe
- 217 Add GetConnectedGamepads
GetDeviceAcceleration
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| InputObject | ||
| Thread safety | Unsafe |
|---|
History 3
- 483 Change ReturnType of GetDeviceAcceleration from Instance to InputObject
- 462 Change ThreadSafety of GetDeviceAcceleration from to Unsafe
- 168 Add GetDeviceAcceleration
GetDeviceGravity
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| InputObject | ||
| Thread safety | Unsafe |
|---|
History 3
- 483 Change ReturnType of GetDeviceGravity from Instance to InputObject
- 462 Change ThreadSafety of GetDeviceGravity from to Unsafe
- 168 Add GetDeviceGravity
GetDeviceRotation
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetDeviceRotation from to Unsafe
- 168 Add GetDeviceRotation
GetDeviceType
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| DeviceType | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetDeviceType from to Unsafe
- 377 Add GetDeviceType
GetFocusedTextBox
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| TextBox | ||
| Thread safety | Unsafe |
|---|
History 3
- 483 Change ReturnType of GetFocusedTextBox from Instance to TextBox
- 462 Change ThreadSafety of GetFocusedTextBox from to Unsafe
- 213 Add GetFocusedTextBox
GetGamepadConnected
| Parameters (1) | ||
|---|---|---|
| gamepadNum | UserInputType | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetGamepadConnected from to Unsafe
- 185 Add GetGamepadConnected
GetGamepadState
| Parameters (1) | ||
|---|---|---|
| gamepadNum | UserInputType | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetGamepadState from to Unsafe
- 185 Add GetGamepadState
GetImageForKeyCode
| Parameters (1) | ||
|---|---|---|
| keyCode | KeyCode | |
| Returns (1) | ||
| Content | ||
| Thread safety | Unsafe |
|---|
History 1
GetKeysPressed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of GetKeysPressed from to Unsafe
- 189 Add GetKeysPressed
- 188 Remove GetKeysPressed
- 189 Add GetKeysPressed
GetLastInputType
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| UserInputType | ||
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of GetLastInputType from to Unsafe
- 226 Change Security of GetLastInputType from RobloxScriptSecurity to None
- 208 Add GetLastInputType
GetMouseButtonsPressed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetMouseButtonsPressed from to Unsafe
- 297 Add GetMouseButtonsPressed
GetMouseDelta
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector2 | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetMouseDelta from to Unsafe
- 297 Add GetMouseDelta
GetMouseLocation
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector2 | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetMouseLocation from to Unsafe
- 297 Add GetMouseLocation
GetPlatform
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Platform | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetPlatform from to Unsafe
- 156 Add GetPlatform
GetStringForKeyCode
| Parameters (1) | ||
|---|---|---|
| keyCode | KeyCode | |
| Returns (1) | ||
| string | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetStringForKeyCode from to Unsafe
- 379 Add GetStringForKeyCode
GetSupportedGamepadKeyCodes
| Parameters (1) | ||
|---|---|---|
| gamepadNum | UserInputType | |
| Returns (1) | ||
| Array | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetSupportedGamepadKeyCodes from to Unsafe
- 185 Add GetSupportedGamepadKeyCodes
GetUserCFrame
| Parameters (1) | ||
|---|---|---|
| type | UserCFrame | |
| Returns (1) | ||
| CFrame | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 605 Change Tags of GetUserCFrame from [] to [Deprecated]
- 605 Change PreferredDescriptor of GetUserCFrame from to GetUserCFrame
- 462 Change ThreadSafety of GetUserCFrame from to Unsafe
- 236 Add GetUserCFrame
GyroscopeEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 4
- 553 Change Default of GyroscopeEnabled from to
- 486 Change ThreadSafety of GyroscopeEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GyroscopeEnabled from to ReadOnly
- 168 Add GyroscopeEnabled
InputBegan
| Parameters (2) | |
|---|---|
| input | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 6
- 483 Change Parameters of InputBegan from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of InputBegan from to Unsafe
- 161 Change Parameters of InputBegan from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 138 Change Security of InputBegan from RobloxScriptSecurity to None
- 133 Change Parameters of InputBegan from (input: InputObject) to (input: Instance)
- 128 Add InputBegan
InputChanged
| Parameters (2) | |
|---|---|
| input | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 6
- 483 Change Parameters of InputChanged from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of InputChanged from to Unsafe
- 161 Change Parameters of InputChanged from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 138 Change Security of InputChanged from RobloxScriptSecurity to None
- 133 Change Parameters of InputChanged from (input: InputObject) to (input: Instance)
- 128 Add InputChanged
InputEnded
| Parameters (2) | |
|---|---|
| input | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 6
- 483 Change Parameters of InputEnded from (input: Instance, gameProcessedEvent: bool) to (input: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of InputEnded from to Unsafe
- 161 Change Parameters of InputEnded from (input: Instance) to (input: Instance, gameProcessedEvent: bool)
- 138 Change Security of InputEnded from RobloxScriptSecurity to None
- 133 Change Parameters of InputEnded from (input: InputObject) to (input: Instance)
- 128 Add InputEnded
IsGamepadButtonDown
| Parameters (2) | ||
|---|---|---|
| gamepadNum | UserInputType | |
| gamepadKeyCode | KeyCode | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of IsGamepadButtonDown from to Unsafe
- 330 Add IsGamepadButtonDown
IsKeyDown
| Parameters (1) | ||
|---|---|---|
| keyCode | KeyCode | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
IsMouseButtonPressed
| Parameters (1) | ||
|---|---|---|
| mouseButton | UserInputType | |
| Returns (1) | ||
| bool | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of IsMouseButtonPressed from to Unsafe
- 297 Add IsMouseButtonPressed
JumpRequest
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of JumpRequest from to Unsafe
- 118 Change Security of JumpRequest from RobloxPlaceSecurity to None
- 113 Add JumpRequest
KeyboardEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 6
- 553 Change Default of KeyboardEnabled from to
- 486 Change ThreadSafety of KeyboardEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of KeyboardEnabled from to ReadOnly
- 80 Add KeyboardEnabled
- 79 Remove UserInputService
- 80 Add KeyboardEnabled
LastInputTypeChanged
| Parameters (1) | |
|---|---|
| lastInputType | UserInputType |
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of LastInputTypeChanged from to Unsafe
- 226 Change Security of LastInputTypeChanged from RobloxScriptSecurity to None
- 208 Add LastInputTypeChanged
ModalEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. TouchControlsEnabled should be used instead.
| Thread safety | ReadSafe |
|---|---|
| Category | Behavior |
| Loaded/Saved | false |
History 6
- 553 Change PreferredDescriptor of ModalEnabled from to TouchControlsEnabled
- 553 Change Default of ModalEnabled from to
- 493 Change Tags of ModalEnabled from [] to [Deprecated]
- 486 Change ThreadSafety of ModalEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ModalEnabled from to ReadOnly
- 118 Add ModalEnabled
MouseBehavior
| Type | Default | |
|---|---|---|
| MouseBehavior | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of MouseBehavior from to
- 486 Change ThreadSafety of MouseBehavior from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MouseBehavior from to ReadOnly
- 158 Add MouseBehavior
MouseDeltaSensitivity
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |
History 4
- 553 Change Default of MouseDeltaSensitivity from to
- 486 Change ThreadSafety of MouseDeltaSensitivity from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MouseDeltaSensitivity from to ReadOnly
- 246 Add MouseDeltaSensitivity
MouseEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 6
- 553 Change Default of MouseEnabled from to
- 486 Change ThreadSafety of MouseEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MouseEnabled from to ReadOnly
- 80 Add MouseEnabled
- 79 Remove UserInputService
- 80 Add MouseEnabled
MouseIcon
| Type | Default | |
|---|---|---|
| Content | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
MouseIconEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of MouseIconEnabled from to
- 486 Change ThreadSafety of MouseIconEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MouseIconEnabled from to ReadOnly
- 158 Add MouseIconEnabled
OnScreenKeyboardPosition
| Type | Default | |
|---|---|---|
| Vector2 | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of OnScreenKeyboardPosition from to
- 486 Change ThreadSafety of OnScreenKeyboardPosition from ReadOnly to ReadSafe
- 462 Change ThreadSafety of OnScreenKeyboardPosition from to ReadOnly
- 281 Add OnScreenKeyboardPosition
OnScreenKeyboardSize
| Type | Default | |
|---|---|---|
| Vector2 | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of OnScreenKeyboardSize from to
- 486 Change ThreadSafety of OnScreenKeyboardSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of OnScreenKeyboardSize from to ReadOnly
- 281 Add OnScreenKeyboardSize
OnScreenKeyboardVisible
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of OnScreenKeyboardVisible from to
- 486 Change ThreadSafety of OnScreenKeyboardVisible from ReadOnly to ReadSafe
- 462 Change ThreadSafety of OnScreenKeyboardVisible from to ReadOnly
- 281 Add OnScreenKeyboardVisible
PointerAction
| Parameters (4) | |
|---|---|
| wheel | float |
| pan | Vector2 |
| pinch | float |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of PointerAction from to Unsafe
- 398 Add PointerAction
RecenterUserHeadCFrame
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of RecenterUserHeadCFrame from void to null
- 462 Change ThreadSafety of RecenterUserHeadCFrame from to Unsafe
- 234 Add RecenterUserHeadCFrame
SendAppUISizes
| Parameters (4) | ||
|---|---|---|
| statusBarSize | Vector2 | |
| navBarSize | Vector2 | |
| bottomBarSize | Vector2 | |
| rightBarSize | Vector2 | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of SendAppUISizes from void to null
- 462 Change ThreadSafety of SendAppUISizes from to Unsafe
- 360 Change Parameters of SendAppUISizes from (statusBarSize: Vector2, navBarSize: Vector2, bottomBarSize: Vector2) to (statusBarSize: Vector2, navBarSize: Vector2, bottomBarSize: Vector2, rightBarSize: Vector2)
- 315 Add SendAppUISizes
StatusBarTapped
| Parameters (1) | |
|---|---|
| position | Vector2 |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of StatusBarTapped from to Unsafe
- 322 Add StatusBarTapped
TextBoxFocusReleased
| Parameters (1) | |
|---|---|
| textboxReleased | TextBox |
| Thread safety | Unsafe |
|---|
History 3
- 483 Change Parameters of TextBoxFocusReleased from (textboxReleased: Instance) to (textboxReleased: TextBox)
- 462 Change ThreadSafety of TextBoxFocusReleased from to Unsafe
- 161 Add TextBoxFocusReleased
TextBoxFocused
| Parameters (1) | |
|---|---|
| textboxFocused | TextBox |
| Thread safety | Unsafe |
|---|
History 3
- 483 Change Parameters of TextBoxFocused from (textboxFocused: Instance) to (textboxFocused: TextBox)
- 462 Change ThreadSafety of TextBoxFocused from to Unsafe
- 161 Add TextBoxFocused
TouchEnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
History 6
- 553 Change Default of TouchEnabled from to
- 486 Change ThreadSafety of TouchEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TouchEnabled from to ReadOnly
- 80 Add TouchEnabled
- 79 Remove UserInputService
- 80 Add TouchEnabled
TouchEnded
| Parameters (2) | |
|---|---|
| touch | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 7
- 483 Change Parameters of TouchEnded from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of TouchEnded from to Unsafe
- 161 Change Parameters of TouchEnded from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 138 Change Security of TouchEnded from RobloxScriptSecurity to None
- 133 Change Parameters of TouchEnded from (touch: InputObject) to (touch: Instance)
- 128 Change Security of TouchEnded from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchEnded
TouchLongPress
| Parameters (3) | |
|---|---|
| touchPositions | Array |
| state | UserInputState |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 8
- 462 Change ThreadSafety of TouchLongPress from to Unsafe
- 161 Change Parameters of TouchLongPress from (touchPositions: Array, state: UserInputState) to (touchPositions: Array, state: UserInputState, gameProcessedEvent: bool)
- 138 Change Security of TouchLongPress from RobloxScriptSecurity to None
- 131 Change Parameters of TouchLongPress from (position: UserInputState, state: Vector2) to (touchPositions: Array, state: UserInputState)
- 130 Change Parameters of TouchLongPress from (position: Vector2, state: UserInputState) to (position: UserInputState, state: Vector2)
- 128 Change Security of TouchLongPress from RobloxSecurity to RobloxScriptSecurity
- 128 Change Parameters of TouchLongPress from (position: Vector2) to (position: Vector2, state: UserInputState)
- 113 Add TouchLongPress
TouchMoved
| Parameters (2) | |
|---|---|
| touch | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 7
- 483 Change Parameters of TouchMoved from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of TouchMoved from to Unsafe
- 161 Change Parameters of TouchMoved from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 138 Change Security of TouchMoved from RobloxScriptSecurity to None
- 133 Change Parameters of TouchMoved from (touch: InputObject) to (touch: Instance)
- 128 Change Security of TouchMoved from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchMoved
TouchPan
| Parameters (5) | |
|---|---|
| touchPositions | Array |
| totalTranslation | Vector2 |
| velocity | Vector2 |
| state | UserInputState |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 5
- 462 Change ThreadSafety of TouchPan from to Unsafe
- 161 Change Parameters of TouchPan from (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState) to (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState, gameProcessedEvent: bool)
- 138 Change Security of TouchPan from RobloxScriptSecurity to None
- 131 Change Parameters of TouchPan from (totalTranslation: Vector2, velocity: Vector2, numberOfTouches: int, state: UserInputState, position: Vector2) to (touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
- 130 Add TouchPan
TouchPinch
| Parameters (5) | |
|---|---|
| touchPositions | Array |
| scale | float |
| velocity | float |
| state | UserInputState |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 7
- 462 Change ThreadSafety of TouchPinch from to Unsafe
- 161 Change Parameters of TouchPinch from (touchPositions: Array, scale: float, velocity: float, state: UserInputState) to (touchPositions: Array, scale: float, velocity: float, state: UserInputState, gameProcessedEvent: bool)
- 138 Change Security of TouchPinch from RobloxScriptSecurity to None
- 131 Change Parameters of TouchPinch from (scale: float, velocity: float, state: UserInputState, position: Vector2) to (touchPositions: Array, scale: float, velocity: float, state: UserInputState)
- 130 Change Parameters of TouchPinch from (scale: float, velocity: float) to (scale: float, velocity: float, state: UserInputState, position: Vector2)
- 128 Change Security of TouchPinch from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchPinch
TouchRotate
| Parameters (5) | |
|---|---|
| touchPositions | Array |
| rotation | float |
| velocity | float |
| state | UserInputState |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 7
- 462 Change ThreadSafety of TouchRotate from to Unsafe
- 161 Change Parameters of TouchRotate from (touchPositions: Array, rotation: float, velocity: float, state: UserInputState) to (touchPositions: Array, rotation: float, velocity: float, state: UserInputState, gameProcessedEvent: bool)
- 138 Change Security of TouchRotate from RobloxScriptSecurity to None
- 131 Change Parameters of TouchRotate from (rotation: float, velocity: float, state: UserInputState, position: Vector2) to (touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
- 130 Change Parameters of TouchRotate from (rotation: float, velocity: float) to (rotation: float, velocity: float, state: UserInputState, position: Vector2)
- 128 Change Security of TouchRotate from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchRotate
TouchStarted
| Parameters (2) | |
|---|---|
| touch | InputObject |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 7
- 483 Change Parameters of TouchStarted from (touch: Instance, gameProcessedEvent: bool) to (touch: InputObject, gameProcessedEvent: bool)
- 462 Change ThreadSafety of TouchStarted from to Unsafe
- 161 Change Parameters of TouchStarted from (touch: Instance) to (touch: Instance, gameProcessedEvent: bool)
- 138 Change Security of TouchStarted from RobloxScriptSecurity to None
- 133 Change Parameters of TouchStarted from (touch: InputObject) to (touch: Instance)
- 128 Change Security of TouchStarted from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchStarted
TouchSwipe
| Parameters (3) | |
|---|---|
| swipeDirection | SwipeDirection |
| numberOfTouches | int |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 6
- 462 Change ThreadSafety of TouchSwipe from to Unsafe
- 161 Change Parameters of TouchSwipe from (swipeDirection: SwipeDirection, numberOfTouches: int) to (swipeDirection: SwipeDirection, numberOfTouches: int, gameProcessedEvent: bool)
- 138 Change Security of TouchSwipe from RobloxScriptSecurity to None
- 128 Change Security of TouchSwipe from RobloxSecurity to RobloxScriptSecurity
- 128 Change Parameters of TouchSwipe from (swipeDirection: SwipeDirection) to (swipeDirection: SwipeDirection, numberOfTouches: int)
- 113 Add TouchSwipe
TouchTap
| Parameters (2) | |
|---|---|
| touchPositions | Array |
| gameProcessedEvent | bool |
| Thread safety | Unsafe |
|---|
History 6
- 462 Change ThreadSafety of TouchTap from to Unsafe
- 161 Change Parameters of TouchTap from (touchPositions: Array) to (touchPositions: Array, gameProcessedEvent: bool)
- 138 Change Security of TouchTap from RobloxScriptSecurity to None
- 131 Change Parameters of TouchTap from (position: Vector2) to (touchPositions: Array)
- 128 Change Security of TouchTap from RobloxSecurity to RobloxScriptSecurity
- 113 Add TouchTap
TouchTapInWorld
| Parameters (2) | |
|---|---|
| position | Vector2 |
| processedByUI | bool |
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of TouchTapInWorld from to Unsafe
- 297 Add TouchTapInWorld
UserCFrameChanged
| Parameters (2) | |
|---|---|
| type | UserCFrame |
| value | CFrame |
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 4
- 605 Change Tags of UserCFrameChanged from [] to [Deprecated]
- 605 Change PreferredDescriptor of UserCFrameChanged from to UserCFrameChanged
- 462 Change ThreadSafety of UserCFrameChanged from to Unsafe
- 236 Add UserCFrameChanged
UserHeadCFrame
| Type | Default | |
|---|---|---|
| CFrame | ||
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 5
- 553 Change Default of UserHeadCFrame from to
- 486 Change ThreadSafety of UserHeadCFrame from ReadOnly to ReadSafe
- 462 Change ThreadSafety of UserHeadCFrame from to ReadOnly
- 236 Change Tags of UserHeadCFrame from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 229 Add UserHeadCFrame
VREnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false/true |
WindowFocusReleased
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of WindowFocusReleased from to Unsafe
- 189 Add WindowFocusReleased
- 188 Remove WindowFocusReleased
- 189 Add WindowFocusReleased
WindowFocused
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of WindowFocused from to Unsafe
- 189 Add WindowFocused
- 188 Remove WindowFocused
- 189 Add WindowFocused
Removed members 10
InCameraGesture
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 220 Remove InCameraGesture
- 150 Add InCameraGesture
IsLuaTouchControls
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 230 Remove IsLuaTouchControls
- 131 Add IsLuaTouchControls
IsStudioTouchEmulationEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|
History 2
IsVREnabled
| Type | Default | |
|---|---|---|
| bool | ||
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is read-only. Its value can be read, but it cannot be modified.
| Category | |
|---|---|
| Loaded/Saved | false |
History 3
- 240 Remove IsVREnabled
- 230 Change Tags of IsVREnabled from [ReadOnly] to [ReadOnly, Deprecated]
- 229 Add IsVREnabled
OverrideMouseIconEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
ProcessedEvent
| Parameters (2) | |
|---|---|
| inputObject | Instance |
| processed | bool |
| Security | RobloxScriptSecurity |
|---|
History 2
- 230 Remove ProcessedEvent
- 143 Add ProcessedEvent
RotateCamera
| Parameters (1) | ||
|---|---|---|
| positionDelta | Vector2 | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 230 Remove RotateCamera
- 131 Add RotateCamera
TouchControlsEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxPlaceSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 118 Remove TouchControlsEnabled
- 115 Add TouchControlsEnabled
ZoomCamera
| Parameters (1) | ||
|---|---|---|
| zoomDelta | float | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 230 Remove ZoomCamera
- 131 Add ZoomCamera