Gamepad input | Documentation - Roblox Creator Hub

Roblox accepts input from gamepads such as Xbox and PlayStation controllers. To simplify cross‑platform inputs, including gamepads, Roblox provides the Input Action System to define actions such as "jump," "sprint," or "shoot" and set up bindings for multiple hardware inputs to drive those actions.

When binding gamepad inputs, see common control schemas to create a consistent gamepad experience for players. After inputs are set, you can enhance the player's experience by including haptic feedback on supported controllers.

As you build out support for gamepads, remember to test frequently using a connected gamepad or the Controller Emulator in Studio.

Input type detection

In cross‑platform development, it's important that you determine and respond to the PreferredInput type a player is using, normally to ensure that UI elements like on-screen buttons and menus work elegantly and support interaction across devices.

For example, a console assumes that gamepads are the default input, but a player on PC or laptop may also choose to connect a bluetooth gamepad. In this case, mouse/keyboard remains a valid input for that player, but you can assume they want to switch to the connected gamepad as the primary input type.

See input type detection for more information.

For alternative gamepad detection methods, see the UserInputService.GamepadEnabled property and the GamepadConnected/GamepadDisconnected events.

Common control schemas

When considering specific control bindings for the Input Action System, it's best to establish consistency across different games. The following input bindings will help players immediately feel familiar and comfortable with gamepad controls.

Input	Common use cases
ButtonA	Accepts player prompts or GUI selections. Alternatively used for primary actions such as jumping.
ButtonB	Cancels player prompts or GUI selections. Alternatively used for secondary actions such as a dodge, roll, or sprint.
Thumbstick1	Generally associated with character movement.
Thumbstick2	Generally associated with camera movement.
ButtonL2, ButtonR2	Generally used for primary actions, such as shooting.
ButtonL1, ButtonR1, ButtonX, ButtonY	Secondary actions such as reloading, targeting, or accessing an inventory or minimap.

Haptic feedback

Many gamepad controllers have motors built in to provide haptic feedback. Adding rumbles and vibrations can greatly enhance a player's experience and provide subtle feedback beyond visuals or audio.

Roblox supports haptics for PlayStation gamepads, Xbox gamepads, and the Quest Touch controller. Haptic feedback is managed through HapticEffect instances which can be set to a specific Type such as GameplayCollision or UIClick.

Once a HapticEffect is in place, you can initiate it through the Play() method, for instance:


local Workspace = game:GetService("Workspace")

local effect = Instance.new("HapticEffect")
effect.Type = Enum.HapticEffectType.GameplayExplosion
effect.Parent = Workspace

-- Play the haptic effect
effect:Play()

Controller emulation

The Controller Emulator, accessible from Studio's Test menu, lets you accurately emulate gamepad input directly in Studio. The default controller is a generic gamepad, but you can select alternatives from the upper‑left picker menu.

View of the generic controller in the Controller Emulator.

While playtesting, you can control the game with the virtual controller using your mouse.

You can also click Edit mappings in the upper‑right corner to view and edit key mappings for the virtual controller, for example E to ButtonL2 or 9 to ButtonA. These mappings are saved like other Studio settings (per controller, per user, per computer) and are translated to gamepad events in both the emulator window and the 3D viewport.