@indiegems/gem-web-sdk 13.0.0 → 13.1.0

package/docs/api/api-reference-game.md

@@ -1,6 +1,6 @@
 # The browser surface — API reference
 
-Generated from `@indiegems/gem-web-sdk/sdk` v13.0.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
+Generated from `@indiegems/gem-web-sdk/sdk` v13.1.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
 
 `@indiegems/gem-web-sdk/sdk` is the one import a game writes, wherever its code runs. `@indiegems/gem-web-sdk/game` exports exactly the symbols on this page and nothing else, for a build that wants only this half.
 
@@ -3925,6 +3925,100 @@ for the avatars already worn when you subscribe: read
 
 **Returns.** a function that stops the calls. Calling it twice is harmless.
 
+<a id="avatarrignode"></a>
+
+## AvatarRigNode
+
+```ts
+interface AvatarRigNode
+```
+
+One node of a rig family's tree: its exact, case-sensitive name, and the
+name of the node it is a DIRECT child of. `parent` is `null` for the rig's
+root, which is a root node of the scene.
+
+<a id="avatarrignode-node"></a>
+
+## AvatarRigNode.node
+
+```ts
+readonly node: string
+```
+
+The node's name, exact and case-sensitive.
+
+<a id="avatarrignode-parent"></a>
+
+## AvatarRigNode.parent
+
+```ts
+readonly parent: string | null
+```
+
+The node it is a direct child of; `null` for the rig's root.
+
+<a id="avatarrigs"></a>
+
+## AvatarRigs
+
+```ts
+interface AvatarRigs
+```
+
+The rig families this SDK knows, by name.
+
+<a id="avatarrigs-small_human"></a>
+
+## AvatarRigs.small_human
+
+```ts
+readonly small_human: readonly AvatarRigNode[]
+```
+
+The toy rig: rigid limbs on a body, eight nodes.
+
+<a id="avatarrigs-adult_human"></a>
+
+## AvatarRigs.adult_human
+
+```ts
+readonly adult_human: readonly AvatarRigNode[]
+```
+
+The adult humanoid with fingers: 56 nodes, world-aligned at rest.
+
+<a id="avatar_rigs"></a>
+
+## AVATAR_RIGS
+
+```ts
+AVATAR_RIGS: AvatarRigs
+```
+
+Every node each rig family requires, with the node it is a direct child of,
+parents before children. Frozen: read it, never change it.
+
+The platform refuses an upload whose model is missing one of these, has one
+under another parent, or has one twice (`rig_mismatch`). Extra nodes are
+allowed anywhere. `adult_human` also requires every one of its nodes to be
+world-aligned at rest; that rule is not in this list, see the guide.
+
+```js
+import { AVATAR_RIGS } from '@indiegems/gem-web-sdk/sdk';
+
+// Every joint of the worn avatar, by name.
+const joints = new Map(
+  AVATAR_RIGS.adult_human.map(({ node }) => [node, gltf.scene.getObjectByName(node)]),
+);
+
+// A test that one of your own models is on the rig.
+for (const { node, parent } of AVATAR_RIGS.adult_human) {
+  const found = gltf.scene.getObjectByName(node);
+  if (!found) throw new Error(`missing ${node}`);
+  if (parent !== null && found.parent?.name !== parent) throw new Error(`${node} is not under ${parent}`);
+}
+```
+
 <a id="gemapierror"></a>
 
 ## GemApiError
