API:Class/VRService

Client only:This service is client-side only! You should use a LocalScript instead of a Script when using it.
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.

VRService.pngVRService : Object Icon.pngInstance

The VRService is a service that is responsible for handling interactions between ROBLOX and Virtual Reality.

Properties

Properties [toggle]

UserCFrameGuiInputUserCFrame

Describes what UserCFrame is responsible for input in VR.

|RMD member="API:Class/VRService/GuiInputUserCFrame"|Describes what UserCFrame is responsible for input in VR.|/RMD|
boolVREnabled [readonly]

Becomes true if any VR device is detected by Roblox.

|RMD member="API:Class/VRService/VREnabled"|Becomes true if any VR device is detected by Roblox.|/RMD|
Describes what UserCFrame is responsible for input in VR.
VREnabled [readonly]
Becomes true if any VR device is detected by Roblox.

Functions

Functions [toggle]

VRTouchpadModeGetTouchpadMode ( VRTouchpad pad )

No documentation found.

|RMD member="API:Class/VRService/GetTouchpadMode"|No documentation found.|/RMD|
CFrameGetUserCFrame ( UserCFrame type )

Returns a CFrame describing the position & orientation of a specified virtual reality device.

|RMD member="API:Class/VRService/GetUserCFrame"|Returns a CFrame describing the position & orientation of a specified virtual reality device.|/RMD|
boolGetUserCFrameEnabled ( UserCFrame type )

Returns true if the specified UserCFrame is available to be listened to.

|RMD member="API:Class/VRService/GetUserCFrameEnabled"|Returns true if the specified UserCFrame is available to be listened to.|/RMD|
voidRecenterUserHeadCFrame ( )

Recenters the CFrame of the user's head to the current location of the VR headset being worn by the user.

|RMD member="API:Class/VRService/RecenterUserHeadCFrame"|Recenters the CFrame of the user's head to the current location of the VR headset being worn by the user.|/RMD|
voidRequestNavigation ( CFrame cframe, UserCFrame inputUserCFrame )

Requests navigation to the specified CFrame, using the specified UserCFrame as the origin for the visualizer parabola.

|RMD member="API:Class/VRService/RequestNavigation"|Requests navigation to the specified CFrame, using the specified UserCFrame as the origin for the visualizer parabola.|/RMD|
voidSetTouchpadMode ( VRTouchpad pad, VRTouchpadMode mode )

No documentation found.

|RMD member="API:Class/VRService/SetTouchpadMode"|No documentation found.|/RMD|
No documentation found.
Returns a CFrame describing the position & orientation of a specified virtual reality device.
Returns true if the specified UserCFrame is available to be listened to.
Recenters the CFrame of the user's head to the current location of the VR headset being worn by the user.
RequestNavigation ( CFrame cframe, UserCFrame inputUserCFrame )
Requests navigation to the specified CFrame, using the specified UserCFrame as the origin for the visualizer parabola.
No documentation found.


Events

Events [toggle]

NavigationRequested ( CFrame cframe, UserCFrame inputUserCFrame )

Fired when navigation is requested from the VRService.

|RMD member="API:Class/VRService/NavigationRequested"|Fired when navigation is requested from the VRService.|/RMD|
TouchpadModeChanged ( VRTouchpad pad, VRTouchpadMode mode )

No documentation found.

|RMD member="API:Class/VRService/TouchpadModeChanged"|No documentation found.|/RMD|
UserCFrameChanged ( UserCFrame type, CFrame value )

Fired when a UserCFrame is changed.

|RMD member="API:Class/VRService/UserCFrameChanged"|Fired when a UserCFrame is changed.|/RMD|
UserCFrameEnabled ( UserCFrame type, bool enabled )

Fires when a UserCFrame gets enabled or disabled.

|RMD member="API:Class/VRService/UserCFrameEnabled"|Fires when a UserCFrame gets enabled or disabled.|/RMD|
NavigationRequested ( CFrame cframe, UserCFrame inputUserCFrame )
Fired when navigation is requested from the VRService.
No documentation found.
Fired when a UserCFrame is changed.
Fires when a UserCFrame gets enabled or disabled.

|RMD member="API:Class/VRService"|The VRService is a service that is responsible for handling interactions between ROBLOX and Virtual Reality. |/RMD|