RequestNavigation
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 |
|---|---|---|---|
|
|
The specified CFrame coordinates. |
||
|
|
The VR device for which the navigation is requested. |
Returns
| Return Type | Summary |
|---|---|
|
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.
local VRService = game:GetService("VRService")
local NavDest = game.Workspace:FindFirstChild("NavigationDestination")
VRService:RequestNavigation(UserCFrame.Head, NavDest.CFrame)