Documentation Home
Breadcrumbs

Navigation

Skyreal VR provides SDK functions for controlling navigation behavior programmatically within extensions. These functions allow you to switch navigation modes, enable or disable user movement, and query the current navigation state.

SDK Navigation Functions

To use these functions, you need the Framework Connector reference. See the SDK documentation for how to obtain it.

Function

Description

Change Navigation Mode

Switches between the three VR navigation modes (teleport, fly, walk)

Enable Navigation

Allows or blocks user navigation programmatically

Get All Navigation Modes

Returns a list of all available navigation modes

Get Current Navigation Mode

Returns the currently active navigation mode

Custom Inputs for Navigation

You can customize Skyreal VR navigation inputs by creating a .ini file in the Skyreal VR/Config/Input directory. The file must start with:

[/Script/SkrBase.SkrConfigInput]

Move Commands

Input

Description

RightMoveAxis

Move forward/backward with the right hand

LeftMoveAxis

Move forward/backward with the left hand

RightStrafeAxis

Strafe right/left with the right hand

LeftStrafeAxis

Strafe right/left with the left hand

RightMoveForward

Move forward with the right hand

LeftMoveForward

Move forward with the left hand

RightMoveBackward

Move backward with the right hand

LeftMoveBackward

Move backward with the left hand

IncreaseSpeed

Increase player speed

DecreaseSpeed

Decrease player speed

Interaction Commands

Input

Description

VrMenuButtonRight

Open VR menu with right controller

VrMenuButtonLeft

Open VR menu with left controller

RightActionButton

Execute VR action with right controller

LeftActionButton

Execute VR action with left controller

SelectAll

Select all parts in the scene

ExitVrActionButton

Exit VR mode