VRService

When VRService.AutomaticScaling is set to World, Camera.HeadScale adjusts so that the scale of the world is seen from the avatar's perspective. A player with a small avatar will perceive the objects around them as larger than a player with a large avatar will.

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

The GuiInputUserCFrame property describes what UserCFrame is responsible for input in VR. For instance, if a VR headset is responsible, the value of this property will be UserCFrame.Head.

To check if Roblox detects any VR devices, which would be responsible for input in VR, you can check the VRService.VREnabled property.

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

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 movement through functions such as UserInputService:GetUserCFrame(). You can also react to VR device movement using the UserInputService.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

As UserInputService isclient-side only, this property can only be used in a LocalScript.

See [this][1] article for VR best practices.

See also:

• VRService
• 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

The GetTouchpadMode function returns the VRTouchpadMode indicating the mode of a specified 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 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

Returns

local VRService = game:GetService("VRService")

VRService:GetTouchpadMode(Enum.VRTouchpad.Left)

The GetUserCFrame function returns a CFrame describing the position & orientation of a specified virtual reality (VR) device as an offset from a point in real world space.

This function should be used when implementing VR compatibility into a game to obtain and track the movement of a connected VR device.

By using the function, players can implement features such as re-positioning the user's in-game character corresponding to the location of a connected VR device. This can be done by changing the CFrame of the user's in-game character to match the CFrame of the specified VR device using the UserCFrame enum and CFrame value arguments passed by the event.

The VRService service also provides an event VRService.UserCFrameChanged that automatically fires when the CFrame of connected VR device changes - so long it is used in a LocalScript.

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

Parameters

Returns

local VRService = game:GetService("VRService")

local handOffset = VRService:GetUserCFrame(Enum.UserCFrame.LeftHand)
-- account for headscale
handOffset = handOffset.Rotation + handOffset.Position * workspace.CurrentCamera.HeadScale
part.CFrame = workspace.CurrentCamera.CFrame * handOffset

The GetUserCFrameEnabled function returns true if the specified UserCFrame virtual reality device (VR) is available to be listened to.

This can be used to determine whether a specified VR device, (e.g. UserCFrame.Head), is connected to the user's game. If the specified VR device is connected, is it enabled (true). Otherwise, it is disabled (false).

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

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

The RecentUserHeadCFrame function recenters the CFrame of the user's head to the current location of the VR headset being worn by the user.

This function can be used to ensure that the user's in-game head is positioned according to the location of the user's VR headset.

This is similar to the UserInputService function, UserInputService:RecenterUserHeadCFrame().

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

Returns

local VRService = game:GetService("VRService")

VRService:RecenterUserHeadCFrame()

The RequestNavigation function requests navigation to the specified CFrame, using the specified UserCFrame as the origin for the visualizer parabola.

This can be used to incorporate virtual reality (VR) into your game by providing a means to visualize a navigation path from the user's VR device to a destination.

The VRService has a similar event, VRService.NavigationRequested, used to detect such requests. 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

Returns

local VRService = game:GetService("VRService")

local destination = workspace:FindFirstChild("NavigationDestination")

VRService:RequestNavigation(Enum.UserCFrame.Head, destination.CFrame)

The SetTouchpadMode function sets the mode of the specified VRTouchpad to the specified VRTouchpadMode.

This can be used to change the user's virtual reality (VR) touchpad mode so that the user interacts with the game different using the touchpad. For more information about the different types of modes, see the 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

Returns

local VRService = game:GetService("VRService")

VRService:SetTouchpadMode(Enum.VRTouchpad.Left, Enum.VRTouchpadMode.Touch)

The NavigationRequested event fires when navigation is requested from the VRService for a specified UserCFrame VR device.

This is fired with a CFrame coordinate and specified UserCFrame indicating the device requesting the navigation.

This VRService event can be used alongside UserInputService service events and functions.

Since the event fires locally, it can only be used in a LocalScript.

Parameters

local VRService = game:GetService("VRService")

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

The TouchpadModeChanged event fires if the VRTouchpadMode of a VRTouchpad is changed. This event indicates the VRTouchpad that changes, and its new state.

You can use this event to track the states of VRTouchpads connected via the user's client.

This VRService event can be used alongside UserInputService service events and functions.

Since the event fires locally, it can only be used in a LocalScript.

Parameters

local VRService = game:GetService("VRService")

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

The UserCFrameChanged even fires when a UserCFrame is changed. For instance, this event fires when the user moves a connected VR device.

This can be used alongside VRService:GetUserCFrame() to track the CFrame coordinates of a VR devices, and when it changes/moves. It can also be used alongside UserInputService service events and functions.

Since the event fires locally, it can only be used in a LocalScript.

Parameters

local VRService = game:GetService("VRService")

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

The UserCFrameEnabled event fires when a UserCFrame gets enabled or disabled.

This can be used alongside VRService:GetUserCFrameEnabled() to track whether a specified UserCFrame is enabled, and when its state changes. It can also be used alongside UserInputService service events and functions.

Since the event fires locally, it can only be used in a LocalScript.

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)