GamepadEnabled

NotReplicated

This item is not replicated across Roblox’s server/client boundary.

ReadOnly

This property can only be read from. Attempting to write to it will cause an error.

Value Type: bool

Description:

This property describes whether the device being used by a user has an available gamepad.

local userInputService = game:GetService(“UserInputService”)

if userInputService.GamepadEnabled then
	print(“Gamepad enabled”)
else
	print(“Gamepad not enabled”)
end

If gamepads are available, you can use UserInputService/GetConnectedGamepads to retrieve a list of connected gamepads and UserInputService/GetNavigationGamepads to retrieve a list of connected gamepads that also controlnavigation GUIs.

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

See this page for articles on cross-platform development.

Code Samples

How to Use the Right Gamepad for Input

The following code sample is used in the default gamepad script, so if you are using the default controls you do not need to worry about this. If you are creating a custom script for handling gamepad controls, this is a good template for retrieving which Enum/UserInputType|gamepad enum you should use as the primary gamepad controller.

This code looks for the lowest numbered UserInputService/GetNavigationGamepad|navigation gamepad, and if no navigation gamepad is found, finds the lowest numbered UserInputService/GetConnectedGamepad|connected gamepad. If there is no connected gamepad, we default to gamepad1. This ensures at least some gamepad will be able to do controls.

Expand

local UserInputService = game:GetService("UserInputService")

local activeGamepad = nil
function GetActiveGamepad()
	local activateGamepad = nil
	local navigationGamepads = {}
	
	navigationGamepads = UserInputService:GetNavigationGamepads()
	
	if #navigationGamepads > 1 then
		for i = 1, #navigationGamepads do
			if activateGamepad == nil then
				activateGamepad = navigationGamepads[i]
			elseif navigationGamepads[i].Value < activateGamepad.Value then
				activateGamepad = navigationGamepads[i]
			end
		end
	else
		local connectedGamepads = {}
		
		connectedGamepads = UserInputService:GetConnectedGamepads()
		
		if #connectedGamepads > 0 then
			for i = 1, #connectedGamepads do
				if activateGamepad == nil then
					activateGamepad = connectedGamepads[i]
				elseif connectedGamepads[i].Value < activateGamepad.Value then
					activateGamepad = connectedGamepads[i]
				end
			end
		end
		if activateGamepad == nil then -- nothing is connected, at least set up for gamepad1
			activateGamepad = Enum.UserInputType.Gamepad1
		end
	end

	return activateGamepad
end

if UserInputService.GamepadEnabled then
	activeGamepad = GetActiveGamepad()
end

Copy Code Light Theme

GamepadEnabled

See also

Code Samples

How to Use the Right Gamepad for Input