Properties
UserCFrame
|
Describes what UserCFrame is responsible for input in VR. |
bool
[Hidden]
[ReadOnly]
[NotReplicated]
|
string
[Hidden]
[ReadOnly]
[NotReplicated]
|
bool
[ReadOnly]
[NotReplicated]
|
Describes whether the user is using a virtual reality device |
bool
|
Determines if an |
string
[ReadOnly]
[NotReplicated]
|
A read-only string representing the class this |
int
[Hidden]
[ReadOnly]
[NotReplicated]
[Deprecated]
|
The cost of saving the instance using data persistence. |
string
|
A non-unique identifier of the |
Instance
[NotReplicated]
|
Determines the hierarchical parent of the |
bool
[Hidden]
|
A deprecated property that used to protect |
int64
[Hidden]
[NotReplicated]
|
bool
[Hidden]
[NotReplicated]
[Deprecated]
|
string
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Functions
VRTouchpadMode
|
Returns the VRTouchpadMode indicating the mode of a specified VRTouchpad. |
CFrame
|
Returns a CFrame describing the position & orientation of a specified virtual reality device. |
bool
|
Returns true if the specified UserCFrame is available to be listened to. |
void
|
Recenters the CFrame to the current location of the VR headset being worn by the user. |
void
|
Requests navigation to the specified |
void
|
Sets the mode of the specified VRTouchpad to the specified VRTouchpadMode. |
void
|
This function destroys all of an |
Instance
|
Create a copy of an object and all its descendants, ignoring objects that are not |
void
|
Sets the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first descendant found with the given |
Actor
|
Returns the Actor associated with the Instance, usually the first Actor ancestor |
Variant
|
Returns the attribute which has been assigned to the given name |
RBXScriptSignal
|
Returns an event that fires when the given attribute changes |
Dictionary
|
Returns a dictionary of string → variant pairs for each of the |
Objects
|
Returns an array containing all of the |
string
[NotBrowsable]
|
Returns a coded string of the |
Array
[CustomLuaState]
|
Returns an array containing all of the descendants of the instance |
string
|
Returns a string describing the |
RBXScriptSignal
|
Get an event that fires when a given property of an object changes. |
bool
[CustomLuaState]
|
Returns true if an |
bool
|
Returns true if an |
bool
|
Returns true if an |
void
[Deprecated]
|
Sets the object’s Parent to nil, and does the same for all its descendants. |
void
|
Sets the attribute with the given name to the given value |
Instance
[CustomLuaState]
[CanYield]
|
Returns the child of the |
Objects
[Deprecated]
|
Returns an array of the object’s children. |
Instance
[Deprecated]
|
void
[Deprecated]
|
Instance
[Deprecated]
|
Objects
[Deprecated]
|
bool
[Deprecated]
[CustomLuaState]
|
bool
[Deprecated]
|
void
[Deprecated]
|
Events
RBXScriptSignal
|
Fired when navigation is requested from the VRService. |
RBXScriptSignal
|
Fires if the VRTouchpadMode of a VRTouchpad is changed. |
RBXScriptSignal
|
Fired when a UserCFrame is changed. |
RBXScriptSignal
|
Fires when a UserCFrame gets enabled or disabled. |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires whenever an attribute is changed on the |
RBXScriptSignal
|
Fired immediately after a property of an object changes. |
RBXScriptSignal
|
Fires after an object is parented to this |
RBXScriptSignal
|
Fires after a child is removed from this |
RBXScriptSignal
|
Fires after a descendant is added to the |
RBXScriptSignal
|
Fires immediately before a descendant of the |
RBXScriptSignal
|
Fires immediately before the instance is destroyed via |
RBXScriptSignal
[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.