PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. VRService

VRService

Show deprecated
Hide content
Content
  1. apireference
  2. vrservice

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

bool

Archivable

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

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

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

void

ClearAllChildren ( )

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

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

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

FindFirstAncestor ( string name )

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

FindFirstAncestorOfClass ( string className )

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

FindFirstAncestorWhichIsA ( string className )

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

FindFirstChild ( string name , bool recursive )

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

FindFirstChildOfClass ( string className )

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

FindFirstChildWhichIsA ( string className , bool recursive )

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

GetActor ( )

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

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

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance's ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class
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.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
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.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

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

AncestryChanged ( Instance child , Instance parent )

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

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
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

DescendantRemoving ( Instance descendant )

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

childAdded ( Instance child )

[Deprecated]

Code Samples

VRService

The following example demonstrates one of many usage examples of handling a VRService event.

​The VRService/UserCFrameChanged event fires when the user moves a connected VR device. When the event fires, this prints the name of the VR device type that changed, and the updated DataType/CFrame coordinates.

Copy Code Light Theme
VehicleSeat Glue