2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

VRSessionState

Represents the current state of the VR session managed by VRService. The engine updates VRSessionState each frame from the active session.

Items

NameValueDescription
Undefined0The VR session state is unknown or has not yet been established; the default value of VRSessionState.
Idle1The VR headset is connected and ready but is not yet presenting frames to the user.
Visible2The VR session is rendering frames visible to the user but does not yet have XR input focus; haptic feedback is available.
Focused3The VR session has full XR input focus and is rendering visible frames; haptic feedback is available.
Stopping4The VR session is in the process of stopping and will transition to an inactive state.

Undefined

The VR session state is unknown or has not yet been established; the default value of VRSessionState.

FieldValue
value0

Idle

The VR headset is connected and ready but is not yet presenting frames to the user.

FieldValue
value1

Visible

The VR session is rendering frames visible to the user but does not yet have XR input focus; haptic feedback is available.

FieldValue
value2

Focused

The VR session has full XR input focus and is rendering visible frames; haptic feedback is available.

FieldValue
value3

Stopping

The VR session is in the process of stopping and will transition to an inactive state.

FieldValue
value4