Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GamepadService

The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 6

HistoryMember
553GamepadCursorEnabled: bool
573DisableGamepadCursor(): null
573EnableGamepadCursor(guiObject: Instance): null
462GetGamepadCursorPosition(): Vector2
573SetGamepadCursorPosition(position: Vector2): null
499GamepadThumbstick1Changed(event: Vector2)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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.

History 21

Members 6

DisableGamepadCursor

Parameters (0)
No parameters.
Returns (1)
null

This function disables the gamepad cursor, if it's currently enabled.

Thread safetyUnsafe

History 2

EnableGamepadCursor

Parameters (1)
guiObjectInstance
Returns (1)
null

This function enables the gamepad cursor if it's currently disabled. If the cursor is already enabled, calling the API updates the cursor's position. The function accepts a GuiObject parameter, but there are some invalid cases. Please note that in order to set the cursor to the default position, nil must be passed in as a parameter. Providing no argument will result in an error.

Input GuiObjectCursor Starting Position
NilDefault position
Not a GuiObjectCursor does not appear, errors
Not a child of BasePlayerGuiCursor does not appear, errors
GuiObject has Visible 2 set to false or any parent visible set to falseDefault position with warning
Child of ScreenGui 1 with Enabled 1 set to falseDefault position with warning
Child of BillboardGui 4 or SurfaceGuiDefault position with warning
GuiObject outside the viewport (Or, any part of the gui object that is off screen)Default position with warning
Child of ScrollingFrame with clipping set to false: GuiObject outside of scrolling frame (Object child of scrolling frame and not visible on screen)Default position with warning
Child of ScrollingFrame with clipping set to true: GuiObject outside scrolling frame window but inside viewportGuiObject moves into the scrolling frame and starts the cursor centered over the object
GuiObject inside the frame and visibleCursor starts centered on the GuiObject
Thread safetyUnsafe

History 2

GamepadCursorEnabled

TypeDefault
boolfalse

This boolean is a read only variable that maintains the state of the gamepad virtual cursor.

Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 9

GamepadThumbstick1Changed

Parameters (1)
eventVector2
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetGamepadCursorPosition

Parameters (0)
No parameters.
Returns (1)
Vector2
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetGamepadCursorPosition

Parameters (1)
positionVector2
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Settings