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
  1. apireference
  2. input
  3. vrservice

RequestNavigation

VRService

The RequestNavigation function requests navigation to the specified DataType/CFrame, using the specified /Enum/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

Name Type Default Description

cframe

CFrame

The specified CFrame coordinates.

inputUserCFrame

UserCFrame

The VR device for which the navigation is requested.

Returns

Return Type Summary

void

No return.

Code Samples

VRService:RequestNavigation

This example requests navigation from the user’s UserCFrame.Head coordinates to the CFrame coordinates of a Part named NavigationDestination.

Note: In order for this to work, a Part named NavigationDestination must exist in the game’s Workspace.

Copy Code Light Theme