VRService | Documentation - Roblox Creator Hub (2024)

When set to Enum.VRScaling.World, Camera.HeadScale adjusts sothat the scale of the world is seen from the avatar's perspective. Aplayer with a small avatar will perceive the objects around them as largerthan a player with a large avatar will.

When set to true, a VR player will be able to animate their hands and headusing their controllers and headset.

This property must be set on the server.

When true, a VR player's view fades to black when their head collides withan object. This property prevents players from being able to see throughwalls while in VR. The default value is true.

This property describes what Enum.UserCFrame is responsible for input inVR. For instance, if a VR headset is responsible, the value of thisproperty will be Enum.UserCFrame.Head.

To check if Roblox detects any VR devices, which would be responsible forinput in VR, you can check the VREnabledproperty.

local VRService = game:GetService("VRService")
if VRService.VREnabled then
print(VRService.GuiInputUserCFrame.Name)
else
print("No VR device detected!")
end

This property describes whether the user is using a virtual reality (VR)device.

If a VR device is enabled, you can interact with its location and movementthrough methods such as UserInputService:GetUserCFrame(). You canalso react to VR device movement using theUserInputService.UserCFrameChanged event.

local UserInputService = game:GetService("UserInputService")
local isUsingVR = UserInputService.VREnabled
if isUsingVR then
 print("User is using a VR headset!")
else
 print("User is not using a VR headset!")
end

This property can only be used in a LocalScript.

See Also

• Camera.HeadLocked

• UserInputService:GetUserCFrame()

• UserInputService.UserCFrameChanged

local UserInputService = game:GetService("UserInputService")
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local character = player.CharacterAdded:Wait()
local head = character:WaitForChild("Head")
local function TrackHead(inputType, value)
if inputType == Enum.UserCFrame.Head then
head.CFrame = value
end
end
if UserInputService.VREnabled then
-- Set the inital CFrame
head.CFrame = UserInputService:GetUserCFrame(Enum.UserCFrame.Head)
-- Track VR headset movement and mirror for character's head
UserInputService.UserCFrameChanged:Connect(TrackHead)
end

This method returns the Enum.VRTouchpadMode indicating the mode of aspecified Enum.VRTouchpad. The returned mode indicates how the userinteracts with their touchpad to play the game.

This can also be used alongside the several UserInputService VRmethods and events.

This method will only work when used in a LocalScript.

Parameters

Returns

local VRService = game:GetService("VRService")
VRService:GetTouchpadMode(Enum.VRTouchpad.Left)

This method returns a CFrame describing the position andorientation of a specified virtual reality (VR) device as an offset from apoint in real world space. This method should be used when implementing VRcompatibility into a game to obtain and track the movement of a connectedVR device.

By using the method, developers can implement features such asre-positioning the user's in-game character corresponding to the locationof a connected VR device. This can be done by changing the CFrame of theuser's in-game character to match the CFrame of the specified VR deviceusing the UserCFrame enum and CFrame value arguments passed by theevent.

VRService also provides aUserCFrameChanged event thatautomatically fires when the CFrame of connected VR devicechanges, so long it is used in a LocalScript.

This method will only work when used in a LocalScript.

Parameters

Returns

local Workspace = game:GetService("Workspace")
local VRService = game:GetService("VRService")
local camera = Workspace.CurrentCamera
local part = script.Parent.Part
local handOffset = VRService:GetUserCFrame(Enum.UserCFrame.LeftHand)
-- Account for headscale
handOffset = handOffset.Rotation + handOffset.Position * camera.HeadScale
part.CFrame = camera.CFrame * handOffset

This method returns true if the specified Enum.UserCFrame virtualreality device (VR) is available to be listened to. It can be used todetermine whether a specified VR device, such as Enum.UserCFrame.Head,is connected to the user's game.

This can also be used alongside the several UserInputService VRmethods and events.

This method will only work when used in a LocalScript.

