xr_guide.module
This package holds more than this page lists. See all of its files in its world.
README.md
xr_guide
The headset's controls guide: a panel an arm's length away, turned to the person's left so the world ahead stays clear, that says how to do the basic things with the hand controllers they hold.
| Line | Shown | Named from |
|---|---|---|
| Move | while a live control move binds the pad | Zin.scheme.legend("move", "gamepad") |
| Turn | while a live control look binds the pad | Zin.scheme.legend("look", "gamepad") |
| Up and down | editing | Zin.scheme.legend("flyVerticalHeadset", "gamepad") |
| Point and select | always | the pointing hand's trigger, Zin.gamepad.label |
| Grab and move | editing | the pointing hand's grip, Zin.gamepad.label |
| Show or hide the editor | in the editor | the menu button, Zin.gamepad.label("start") |
| Open the menu | outside the editor, while the pause action binds the pad | Zin.scheme.legend("menu", "gamepad") |
| Talk to the agent | editing | edui.voicePrompt.talkControl(), and the talk gesture |
| Open worlds | the editor's dock, or the menu's ZeroMind tab | the dock's world button, or the pause action |
The hand controllers present as one pad while a headset session holds input
focus, so a control's gamepad bindings are what the controllers press, and
Zin.gamepad names each pad button by the name printed on the controllers
(X, A, Right grip, Left thumbstick, Menu button). A line whose
control answers to nothing on the controllers is left out, so the guide states
only what works where the person is.
It opens the first time a headset session holds input focus while the client
setting Show the controls on entering VR (xr.guide) is on; its own
button turns that setting off. Controls in the VR settings
(xr.controls), the Controls row of the editor's dock and the Scene's
hint in a headset open it again. It follows the mode, the pointing hand and
the live controls while it shows, and goes when the headset gives up focus.
local Guide = require("@builtin::modules.api.engine.xr_guide")
Guide.open() -- in a headset
for _, row in Guide.rows() do print(row.action, row.control) end