GamepadService¶
The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers.
Description¶
The GamepadService is internally responsible for handling inputs from various
controllers, such as Xbox One or PlayStation DualShock controllers. It also
handles APIs used with the gamepad virtual cursor. You can enable the gamepad
cursor for your experience by setting VirtualCursorMode under
StarterGui to Enabled.
Inheritance¶
Object → Instance → GamepadService
Nova inheritance: Instance → GamepadService
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
7 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's GamepadService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GamepadCursorEnabled |
GamepadCursorEnabled: bool |
Not yet | The state of the gamepad virtual cursor. | read None / write RobloxScriptSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AutoSelectGui |
GamepadService:AutoSelectGui(): null |
Not yet | — | RobloxScriptSecurity |
DisableGamepadCursor |
GamepadService:DisableGamepadCursor(): null |
Not yet | Disables the gamepad cursor, if currently enabled. | — |
EnableGamepadCursor |
GamepadService:EnableGamepadCursor(guiObject: Instance): null |
Not yet | Enables the gamepad cursor or updates its position. | — |
GetGamepadCursorPosition |
GamepadService:GetGamepadCursorPosition(): Vector2 |
Not yet | — | RobloxScriptSecurity |
SetGamepadCursorPosition |
GamepadService:SetGamepadCursorPosition(position: Vector2): null |
Not yet | — | RobloxScriptSecurity |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GamepadThumbstick1Changed |
GamepadThumbstick1Changed(event: Vector2) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: GamepadService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.