This property describes whether the user's device has an accelerometer

An accelerometer is a component found in most mobile devices that measures acceleration (change in speed).

For example, the following code snippet demonstrates how to check if the user's device has an accelerometer.

1
2
3
4
5
6
7
8

local UserInputService = game:GetService("UserInputService")

local accelerometerEnabled = UserInputService.AccelerometerEnabled
if accelerometerEnabled then
	print("Accelerometer enabled!")
else
	print("Accelerometer not enabled!")
end

If the device has an enabled accelerometer, you can get it's current acceleration by using the UserInputService:GetDeviceAcceleration() function or track when the device's acceleration changes by using the UserInputService.DeviceAccelerationChanged event.

As UserInputService is client-side only, this property can only be used in a LocalScript.

The DeviceAccelerationChanged event fires when a user moves a device that has an accelerometer.

An accelerometer is a component found in most mobile devices that measures acceleration (change in speed).

To determine whether a user's device has an accelerometer enabled, seeUserInputService.AccelerometerEnabled.

This event can be used to track the movement of a device that has an accelerometer. A sample usage includes moving the player character when a mobile device accelerates.

Additionally, this event can be used along with UserInputService:GetDeviceAcceleration() to determine the current movement of a user's device if the device has an accelerometer.

This event only fires locally - which means that only the player whose device moves can use the event and it will only work in a LocalScript.

The UserInputService.DeviceGravityChanged event fires when the device's gravity Vector3 changes on a device that has an accelerometer.

A device's gravity vector represent the force of gravity on each of the device's X, Y, and Z axes. While gravity never changes, the force it exerts on each axis changes when the device rotates and changes orientation. The force value exerted on each axis is a unit vector ranging from -1 to 1.

An accelerometer is a component found in most mobile devices that measures acceleration (change in speed).

This event can be used to determine the real-world direction of the force of gravity on a user's device. This even can then be used to simulate the force of gravity on a user's device within the game, such as on in-game objects (see example below).

To check if a user's device has an enabled accelerometer, see UserInputService.AccelerometerEnabled. If the device has an enabled accelerometer, you can use the UserInputService:GetDeviceGravity() function to get the current force of gravity on the user's device.

The DeviceRotationChanged event fires when a user rotates a device that has a gyroscope.

A gyroscope is a component found in most mobile devices that detects orientation and rotational speed.

The event is useful when tracking the orientation of the device and how changes as the user rotates their device. To determine the current device rotation, you can use the UserInputService:GetDeviceRotation() function.

To check if a user's device has an enabled gyroscope, and that this event will fire, see UserInputService.GyroscopeEnabled.

This event only fires when the Roblox client window is in focus. For example, inputs will not be captured when the window is minimized.

The GamepadConnected event fires when a gamepad is connected to the client.

Since a Roblox game supports multiple controllers, this event is useful when paired with the UserInputService.GamepadDisconnected event to track which controllers/gamepads are active. You can also use UserInputService:GetConnectedGamepads() to find the correct gamepad to use.

The following example demonstrates a usage example of a tracking when a gamepad is connected to the client.

1
2
3
4
5
6
7

local UserInputService = game:GetService("UserInputService")

local function GamepadConnected(gamepad)
	print("Player has plugged controller: " .. tostring(gamepad))
end)

UserInputService.GamepadConnected:Connect(GamepadConnected)

If you want to see which devices are connected, you can use the UserInputService:GetConnectedGamepads() function.

As this event fires locally, it can only be used in a LocalScript.

See also:

• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GetGamepadConnected()
• UserInputService:GamepadSupports()
• UserInputService.GamepadEnabled

The GamepadDisconnected event fires when a gamepad is disconnected.

Since a Roblox game supports multiple controllers, this event is useful when paired with the UserInputService.GamepadConnected event to track which controllers/gamepads are active. You can also use UserInputService:GetConnectedGamepads() to find the correct gamepad to use.

The following example demonstrates a usage example of a tracking when a gamepad is disconnected from the client.

1
2
3
4
5
6
7

local UserInputService = game:GetService("UserInputService")

local function GamepadDisconnected(gamepad)
	print("Player has unplugged controller: " .. tostring(gamepad))
end)

UserInputService.GamepadDisconnected:Connect(GamepadDisconnected)

As this event fires locally, it can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GetGamepadConnected()
• UserInputService:GamepadSupports()
• UserInputService.GamepadEnabled

