How to build XR-only Components

Many components are only needed once a VR or AR sesion is entered.

To ensure components don’t update outside of xr sessions, you can use the following code snippet.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

WL.registerComponent('active-only-in-vr', {
}, {
  start: function() {
      WL.onXRSessionStart.push(s => {
          this.active = true;
      });

      WL.onXRSessionEnd.push(s => {
          this.active = false;
      });

      /* Session might already be active */
      this.active = WL.xrSession != null;
  },
  update: function() {
    /* Only called when WL.xrSession is valid */
  }
});

(De-)Activate other Components 

If you want to disable/enable other components based on the session state, without changing their code, you can use the vr-active-mode-switch components, which will disable/enable components depending on whether the user is in an XR session or not.