GetDeviceAcceleration

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

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.

Returns

Return Type	Summary
Return Type InputObject	Summary

Code Samples

Print Device Acceleration

This example checks if a user’s device has an enabled accelerometer. If it does, the example prints the current acceleration of the device. If not, the example prints:

Cannot get device acceleration because device does not have an enabled accelerometer!

			
				Print Device Acceleration

				Expected Output
			
				Expand
				
			local UserInputService = game:GetService("UserInputService")

local accelerometerEnabled = UserInputServiceAccelerometerEnabled

if accelerometerEnabled then
	local acceleration = UserInputService:GetDeviceAcceleration().Position
	print(acceleration)
else
	print("Cannot get device acceleration because device does not have an enabled accelerometer!")
end
		
			Output may vary depending on whether the user's device has an enabled accelerometer during testing.
		
				Copy Code
			
				Light Theme