VRService¶
Not yet Class NotCreatable Service
Service responsible for handling interactions between Roblox and Virtual Reality (VR).
Not implemented yet
No VR backend.
0 Nova members · 27 modern Roblox members not implemented yet
Description¶
VRService is responsible for handling interactions between Roblox and Virtual Reality (VR). Its methods, properties, and events help you provide the best experience for end users seeking to experience Roblox on VR devices.
See VR Guidelines for more information on publishing an experience for VR devices.
Inheritance¶
Properties¶
| Member | Signature | Summary |
|---|---|---|
AutomaticScaling |
AutomaticScaling: VRScaling |
Automatically adjusts scaling in VR to align the player with their avatar. |
AvatarGestures |
AvatarGestures: bool |
When true, a VR player will be able to animate their hands and head using their controllers and headset. |
ControllerModels |
ControllerModels: VRControllerModelMode |
Controls whether and how the player's VR hand controllers are rendered in the experience. |
DidPointerHit |
DidPointerHit: bool |
— |
FadeOutViewOnCollision |
FadeOutViewOnCollision: bool |
When true, a VR player's view will fade to black when their head collides with an object. |
GuiInputUserCFrame |
GuiInputUserCFrame: UserCFrame |
Describes what UserCFrame is responsible for input in VR. |
LaserDistance |
LaserDistance: float |
— |
LaserPointer |
LaserPointer: VRLaserPointerMode |
Controls whether and how the VR laser pointer used to interact with the user interface is displayed. |
PointerHitCFrame |
PointerHitCFrame: CFrame |
— |
QuestASWState |
QuestASWState: bool |
— |
QuestDisplayRefreshRate |
QuestDisplayRefreshRate: float |
— |
ThirdPersonFollowCamEnabled |
ThirdPersonFollowCamEnabled: bool |
Indicates whether the third-person follow camera is enabled for the VR user. |
VRDeviceAvailable |
VRDeviceAvailable: bool |
— |
VRDeviceName |
VRDeviceName: string |
— |
VREnabled |
VREnabled: bool |
Describes whether the user is using a virtual reality device. |
VRSessionState |
VRSessionState: VRSessionState |
— |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetTouchpadMode |
VRService:GetTouchpadMode(pad: VRTouchpad): VRTouchpadMode |
Returns the VRTouchpadMode indicating the mode of a specified VRTouchpad. |
GetUserCFrame |
VRService:GetUserCFrame(type: UserCFrame): CFrame |
Returns a CFrame describing the position & orientation of a specified virtual reality device as an offset from a point in real world space. |
GetUserCFrameEnabled |
VRService:GetUserCFrameEnabled(type: UserCFrame): bool |
Returns true if the specified UserCFrame is available to be listened to. |
IsMaquettes |
VRService:IsMaquettes(): bool |
— |
IsVRAppBuild |
VRService:IsVRAppBuild(): bool |
— |
RecenterUserHeadCFrame |
VRService:RecenterUserHeadCFrame(): null |
Re-centers the CFrame to the current location of the VR headset being worn by the user. |
RequestNavigation |
VRService:RequestNavigation(cframe: CFrame, inputUserCFrame: UserCFrame): null |
Requests navigation to the specified CFrame using the specified UserCFrame as the origin for the visualizer parabola. |
SetTouchpadMode |
VRService:SetTouchpadMode(pad: VRTouchpad, mode: VRTouchpadMode): null |
Sets the mode of the specified VRTouchpad to the specified VRTouchpadMode. |
Events¶
| Member | Signature | Summary |
|---|---|---|
LaserPointerTriggered |
LaserPointerTriggered(input: InputObject) |
— |
NavigationRequested |
NavigationRequested(cframe: CFrame, inputUserCFrame: UserCFrame) |
Fired when navigation is requested from VRService. |
TouchpadModeChanged |
TouchpadModeChanged(pad: VRTouchpad, mode: VRTouchpadMode) |
Fires if the VRTouchpadMode of a VRTouchpad is changed. |
UserCFrameChanged |
UserCFrameChanged(type: UserCFrame, value: CFrame) |
Fires when a UserCFrame is changed. |
UserCFrameEnabled |
UserCFrameEnabled(type: UserCFrame, enabled: bool) |
Fires when a UserCFrame is enabled or disabled. |
Roblox reference: VRService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.