1. apireference
2. input
3. userinputservice

GetGamepadState

Parameters

Name	Type	Default	Description
Name gamepadNum	Type UserInputType	Default	Summary The Enum/UserInputType corresponding with the gamepad in question

Returns

Return Type	Summary
Return Type Array	Summary An array of InputObject|InputObjects representing the current state of all available inputs for the given gamepad

---

Code Samples

---

Mapping and Polling GamepadStates

This example demonstrates how to map a Enum/UserInputType|gamepad’s states to their corresponding Enum|KeyCode|KeyCodes, and then you can always reference them. Since the states are mutable; you don’t have to keep calling GetGamepadState once they are mapped. Then, you can reference the states of the gamepad’s controls using KeyCodes and indices - such as to poll the Thumbstick1 position.

local UserInputService = game:GetService(“UserInputService”)

local _states = UserInputService:GetGamepadState(Enum.UserInputType.Gamepad1)
local states = {}
for _,state in pairs(_states) do
	states[state.KeyCode] = state
end

-- Poll the Thumbstick position:
local thumbstick1 = states[Enum.KeyCode.Thumbstick1]
while true do
	wait(0.1)
	print(thumbstick1.Position)
end