extends Instance
Class fields
| Field | XML type | Value |
|---|---|---|
Name | string | VRService |
summary | string | Provides access to VR state and user CFrame information. |
Properties
8DidPointerHit
bool| Field | XML type | Value |
|---|---|---|
Name | string | DidPointerHit |
GuiInputUserCFrame
UserCFrame| Field | XML type | Value |
|---|---|---|
Name | string | GuiInputUserCFrame |
summary | string | The user CFrame used for GUI input. |
LaserDistance
float| Field | XML type | Value |
|---|---|---|
Name | string | LaserDistance |
PointerHitCFrame
CoordinateFrame| Field | XML type | Value |
|---|---|---|
Name | string | PointerHitCFrame |
VRDeviceAvailable
bool| Field | XML type | Value |
|---|---|---|
Name | string | VRDeviceAvailable |
VRDeviceName
string| Field | XML type | Value |
|---|---|---|
Name | string | VRDeviceName |
summary | string | The name of the active VR device, or an empty string when no device is available. |
VREnabled
bool| Field | XML type | Value |
|---|---|---|
Name | string | VREnabled |
summary | string | Returns true when VR is enabled for the local client. |
VRSessionState
VRSessionState| Field | XML type | Value |
|---|---|---|
Name | string | VRSessionState |
Functions
7GetTouchpadMode
(pad: VRTouchpad) → VRTouchpadMode| Field | XML type | Value |
|---|---|---|
Name | string | GetTouchpadMode |
summary | string | Returns the input mode assigned to a VR controller touchpad. |
GetUserCFrame
(type: UserCFrame) → CoordinateFrame| Field | XML type | Value |
|---|---|---|
Name | string | GetUserCFrame |
summary | string | Returns the current CFrame for the requested VR user CFrame. |
GetUserCFrameEnabled
(type: UserCFrame) → bool| Field | XML type | Value |
|---|---|---|
Name | string | GetUserCFrameEnabled |
summary | string | Returns true when tracking is available for the requested VR user CFrame. |
IsVRAppBuild
() → bool| Field | XML type | Value |
|---|---|---|
Name | string | IsVRAppBuild |
RecenterUserHeadCFrame
() → void| Field | XML type | Value |
|---|---|---|
Name | string | RecenterUserHeadCFrame |
summary | string | Requests recentering of the user's head CFrame. |
SetTouchpadMode
(pad: VRTouchpad, mode: VRTouchpadMode) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetTouchpadMode |
summary | string | Assigns an input mode to a VR controller touchpad. |
Events
4TouchpadModeChanged
(pad: VRTouchpad, mode: VRTouchpadMode) → void| Field | XML type | Value |
|---|---|---|
Name | string | TouchpadModeChanged |
summary | string | Fired after a VR controller touchpad mode changes. |
UserCFrameChanged
(type: UserCFrame, value: CoordinateFrame) → void| Field | XML type | Value |
|---|---|---|
Name | string | UserCFrameChanged |
summary | string | Fired when a tracked VR user CFrame changes. |
UserCFrameEnabled
(type: UserCFrame, enabled: bool) → void| Field | XML type | Value |
|---|---|---|
Name | string | UserCFrameEnabled |
summary | string | Fired when tracking availability changes for a VR user CFrame. |