GetGamepadConnected

Function of:

Description:

This function returns whether a gamepad with the given Enum/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.

Check out this article to learn more about adding support for gamepad input into your game and 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 in question

Returns

Return Type	Summary
Return Type bool	Summary Whether a gamepad associated with `Enum/UserInputType` is connected

Code Samples

Check Whether a Gamepad is Connected

This example returns whether Enum/UserInputType|Gamepad1 is connected to the client. It will print true if Gamepad1 is connected and false if Gamepad1 is not connected.

local UserInputService = game:GetService("UserInputService")

local isConnected = UserInputService:GetGamepadConnected(Enum.UserInputType.Gamepad1)

if isConnected then
    print("Gamepad1 is connected to the client")
else
    print("Gamepad1 is not connected to the client")
end

GetGamepadConnected

See also

Parameters

gamepadNum

Returns

bool

Code Samples

Check Whether a Gamepad is Connected