GamepadSupports

Unsafe

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

Function of:

Description:

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

To determine which Enum/UserInputType gamepads are connected, use UserInputService/GetConnectedGamepads.

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

See this page for articles on cross-platform development.

Parameters

Name	Type	Default	Description
Name gamepadNum	Type UserInputType	Default	Summary The `Enum/UserInputType` of the gamepad
Name gamepadKeyCode	Type KeyCode	Default	Summary The `Enum/KeyCode` of the button in question

Returns

Return Type	Summary
Return Type bool	Summary Whether the given gamepad supports a button corresponding with the given `Enum/KeyCode\|KeyCode`

Code Samples

Binding Functions to Gamepad Controls

This example binds the Enum/KeyCode|ButtonX key to action if it is supported by controller (Enum/UserInputType|Gamepad1). If bound, pressing the X Button invokes the action() function, which prints “Action”.

			
				Binding Functions to Gamepad Controls

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

local controller = Enum.UserInputType.Gamepad1
local buttonX = Enum.KeyCode.ButtonX

local function isSupported(gamepad, keycode)
	return UserInputService:GamepadSupports(gamepad, keycode)
end

local function action()
	print("Action")
end

if isSupported(controller, buttonX) then
	ContextActionService:BindAction("sample action", action, false, buttonX)
end
		
				Copy Code
			
				Light Theme

GamepadSupports

See also

Parameters

gamepadNum

gamepadKeyCode

Returns

bool

Code Samples

Binding Functions to Gamepad Controls