Log inGet started
Package

headset.module

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

launcher.headset

The ZeroMind tab between worlds in a headset. While a world opens, the view closes to near-black and the loading screen stands on a modal panel in front of the person, so the panels the world being left made stand undrawn behind it; once the world stands, or the open ends, the panel comes down and the view opens on whatever is there.

  • LOADING_PANEL, LOADING_SCREEN: the id of the world panel the loading screen stands on, and the screen it shows.
  • FADE_CLOSE_SECONDS, FADE_OPEN_SECONDS: how long the view takes to close before a world is taken down, and to open on the next one.
  • serving() -> boolean: whether a headset is showing the app.
  • api() -> any?: the xr namespace, when this engine can fade a headset's view.
  • hold(): close the view and stand the loading screen in front of the person; nothing outside a headset.
  • release(): take the loading panel down and open the view.
  • worldStanding() -> boolean: whether the world just opened has drawn its first frame of play.
local Headset = require("@builtin::modules.api.engine.launcher.headset")
if Headset.serving() then
    Headset.hold()
end
print(Headset.LOADING_PANEL, Headset.worldStanding())