@@ -5347,7 +5441,7 @@ interface RewardCue
 ```
 
 A platform-currency reward on its way to the arcade — in the Gem Arcade, a
-flight into the Gem button at the top-left of your frame — what
+flight into the Gem button, in whichever corner of your frame it sits — what
 `gem.cueReward` takes.
 
 <a id="rewardcue-currencyslug"></a>
@@ -5408,6 +5502,18 @@ y: number
 
 From the top edge of your viewport.
 
+<a id="gemcorner"></a>
+
+## GemCorner
+
+```ts
+type GemCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right"
+```
+
+A corner of your frame, for `gem.setGemCorner`: where you would like the
+arcade's Gem button to sit. `'top-left'` is where it sits unless you ask.
+Physical corners: `'top-left'` is the top-left in every language.
+
 <a id="framestate"></a>
 
 ## FrameState
@@ -5737,6 +5843,30 @@ connected, and only to an arcade that draws a menu.
 **Returns.** whether the message left the frame — `false` before the bridge is
   up, for an arcade with no menu, and past this frame's own limit.
 
+<a id="gemframe-setgemcorner"></a>
+
+## GemFrame.setGemCorner
+
+```ts
+setGemCorner(corner: GemCorner): boolean
+```
+
+Ask the arcade to put its own control over your game — the Gem button —
+in this corner of your frame: the whole answer each time, the latest one
+winning.
+
+Prefer `gem.setGemCorner`, which holds the corner across a reconnect.
+This one sends only while connected, and only to an arcade that can move
+its control.
+
+| Parameter | Type |
+| --- | --- |
+| `corner` | `GemCorner` |
+
+**Returns.** whether the message left the frame — `false` before the bridge is
+  up, for an arcade that cannot move its control, for a value that is not
+  one of the four corners, and past this frame's own limit.
+
 <a id="gemframe-requestshare"></a>
 
 ## GemFrame.requestShare
@@ -8303,7 +8433,7 @@ readonly reserved: readonly GemReservedArea[]
 ```
 
 Rectangles of your frame the arcade's own controls cover — in the Gem
-Arcade, its Gem button in the top-left corner, and the frame-rate readout
+Arcade, its Gem button in whichever corner it sits, and the frame-rate readout
 beside it while the player shows it; an embedder that draws wallets over
 your game adds theirs (see `setWalletVisible`). Keep essential UI and touch
 targets out of them. Empty when the arcade covers nothing.
@@ -9430,7 +9560,7 @@ cueReward(cue: RewardCue): boolean
 
 Tell the arcade a platform-currency reward is on its way, so it **shows it
 landing**: in the Gem Arcade the currency flies from `origin` into the Gem
-button at the top-left of your frame, which pops as each mark lands, and
+button, wherever on your frame it sits, which pops as each mark lands, and
 the player's total moves once the platform confirms the grant. The Gem
 Arcade draws no wallet over your game: the player sees their Gems and
 Tickets in the Gem menu. A payout you do not cue still flies, from the
