PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar

GetTouchpadMode

The GetTouchpadMode function returns the Enum/VRTouchpadMode indicating the mode of a specified Enum/VRTouchpad.

The returned mode indicates how the user interacts with their touchpad to play the game. For more information about the different types of modes, see the Enum/VRTouchpadMode page.

This can also be used alongside the several /UserInputService VR functions and events.

Since /VRService only runs client-side, this function will only work when used in a /LocalScript.

Parameters

Name Type Default Description

pad

The specified VRTouchpad.

Returns

Return Type Summary

The mode of the specified VRTouchpad.


Code Samples


VRService:GetTouchpadMode

This example retrieves and prints the name of the user’s current VRTouchpad.Left touchpad mode.