PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

VRService

Show deprecated

VRService

Show deprecated

The VRService is a service that is responsible for handling interactions between Roblox and Virtual Reality (VR). If you’re interested in incorporating VR compatibility into your game, this is the service for you!

The primary purpose of this service is to allow for games to communication and cooperate with virtual reality decisions - such as VR headsets and controllers. It allows a LocalScript to perform different actions depending on the device, and in turn, helps developers provide the best experience for the end user seeking to experience Roblox using VR devices.

Some usages of this service include detecting whether a user has any connected VR devices, tracking when those devices move, and determining how those devices interact with the user’s in-game controls. In order to detect user input, the service must look for a service event. For example, the service can detect VR device movement via events such as VRService/UserCFrameChanged.

Notes

  1. The UserInputService also contains several events and functions useful for enhancing a player’s VR experience in your game.
  2. Since this service is client-side only, it will only work when used in a LocalScript. It will not work when used within a Script. Client-side only means that users in the game can only detect their own input - and not the input of other users.

Properties

UserCFrame

GuiInputUserCFrame

Describes what UserCFrame is responsible for input in VR.

bool

VREnabled

[ReadOnly] [NotReplicated]

Describes whether the user is using a virtual reality device

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

VRTouchpadMode

GetTouchpadMode ( VRTouchpad pad )

Returns the VRTouchpadMode indicating the mode of a specified VRTouchpad.

CFrame

GetUserCFrame ( UserCFrame type )

Returns a CFrame describing the position & orientation of a specified virtual reality device.

bool

GetUserCFrameEnabled ( UserCFrame type )

Returns true if the specified UserCFrame is available to be listened to.

void

RecenterUserHeadCFrame ( )

Recenters the CFrame to the current location of the VR headset being worn by the user.

void

RequestNavigation ( CFrame cframe , UserCFrame inputUserCFrame )

Requests navigation to the specified DataType/CFrame, using the specified /Enum/UserCFrame as the origin for the visualizer parabola.

void

SetTouchpadMode ( VRTouchpad pad , VRTouchpadMode mode )

Sets the mode of the specified VRTouchpad to the specified VRTouchpadMode.

Inherited from Instance: Show Hide

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

RBXScriptSignal

NavigationRequested ( CFrame cframe , UserCFrame inputUserCFrame )

Fired when navigation is requested from the VRService.

RBXScriptSignal

TouchpadModeChanged ( VRTouchpad pad , VRTouchpadMode mode )

Fires if the VRTouchpadMode of a VRTouchpad is changed.

RBXScriptSignal

UserCFrameChanged ( UserCFrame type , CFrame value )

Fired when a UserCFrame is changed.

RBXScriptSignal

UserCFrameEnabled ( UserCFrame type , bool enabled )

Fires when a UserCFrame gets enabled or disabled.

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.