@@ -9532,8 +9662,9 @@ gem.setMenu({
 ```
 
 **Your settings are not in it: draw your own settings button, always** —
-top-right, clear of `gem.viewport.reserved`. The Arcade's menu never opens
-your settings screen.
+top-right, with your Back button just to its left, clear of
+`gem.viewport.reserved`. The Arcade's menu never opens your settings
+screen.
 
 **It is screen state, not a toggle.** Each call is the whole answer and
 replaces the last, so call it again when the entries change — a new
@@ -9553,6 +9684,46 @@ should not assume the game was paused by you.
   up (the menu is held and sent when it connects) and under an embedder
   that draws no menu.
 
+<a id="gem-setgemcorner"></a>
+
+## Gem.setGemCorner
+
+```ts
+setGemCorner(corner: GemCorner): boolean
+```
+
+Ask the arcade to put its Gem button — its one control over your game,
+top-left unless you ask — in another corner of your frame.
+
+```js
+// This game's own HUD needs the top-left, so the Gem goes top-right.
+gem.setGemCorner('top-right');
+```
+
+**Leave it top-left unless your own HUD needs that corner**, and then pick
+one corner for the whole game — at most one per orientation. A Gem that
+moves between screens is a way out the player has to look for. In
+landscape the bottom corners sit where a player's thumbs hold the sticks.
+
+**Lay out around `gem.viewport.reserved`, never around the corner you
+asked for.** The arcade moves the Gem on its own terms: not while the
+player is using it or its menu is open, not more often than every few
+seconds, and never over a corner the player chose for themselves. The
+rectangles say where it actually is, and the `--gem-reserved-*` CSS
+properties follow them.
+
+**It is screen state, not a toggle.** Each call is the whole answer and
+replaces the last. A value that is not one of the four corners is ignored,
+with a warning on the console, and changes nothing.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `corner` | `GemCorner` | `'top-left'`, `'top-right'`, `'bottom-left'` or `'bottom-right'`. |
+
+**Returns.** `true` when the arcade was told now; `false` before the bridge is
+  up (the corner is held and sent when it connects), under an embedder that
+  cannot move its control, and for a value that is not a corner.
+
 <a id="gem-exit"></a>
 
 ## Gem.exit
@@ -10352,7 +10523,7 @@ The match this connection belongs to.
 ## MatchConnection.protocol
 
 ```ts
-readonly protocol: "dedicated" | "p2p" | "loopback"
+readonly protocol: "p2p" | "dedicated" | "loopback"
 ```
 
 What is on the other end: `dedicated` (the platform's server), `p2p` (the
@@ -10544,13 +10715,21 @@ putting it in an `<img src>`.
 ## Avatar3dFamily
 
 ```ts
-type Avatar3dFamily = "small_human" | string & object
+type Avatar3dFamily = "small_human" | "adult_human" | string & object
 ```
 
 A rig family — the skeleton contract a 3D avatar is built on, and what a
-game declares it can animate. `small_human` is the first: a `root` node
-with a `body` child, which holds `head`, `arm_l`, `arm_r`, `leg_l` and
-`leg_r`, and a `hand_socket` under `arm_r`.
+game declares it can animate. Two today:
+
+- `small_human`, the toy rig: a `root` node with a `body` child, which holds
+  `head`, `arm_l`, `arm_r`, `leg_l` and `leg_r`, and a `hand_socket` under
+  `arm_r`.
+- `adult_human`, a full humanoid with fingers: 56 nodes from `root` and
+  `hips` down to `toes_r`, every one world-aligned at rest, so one clip plays
+  on every avatar in the family.
+
+`AVATAR_RIGS` (from `@indiegems/gem-web-sdk/sdk`) lists every node of
+both, with its parent.
 
 Open-ended (`| (string & {})`) so a family the platform adds later does not
 break a `switch` you compiled against this version: keep a `default` arm and

package/docs/api/api-reference-server.md

@@ -1,6 +1,6 @@
 # The server surface — API reference
 
-Generated from `@indiegems/gem-web-sdk/sdk` v13.0.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
+Generated from `@indiegems/gem-web-sdk/sdk` v13.1.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
 
 `@indiegems/gem-web-sdk/sdk` is the one import a game writes, wherever its code runs. `@indiegems/gem-web-sdk/server` exports exactly the symbols on this page and nothing else, for a build that wants only this half.
 

package/docs/api/reference.json

@@ -2,7 +2,7 @@
   "schema_version": 2,
   "source": {
     "repo": "IndieGems/gem-web-sdk",
-    "version": "13.0.0"
+    "version": "13.1.0"
   },
   "entries": [
     {
@@ -4797,6 +4797,118 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "AvatarRigNode",
+          "name": "AvatarRigNode",
+          "anchor": "avatarrignode",
+          "group": "avatars3d",
+          "signature": "interface AvatarRigNode",
+          "documented": true,
+          "summary": "One node of a rig family's tree: its exact, case-sensitive name, and the\nname of the node it is a DIRECT child of. `parent` is `null` for the rig's\nroot, which is a root node of the scene.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AvatarRigNode.node",
+          "name": "node",
+          "anchor": "avatarrignode-node",
+          "group": "avatars3d",
+          "signature": "readonly node: string",
+          "documented": true,
+          "summary": "The node's name, exact and case-sensitive.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AvatarRigNode.parent",
+          "name": "parent",
+          "anchor": "avatarrignode-parent",
+          "group": "avatars3d",
+          "signature": "readonly parent: string | null",
+          "documented": true,
+          "summary": "The node it is a direct child of; `null` for the rig's root.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AvatarRigs",
+          "name": "AvatarRigs",
+          "anchor": "avatarrigs",
+          "group": "avatars3d",
+          "signature": "interface AvatarRigs",
+          "documented": true,
+          "summary": "The rig families this SDK knows, by name.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AvatarRigs.small_human",
+          "name": "small_human",
+          "anchor": "avatarrigs-small_human",
+          "group": "avatars3d",
+          "signature": "readonly small_human: readonly AvatarRigNode[]",
+          "documented": true,
+          "summary": "The toy rig: rigid limbs on a body, eight nodes.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AvatarRigs.adult_human",
+          "name": "adult_human",
+          "anchor": "avatarrigs-adult_human",
+          "group": "avatars3d",
+          "signature": "readonly adult_human: readonly AvatarRigNode[]",
+          "documented": true,
+          "summary": "The adult humanoid with fingers: 56 nodes, world-aligned at rest.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "AVATAR_RIGS",
+          "name": "AVATAR_RIGS",
+          "anchor": "avatar_rigs",
+          "group": "avatars3d",
+          "signature": "AVATAR_RIGS: AvatarRigs",
+          "documented": true,
+          "summary": "Every node each rig family requires, with the node it is a direct child of,\nparents before children. Frozen: read it, never change it.\n\nThe platform refuses an upload whose model is missing one of these, has one\nunder another parent, or has one twice (`rig_mismatch`). Extra nodes are\nallowed anywhere. `adult_human` also requires every one of its nodes to be\nworld-aligned at rest; that rule is not in this list, see the guide.\n\n```js\nimport { AVATAR_RIGS } from '@indiegems/gem-web-sdk/sdk';\n\n// Every joint of the worn avatar, by name.\nconst joints = new Map(\n  AVATAR_RIGS.adult_human.map(({ node }) => [node, gltf.scene.getObjectByName(node)]),\n);\n\n// A test that one of your own models is on the rig.\nfor (const { node, parent } of AVATAR_RIGS.adult_human) {\n  const found = gltf.scene.getObjectByName(node);\n  if (!found) throw new Error(`missing ${node}`);\n  if (parent !== null && found.parent?.name !== parent) throw new Error(`${node} is not under ${parent}`);\n}\n```",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "GemApiError",
           "name": "GemApiError",
@@ -6346,7 +6458,7 @@
           "group": "platform",
           "signature": "interface RewardCue",
           "documented": true,
-          "summary": "A platform-currency reward on its way to the arcade — in the Gem Arcade, a\nflight into the Gem button at the top-left of your frame — what\n`gem.cueReward` takes.",
+          "summary": "A platform-currency reward on its way to the arcade — in the Gem Arcade, a\nflight into the Gem button, in whichever corner of your frame it sits — what\n`gem.cueReward` takes.",
           "deprecated": null,
           "params": [],
           "returns": null,
@@ -6435,6 +6547,22 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "GemCorner",
+          "name": "GemCorner",
+          "anchor": "gemcorner",
+          "group": "frame",
+          "signature": "type GemCorner = \"top-left\" | \"top-right\" | \"bottom-left\" | \"bottom-right\"",
+          "documented": true,
+          "summary": "A corner of your frame, for `gem.setGemCorner`: where you would like the\narcade's Gem button to sit. `'top-left'` is where it sits unless you ask.\nPhysical corners: `'top-left'` is the top-left in every language.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "FrameState",
           "name": "FrameState",
@@ -6769,6 +6897,29 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "GemFrame.setGemCorner",
+          "name": "setGemCorner",
+          "anchor": "gemframe-setgemcorner",
+          "group": "frame",
+          "signature": "setGemCorner(corner: GemCorner): boolean",
+          "documented": true,
+          "summary": "Ask the arcade to put its own control over your game — the Gem button —\nin this corner of your frame: the whole answer each time, the latest one\nwinning.\n\nPrefer `gem.setGemCorner`, which holds the corner across a reconnect.\nThis one sends only while connected, and only to an arcade that can move\nits control.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "corner",
+              "type": "GemCorner",
+              "optional": false,
+              "summary": null
+            }
+          ],
+          "returns": "whether the message left the frame — `false` before the bridge is\n  up, for an arcade that cannot move its control, for a value that is not\n  one of the four corners, and past this frame's own limit.",
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "GemFrame.requestShare",
           "name": "requestShare",