This property describes whether the device being used by a user has an available gamepad. If gamepads are available, you can use UserInputService:GetConnectedGamepads() to retrieve a list of connected gamepads.

As UserInputService is client-side only, this property can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GetGamepadConnected()
• UserInputService:GamepadSupports()

This function returns whether the given UserInputType gamepad supports a button corresponding with the given KeyCode. This function is used to determine valid gamepad inputs.

To determine which UserInputType gamepads are connected, use UserInputService:GetConnectedGamepads().

As UserInputService is client-side only, this function can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GetGamepadConnected()
• UserInputService.GamepadEnabled

This function returns an array of UserInputType gamepads currently connected. If no gamepads are connected, this array will be empty. Additionally, it only returns UserInputType objects that are gamepads. For instance, this event will return a connected Gamepad1 object but not a Keyboard object.

For example, the following code snippet retrieves the connected gamepads and stores them in a variable named connectedGamepads.

1
2

local UserInputService = game:GetService("UserInputService")
local connectedGamepads = UserInputService:GetConnectedGamepads()

To check if a specific gamepad is connected, use UserInputService:GetGamepadConnected().

As UserInputService is client-side only, this function can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GetGamepadConnected()
• UserInputService:GamepadSupports()
• UserInputService.GamepadEnabled

The GetDeviceAcceleration function determines the current acceleration of the user's device. It returns an InputObject that describes the device's current acceleration.

In order for this to work, the user's device must have an enabled accelerometer. To check if a user's device has an enabled accelerometer, you can check the UserInputService.AccelerometerEnabled property.

If you want to track when the user's device's acceleration changes instead, you can use the UserInputService.DeviceAccelerationChanged event.

Since it only fires locally, it can only be used in a LocalScript.

This function returns an InputObject describing the device's current gravity vector.

The gravity vector is determined by the device's orientation relative to the real-world force of gravity. For instance, if a device is perfectly upright (portrait), the gravity vector is Vector3.new(0, 0, -9.18). If the left side of the device is pointing down, the vector is Vector3.new(9.81, 0, 0). Finally, if the back of the device is pointing down, the vector is Vector3.new(0, -9.81, 0).

This function might be used to enable the user's device to impact or control gravity within the game or move in-game objects such as a ball.

Gravity is only tracked for players using a device with an enabled gyroscope - such as a mobile device.

To check if a user's device has an enabled gyroscope, check the value of UserInputService.GyroscopeEnabled. If the device has an enabled gyroscope, you can also use the UserInputService.DeviceGravityChanged event to track when force of gravity on the user's device changes.

As UserInputService is client-side only, this function can only be used in a LocalScript.

This function returns an InputObject and a CFrame describing the device's current rotation vector.

This is fired with an InputObject. The Position property of the input object is a Enum.InputType.Gyroscope that tracks the total rotation in each local device axis.

Device rotation can only be tracked on devices with a gyroscope.

As this function fires locally, it can only be used in a LocalScript.

This function returns the TextBox the client is currently focused on. A TextBox can be manually selected by the user, or selection can be forced using the TextBox:CaptureFocus() function. If no TextBox is selected, this function will return nil.

As UserInputService is client-side only, this function can only be used in a LocalScript.

See also:

• UserInputService.TextBoxFocused
• UserInputService.TextBoxFocusReleased
• TextBox:CaptureFocus()
• TextBox:IsFocused()
• TextBox:ReleaseFocus()

This function returns whether a gamepad with the given UserInputType is connected to the client.

This can be used to check if a specific gamepad, such as 'Gamepad1' is connected to the client's device.

To retrieve a list of all connected gamepads, use UserInputService:GetConnectedGamepads().

As UserInputService is client-side only, this function can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadState()
• UserInputService:GamepadSupports()
• UserInputService.GamepadEnabled

This function returns an array of InputObjects for all available inputs on the given UserInputType gamepad, representing each input's last input state.

To find the UserInputTypes of connected gamepads, use UserInputService:GetConnectedGamepads().

As this function only fires locally, it can only be used in a LocalScript.

See also:

• UserInputService.GamepadConnected
• UserInputService.GamepadDisconnected
• UserInputService:GetConnectedGamepads()
• UserInputService:IsGamepadButtonDown()
• UserInputService:GetSupportedGamepadKeyCodes()
• UserInputService:GetGamepadConnected()
• UserInputService:GamepadSupports()
• UserInputService.GamepadEnabled