Parameters

Returns

local VRService = game:GetService("VRService")
local isEnabled = VRService:GetUserCFrameEnabled(Enum.UserCFrame.Head)
if isEnabled then
print("VR device is enabled!")
else
print("VR device is disabled!")
end

This method re-centers the CFrame of the user's head to thecurrent location of the VR headset being worn by the user. It can be usedto ensure that the user's in-game head is positioned according to thelocation of the user's VR headset.

This behaves identically toUserInputService:RecenterUserHeadCFrame().

This method will only work when used in a LocalScript.

Returns

local VRService = game:GetService("VRService")
VRService:RecenterUserHeadCFrame()

This method requests navigation to the specified CFrame usingthe specified Enum.UserCFrame as the origin for the visualizer parabola.It can be used to incorporate virtual reality (VR) into your game byproviding a means to visualize a navigation path from the user's VR deviceto a destination.

VRService has a similar event,NavigationRequested, used to detectsuch requests. This can also be used alongside the severalUserInputService VR methods and events.

This method will only work when used in a LocalScript.

Parameters

Returns

local VRService = game:GetService("VRService")
local destination = workspace:FindFirstChild("NavigationDestination")
VRService:RequestNavigation(Enum.UserCFrame.Head, destination.CFrame)

This method sets the mode of the specified Enum.VRTouchpad to thespecified Enum.VRTouchpadMode. It can be used to change the user'svirtual reality (VR) touchpad mode so that the user interacts with thegame differently using the touchpad.

This can also be used alongside the several UserInputService VRmethods and events.

This method will only work when used in a LocalScript.

Parameters

Returns

local VRService = game:GetService("VRService")
VRService:SetTouchpadMode(Enum.VRTouchpad.Left, Enum.VRTouchpadMode.Touch)

This event fires when navigation is requested from VRService for aspecified Enum.UserCFrame VR device. It fires with a CFramecoordinate and the specified Enum.UserCFrame indicating the devicerequesting the navigation.

This event can be used alongside UserInputService service eventsand methods.

Since this event fires locally, it can only be used in aLocalScript.

Parameters

local VRService = game:GetService("VRService")
VRService.TouchpadModeChanged:Connect(function(cframe, inputUserCFrame)
print(inputUserCFrame.Name .. " made request with CFrame: " .. cframe)
end)

This event fires if the Enum.VRTouchpadMode of a Enum.VRTouchpad ischanged. You can use this event to track the states of VR touchpadsconnected via the user's client.

This event can be used alongside UserInputService service eventsand methods.

Since this event fires locally, it can only be used in aLocalScript.

Parameters

local VRService = game:GetService("VRService")
VRService.NavigationRequested:Connect(function(pad, mode)
print(pad.Name .. " Touchpad changed to state: " .. mode.Name)
end)

This event fires when a Enum.UserCFrame is changed, for instance whenthe user moves a connected VR device. It can be used alongsideGetUserCFrame() to track theCFrame coordinates of a VR device, and when it changes/moves.It can also be used alongside UserInputService service events andmethods.

Since this event fires locally, it can only be used in aLocalScript.

Parameters

local VRService = game:GetService("VRService")
VRService.UserCFrameChanged:Connect(function(userCFrameType, cframeValue)
print(userCFrameType.Name .. " changed. Updated Frame: " .. tostring(cframeValue))
end)

This event fires when a Enum.UserCFrame is enabled or disabled. It canbe used alongsideGetUserCFrameEnabled() to trackwhether a specified UserCFrame is enabled, and when itsstate changes. It can also be used alongside UserInputServiceservice events and methods.

Since this event fires locally, it can only be used in aLocalScript.

Parameters

local VRService = game:GetService("VRService")
VRService.UserCFrameEnabled:Connect(function(type, enabled)
if enabled then
print(type.Name .. " got enabled!")
else
print(type.Name .. " got disabled!")
end
end)