@@ -9401,7 +9552,7 @@
           "group": "player",
           "signature": "readonly reserved: readonly GemReservedArea[]",
           "documented": true,
-          "summary": "Rectangles of your frame the arcade's own controls cover — in the Gem\nArcade, its Gem button in the top-left corner, and the frame-rate readout\nbeside it while the player shows it; an embedder that draws wallets over\nyour game adds theirs (see `setWalletVisible`). Keep essential UI and touch\ntargets out of them. Empty when the arcade covers nothing.\n\nA stylesheet reads the per-corner custom properties the SDK stamps from\nthese instead — `--gem-reserved-tl-height` and friends.",
+          "summary": "Rectangles of your frame the arcade's own controls cover — in the Gem\nArcade, its Gem button in whichever corner it sits, and the frame-rate readout\nbeside it while the player shows it; an embedder that draws wallets over\nyour game adds theirs (see `setWalletVisible`). Keep essential UI and touch\ntargets out of them. Empty when the arcade covers nothing.\n\nA stylesheet reads the per-corner custom properties the SDK stamps from\nthese instead — `--gem-reserved-tl-height` and friends.",
           "deprecated": null,
           "params": [],
           "returns": null,
@@ -10412,7 +10563,7 @@
           "group": "start",
           "signature": "cueReward(cue: RewardCue): boolean",
           "documented": true,
-          "summary": "Tell the arcade a platform-currency reward is on its way, so it **shows it\nlanding**: in the Gem Arcade the currency flies from `origin` into the Gem\nbutton at the top-left of your frame, which pops as each mark lands, and\nthe player's total moves once the platform confirms the grant. The Gem\nArcade draws no wallet over your game: the player sees their Gems and\nTickets in the Gem menu. A payout you do not cue still flies, from the\nmiddle of your frame, so cue the ones the player earns on screen.\n\nCall it the moment your game decides to award — when your server has moved\n(or is about to move) the progression mapped onto a platform currency —\nand pass the centre of that currency's icon (or hero) on your screen, so\nthe flight starts from the mark the player is looking at:\n\n```js\nconst { x, y, width, height } = rewardGem.getBoundingClientRect(); // the gem's own box\ngem.cueReward({\n  currencySlug: 'GEMS', // or 'ARCADE_TICKETS', from the ticket\n  expected: 15,\n  origin: { x: x + width / 2, y: y + height / 2 },\n});\n```\n\n**This is the platform-currency animation, and the only one.** The display\nof every platform currency — Gems and Tickets alike — belongs to the\narcade: a game draws no flight or celebration of its own for one and keeps\nno counter of one. **If this returns `false`, do nothing** — there is no\nfallback celebration.\n\n**The arcade never takes your word for the amount.** What lands, and the\nplayer's new total, come from the platform itself; `expected` is drawn as\nprovisional, and a cue the platform never confirms fades on its own — a\ngrant clamped to zero, say, or one the receipt reports `suppressed`. So\nthe cue can only ever make the wallet move for a reward that really\nlanded — which it does on every channel, dev and test included.",
+          "summary": "Tell the arcade a platform-currency reward is on its way, so it **shows it\nlanding**: in the Gem Arcade the currency flies from `origin` into the Gem\nbutton, wherever on your frame it sits, which pops as each mark lands, and\nthe player's total moves once the platform confirms the grant. The Gem\nArcade draws no wallet over your game: the player sees their Gems and\nTickets in the Gem menu. A payout you do not cue still flies, from the\nmiddle of your frame, so cue the ones the player earns on screen.\n\nCall it the moment your game decides to award — when your server has moved\n(or is about to move) the progression mapped onto a platform currency —\nand pass the centre of that currency's icon (or hero) on your screen, so\nthe flight starts from the mark the player is looking at:\n\n```js\nconst { x, y, width, height } = rewardGem.getBoundingClientRect(); // the gem's own box\ngem.cueReward({\n  currencySlug: 'GEMS', // or 'ARCADE_TICKETS', from the ticket\n  expected: 15,\n  origin: { x: x + width / 2, y: y + height / 2 },\n});\n```\n\n**This is the platform-currency animation, and the only one.** The display\nof every platform currency — Gems and Tickets alike — belongs to the\narcade: a game draws no flight or celebration of its own for one and keeps\nno counter of one. **If this returns `false`, do nothing** — there is no\nfallback celebration.\n\n**The arcade never takes your word for the amount.** What lands, and the\nplayer's new total, come from the platform itself; `expected` is drawn as\nprovisional, and a cue the platform never confirms fades on its own — a\ngrant clamped to zero, say, or one the receipt reports `suppressed`. So\nthe cue can only ever make the wallet move for a reward that really\nlanded — which it does on every channel, dev and test included.",
           "deprecated": null,
           "params": [
             {
@@ -10464,7 +10615,7 @@
           "group": "start",
           "signature": "setMenu(menu: GameMenu): boolean",
           "documented": true,
-          "summary": "Put up to four entries of your own in the arcade's menu. The arcade keeps\none menu button over your game: it is how a player leaves, mutes, goes\nfullscreen, reports a problem and changes their Arcade-wide settings.\n\n```js\ngem.setMenu({\n  items: [{ id: 'how-to-play', label: t('How to play'), onSelect: () => help.open() }],\n});\n```\n\n**Your settings are not in it: draw your own settings button, always** —\ntop-right, clear of `gem.viewport.reserved`. The Arcade's menu never opens\nyour settings screen.\n\n**It is screen state, not a toggle.** Each call is the whole answer and\nreplaces the last, so call it again when the entries change — a new\nlanguage, a screen with different options. `gem.setMenu({})` takes\neverything of yours back out. The arcade's own entries are not yours to\nchange, and Return to the Arcade is always among them.\n\n**The arcade pauses your game while its menu is open** (`onPause`), and\nresumes it before a handler of yours runs. A handler opens a screen; it\nshould not assume the game was paused by you.",
+          "summary": "Put up to four entries of your own in the arcade's menu. The arcade keeps\none menu button over your game: it is how a player leaves, mutes, goes\nfullscreen, reports a problem and changes their Arcade-wide settings.\n\n```js\ngem.setMenu({\n  items: [{ id: 'how-to-play', label: t('How to play'), onSelect: () => help.open() }],\n});\n```\n\n**Your settings are not in it: draw your own settings button, always** —\ntop-right, with your Back button just to its left, clear of\n`gem.viewport.reserved`. The Arcade's menu never opens your settings\nscreen.\n\n**It is screen state, not a toggle.** Each call is the whole answer and\nreplaces the last, so call it again when the entries change — a new\nlanguage, a screen with different options. `gem.setMenu({})` takes\neverything of yours back out. The arcade's own entries are not yours to\nchange, and Return to the Arcade is always among them.\n\n**The arcade pauses your game while its menu is open** (`onPause`), and\nresumes it before a handler of yours runs. A handler opens a screen; it\nshould not assume the game was paused by you.",
           "deprecated": null,
           "params": [
             {
@@ -10480,6 +10631,29 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "Gem.setGemCorner",
+          "name": "setGemCorner",
+          "anchor": "gem-setgemcorner",
+          "group": "start",
+          "signature": "setGemCorner(corner: GemCorner): boolean",
+          "documented": true,
+          "summary": "Ask the arcade to put its Gem button — its one control over your game,\ntop-left unless you ask — in another corner of your frame.\n\n```js\n// This game's own HUD needs the top-left, so the Gem goes top-right.\ngem.setGemCorner('top-right');\n```\n\n**Leave it top-left unless your own HUD needs that corner**, and then pick\none corner for the whole game — at most one per orientation. A Gem that\nmoves between screens is a way out the player has to look for. In\nlandscape the bottom corners sit where a player's thumbs hold the sticks.\n\n**Lay out around `gem.viewport.reserved`, never around the corner you\nasked for.** The arcade moves the Gem on its own terms: not while the\nplayer is using it or its menu is open, not more often than every few\nseconds, and never over a corner the player chose for themselves. The\nrectangles say where it actually is, and the `--gem-reserved-*` CSS\nproperties follow them.\n\n**It is screen state, not a toggle.** Each call is the whole answer and\nreplaces the last. A value that is not one of the four corners is ignored,\nwith a warning on the console, and changes nothing.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "corner",
+              "type": "GemCorner",
+              "optional": false,
+              "summary": "`'top-left'`, `'top-right'`, `'bottom-left'` or `'bottom-right'`."
+            }
+          ],
+          "returns": "`true` when the arcade was told now; `false` before the bridge is\n  up (the corner is held and sent when it connects), under an embedder that\n  cannot move its control, and for a value that is not a corner.",
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "Gem.exit",
           "name": "exit",
@@ -11364,7 +11538,7 @@
           "name": "protocol",
           "anchor": "matchconnection-protocol",
           "group": "match",
-          "signature": "readonly protocol: \"dedicated\" | \"p2p\" | \"loopback\"",
+          "signature": "readonly protocol: \"p2p\" | \"dedicated\" | \"loopback\"",
           "documented": true,
           "summary": "What is on the other end: `dedicated` (the platform's server), `p2p` (the\nhosting player's browser), or `loopback` (this browser — you are the host,\nand this is the in-process link to your own bundle).",
           "deprecated": null,
@@ -11619,9 +11793,9 @@
           "name": "Avatar3dFamily",
           "anchor": "avatar3dfamily",
           "group": "avatars3d",
-          "signature": "type Avatar3dFamily = \"small_human\" | string & object",
+          "signature": "type Avatar3dFamily = \"small_human\" | \"adult_human\" | string & object",
           "documented": true,
-          "summary": "A rig family — the skeleton contract a 3D avatar is built on, and what a\ngame declares it can animate. `small_human` is the first: a `root` node\nwith a `body` child, which holds `head`, `arm_l`, `arm_r`, `leg_l` and\n`leg_r`, and a `hand_socket` under `arm_r`.\n\nOpen-ended (`| (string & {})`) so a family the platform adds later does not\nbreak a `switch` you compiled against this version: keep a `default` arm and\nskip a family you do not draw.",
+          "summary": "A rig family — the skeleton contract a 3D avatar is built on, and what a\ngame declares it can animate. Two today:\n\n- `small_human`, the toy rig: a `root` node with a `body` child, which holds\n  `head`, `arm_l`, `arm_r`, `leg_l` and `leg_r`, and a `hand_socket` under\n  `arm_r`.\n- `adult_human`, a full humanoid with fingers: 56 nodes from `root` and\n  `hips` down to `toes_r`, every one world-aligned at rest, so one clip plays\n  on every avatar in the family.\n\n`AVATAR_RIGS` (from `@indiegems/gem-web-sdk/sdk`) lists every node of\nboth, with its parent.\n\nOpen-ended (`| (string & {})`) so a family the platform adds later does not\nbreak a `switch` you compiled against this version: keep a `default` arm and\nskip a family you do not draw.",
           "deprecated": null,
           "params": [],
           "returns": null,
@@ -32069,9 +32243,9 @@
           "name": "Avatar3dFamily",
           "anchor": "avatar3dfamily",
           "group": "identity",
-          "signature": "type Avatar3dFamily = \"small_human\" | string & object",
+          "signature": "type Avatar3dFamily = \"small_human\" | \"adult_human\" | string & object",
           "documented": true,
-          "summary": "A rig family — the skeleton contract a 3D avatar is built on, and what a\ngame declares it can animate. `small_human` is the first: a `root` node\nwith a `body` child, which holds `head`, `arm_l`, `arm_r`, `leg_l` and\n`leg_r`, and a `hand_socket` under `arm_r`.\n\nOpen-ended (`| (string & {})`) so a family the platform adds later does not\nbreak a `switch` you compiled against this version: keep a `default` arm and\nskip a family you do not draw.",
+          "summary": "A rig family — the skeleton contract a 3D avatar is built on, and what a\ngame declares it can animate. Two today:\n\n- `small_human`, the toy rig: a `root` node with a `body` child, which holds\n  `head`, `arm_l`, `arm_r`, `leg_l` and `leg_r`, and a `hand_socket` under\n  `arm_r`.\n- `adult_human`, a full humanoid with fingers: 56 nodes from `root` and\n  `hips` down to `toes_r`, every one world-aligned at rest, so one clip plays\n  on every avatar in the family.\n\n`AVATAR_RIGS` (from `@indiegems/gem-web-sdk/sdk`) lists every node of\nboth, with its parent.\n\nOpen-ended (`| (string & {})`) so a family the platform adds later does not\nbreak a `switch` you compiled against this version: keep a `default` arm and\nskip a family you do not draw.",
           "deprecated": null,
           "params": [],
           "returns": null,