@indiegems/gem-web-sdk 18.1.0 → 19.0.0

package/docs/api/reference.json

@@ -2,7 +2,7 @@
   "schema_version": 2,
   "source": {
     "repo": "IndieGems/gem-web-sdk",
-    "version": "18.1.0"
+    "version": "19.0.0"
   },
   "entries": [
     {
@@ -3537,6 +3537,165 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "PlayerScope",
+          "name": "PlayerScope",
+          "anchor": "playerscope",
+          "group": "saves",
+          "signature": "interface PlayerScope",
+          "documented": true,
+          "summary": "What the signed-in player has in your game: everything a character has, and\nthe store passes they hold. Reached as `gem.me`.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "saving-player-progress",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PlayerScope.settings",
+          "name": "settings",
+          "anchor": "playerscope-settings",
+          "group": "saves",
+          "signature": "readonly settings: SettingsApi",
+          "documented": true,
+          "summary": "Small named values your game chooses to persist — a difficulty, a control\nscheme, a last-used loadout.\n\nPer key, so two settings written from two places do not overwrite each\nother. For a whole document of progress, use [EntityScope.saves](api-reference-game.md#entityscope-saves).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.inventory",
+          "name": "inventory",
+          "anchor": "playerscope-inventory",
+          "group": "saves",
+          "signature": "readonly inventory: InventoryApi",
+          "documented": true,
+          "summary": "What this player owns — items, and the progressions they are working\nthrough. Reads are cached; writes go through\n[EntityScope.mutations](api-reference-game.md#entityscope-mutations).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.currencies",
+          "name": "currencies",
+          "anchor": "playerscope-currencies",
+          "group": "saves",
+          "signature": "readonly currencies: CurrenciesApi",
+          "documented": true,
+          "summary": "Currency balances.\n\nA currency the player holds none of is simply absent rather than present as\nzero, so read it as a lookup with a default rather than a list to iterate.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.mutations",
+          "name": "mutations",
+          "anchor": "playerscope-mutations",
+          "group": "saves",
+          "signature": "readonly mutations: MutationsApi",
+          "documented": true,
+          "summary": "Changing what this player has — spending currency, granting items, running\na crafting recipe, advancing a progression.\n\nSeparate from [EntityScope.inventory](api-reference-game.md#entityscope-inventory) on purpose: reads are cached and\nsafe to repeat, writes are neither, and one object holding both makes that\ndistinction invisible where you call it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.saves",
+          "name": "saves",
+          "anchor": "playerscope-saves",
+          "group": "saves",
+          "signature": "readonly saves: SavesApi",
+          "documented": true,
+          "summary": "Saved progress — a world, a campaign, a replay. One document per key.\n\nThe line against [EntityScope.settings](api-reference-game.md#entityscope-settings) is what the value is, not how\nbig it is: a setting is a value your game names, a save is an opaque\ndocument the platform stores and hands back. A chosen difficulty is a\nsetting; the campaign it applies to is a save.\n\n**Every save key must be declared in your game config first.** Writing to an\nundeclared key fails with a message naming it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "saving-player-progress",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PlayerScope.orders",
+          "name": "orders",
+          "anchor": "playerscope-orders",
+          "group": "saves",
+          "signature": "readonly orders: OrdersApi",
+          "documented": true,
+          "summary": "This entity's order history — a read-only record of changes that happened.\n\nCreating an order is [EntityScope.mutations](api-reference-game.md#entityscope-mutations); this answers \"what\nhappened\" and \"did my write land\" (`orders.get(orderId)`).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.progressions",
+          "name": "progressions",
+          "anchor": "playerscope-progressions",
+          "group": "saves",
+          "signature": "readonly progressions: ProgressionsApi",
+          "documented": true,
+          "summary": "Progressions this entity is working through — a projection over the same\ncached snapshot [EntityScope.inventory](api-reference-game.md#entityscope-inventory) serves.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.passes",
+          "name": "passes",
+          "anchor": "playerscope-passes",
+          "group": "saves",
+          "signature": "readonly passes: PassesApi",
+          "documented": true,
+          "summary": "Which store passes the player holds, of those the platform lets games see.\nFor drawing a door; your function or server decides what a pass unlocks.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "arcade-and-store",
+              "anchor": null
+            }
+          ]
+        },
         {
           "id": "Setting",
           "name": "Setting",
@@ -8192,6 +8351,175 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "GamePass",
+          "name": "GamePass",
+          "anchor": "gamepass",
+          "group": "saves",
+          "signature": "interface GamePass",
+          "documented": true,
+          "summary": "One pass games may see, and whether this player holds it. Listed whether they\nhold it or not, and this is everything a game learns about it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.pass",
+          "name": "pass",
+          "anchor": "gamepass-pass",
+          "group": "saves",
+          "signature": "readonly pass: string",
+          "documented": true,
+          "summary": "The pass's offering slug, such as `vip`. Stable and not localized: key on this.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.held",
+          "name": "held",
+          "anchor": "gamepass-held",
+          "group": "saves",
+          "signature": "readonly held: boolean",
+          "documented": true,
+          "summary": "Whether the player holds it right now.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.endsAt",
+          "name": "endsAt",
+          "anchor": "gamepass-endsat",
+          "group": "saves",
+          "signature": "readonly endsAt: string | null",
+          "documented": true,
+          "summary": "When the player stops holding it, RFC 3339 in UTC, grace and any queued\nperiod included. `null` when it is not held, and when it is held with no\nend, so read [GamePass.held](api-reference-game.md#gamepass-held) first: `null` alone never means ended.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesEvent",
+          "name": "PassesEvent",
+          "anchor": "passesevent",
+          "group": "saves",
+          "signature": "type PassesEvent = \"changed\"",
+          "documented": true,
+          "summary": "The events [PassesApi.on](api-reference-game.md#passesapi-on) emits.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi",
+          "name": "PassesApi",
+          "anchor": "passesapi",
+          "group": "saves",
+          "signature": "interface PassesApi",
+          "documented": true,
+          "summary": "Which store passes the player holds, for the passes the platform lets games\nsee. Reached as `gem.me.passes`. VIP is the pass `vip`.\n\nUse it to DRAW a door open or shut, never to decide: it runs in the player's\nbrowser. What a pass unlocks is decided by your function or server.\n\nReads reject with a `GemApiError`, as every `gem.me` read does. That is\nunknown, not \"not held\", so keep what you drew. A guest reads as not holding.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "arcade-and-store",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PassesApi.list",
+          "name": "list",
+          "anchor": "passesapi-list",
+          "group": "saves",
+          "signature": "list(): Promise<readonly GamePass[]>",
+          "documented": true,
+          "summary": "Every pass games may see, held or not, ordered by slug. Empty when the\nplatform marks none. Always a fresh read; callers at the same moment share\none request.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi.get",
+          "name": "get",
+          "anchor": "passesapi-get",
+          "group": "saves",
+          "signature": "get(pass: string): Promise<GamePass>",
+          "documented": true,
+          "summary": "One pass by its slug. A pass the platform does not list reads as not held,\nso a door for a pass that is not on sale yet simply stays shut.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "pass",
+              "type": "string",
+              "optional": false,
+              "summary": null
+            }
+          ],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi.on",
+          "name": "on",
+          "anchor": "passesapi-on",
+          "group": "saves",
+          "signature": "on(event: \"changed\", listener: (passes: readonly GamePass[]) => void): () => void",
+          "documented": true,
+          "summary": "Hear the list change, with the new list, so a door opens right after a\npurchase and locks again when the pass ends. Returns a function that stops\nlistening.\n\nWhile something listens, the SDK reads again after a `gem.store` purchase\nanswers, when one settles, on resume (so a purchase in the Arcade's own\nstore is heard), after a sign-in and when a held pass ends. It says\nsomething only if the answer differs. Never fires in a function.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "event",
+              "type": "\"changed\"",
+              "optional": false,
+              "summary": null
+            },
+            {
+              "name": "listener",
+              "type": "(passes: readonly GamePass[]) => void",
+              "optional": false,
+              "summary": null
+            }
+          ],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "RewardCue",
           "name": "RewardCue",
@@ -12692,7 +13020,7 @@
           "name": "me",
           "anchor": "gem-me",
           "group": "start",
-          "signature": "readonly me: EntityScope",
+          "signature": "readonly me: PlayerScope",
           "documented": true,
           "summary": "This player's data in your game — settings, inventory, currencies and\nsaved progress.\n\nAlways usable; there is no null to check. Three things are easy to confuse\nand the SDK keeps them apart:\n\n| | what it is |\n|---|---|\n| [Gem.identity](api-reference-game.md#gem-identity) | who the platform says the player is |\n| [Gem.player](api-reference-game.md#gem-player) | the name and avatar you display |\n| `me` | what the player has in your game |",
           "deprecated": null,
@@ -12900,7 +13228,7 @@
           "group": "start",
           "signature": "readonly store: StoreApi",
           "documented": true,
-          "summary": "**Real money.** The Arcade Store's own Gem packs, Boosts, passes and\nbundles, sold for the player's money through the arcade's own purchase\nsheet. To spend Gems or Coins on your game's own items, use\n[Gem.purchases](api-reference-game.md#gem-purchases).\n\nList what the store sells here with `offers()`, show each `priceDisplay`\nexactly as given, and call `purchase(skuId)` from the player's press. For a\npass, a bundle or anything else whose pitch you would have to hardcode, call\n`showOffer(skuId)` instead, and the arcade draws the offer. After `ok`,\nre-read balances through [Gem.me](api-reference-game.md#gem-me). Nothing rejects.",
+          "summary": "**Real money.** The Arcade Store's own Gem packs, Boosts, passes and\nbundles, sold for the player's money through the arcade's own purchase\nsheet. To spend Gems or Coins on your game's own items, use\n[Gem.purchases](api-reference-game.md#gem-purchases).\n\nList what the store sells here with `offers()`, show each `priceDisplay`\nexactly as given, and call `purchase(skuId)` from the player's press. For a\npass, a bundle or anything else whose pitch you would have to hardcode, call\n`showOffer(skuId)` instead, and the arcade draws the offer. After `ok`,\nre-read balances through [Gem.me](api-reference-game.md#gem-me), and `gem.me.passes` for a pass.\nNothing rejects.",
           "deprecated": null,
           "params": [],
           "returns": null,
@@ -33274,6 +33602,175 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "GamePass",
+          "name": "GamePass",
+          "anchor": "gamepass",
+          "group": "player",
+          "signature": "interface GamePass",
+          "documented": true,
+          "summary": "One pass games may see, and whether this player holds it. Listed whether they\nhold it or not, and this is everything a game learns about it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.pass",
+          "name": "pass",
+          "anchor": "gamepass-pass",
+          "group": "player",
+          "signature": "readonly pass: string",
+          "documented": true,
+          "summary": "The pass's offering slug, such as `vip`. Stable and not localized: key on this.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.held",
+          "name": "held",
+          "anchor": "gamepass-held",
+          "group": "player",
+          "signature": "readonly held: boolean",
+          "documented": true,
+          "summary": "Whether the player holds it right now.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "GamePass.endsAt",
+          "name": "endsAt",
+          "anchor": "gamepass-endsat",
+          "group": "player",
+          "signature": "readonly endsAt: string | null",
+          "documented": true,
+          "summary": "When the player stops holding it, RFC 3339 in UTC, grace and any queued\nperiod included. `null` when it is not held, and when it is held with no\nend, so read [GamePass.held](api-reference-function.md#gamepass-held) first: `null` alone never means ended.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesEvent",
+          "name": "PassesEvent",
+          "anchor": "passesevent",
+          "group": "player",
+          "signature": "type PassesEvent = \"changed\"",
+          "documented": true,
+          "summary": "The events [PassesApi.on](api-reference-function.md#passesapi-on) emits.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi",
+          "name": "PassesApi",
+          "anchor": "passesapi",
+          "group": "player",
+          "signature": "interface PassesApi",
+          "documented": true,
+          "summary": "Which store passes the player holds, for the passes the platform lets games\nsee. Reached as `gem.me.passes`. VIP is the pass `vip`.\n\nUse it to DRAW a door open or shut, never to decide: it runs in the player's\nbrowser. What a pass unlocks is decided by your function or server.\n\nReads reject with a `GemApiError`, as every `gem.me` read does. That is\nunknown, not \"not held\", so keep what you drew. A guest reads as not holding.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "arcade-and-store",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PassesApi.list",
+          "name": "list",
+          "anchor": "passesapi-list",
+          "group": "player",
+          "signature": "list(): Promise<readonly GamePass[]>",
+          "documented": true,
+          "summary": "Every pass games may see, held or not, ordered by slug. Empty when the\nplatform marks none. Always a fresh read; callers at the same moment share\none request.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi.get",
+          "name": "get",
+          "anchor": "passesapi-get",
+          "group": "player",
+          "signature": "get(pass: string): Promise<GamePass>",
+          "documented": true,
+          "summary": "One pass by its slug. A pass the platform does not list reads as not held,\nso a door for a pass that is not on sale yet simply stays shut.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "pass",
+              "type": "string",
+              "optional": false,
+              "summary": null
+            }
+          ],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PassesApi.on",
+          "name": "on",
+          "anchor": "passesapi-on",
+          "group": "player",
+          "signature": "on(event: \"changed\", listener: (passes: readonly GamePass[]) => void): () => void",
+          "documented": true,
+          "summary": "Hear the list change, with the new list, so a door opens right after a\npurchase and locks again when the pass ends. Returns a function that stops\nlistening.\n\nWhile something listens, the SDK reads again after a `gem.store` purchase\nanswers, when one settles, on resume (so a purchase in the Arcade's own\nstore is heard), after a sign-in and when a held pass ends. It says\nsomething only if the answer differs. Never fires in a function.",
+          "deprecated": null,
+          "params": [
+            {
+              "name": "event",
+              "type": "\"changed\"",
+              "optional": false,
+              "summary": null
+            },
+            {
+              "name": "listener",
+              "type": "(passes: readonly GamePass[]) => void",
+              "optional": false,
+              "summary": null
+            }
+          ],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
         {
           "id": "SaveRecord",
           "name": "SaveRecord",
@@ -34062,6 +34559,165 @@
           "defaultValue": null,
           "guides": []
         },
+        {
+          "id": "PlayerScope",
+          "name": "PlayerScope",
+          "anchor": "playerscope",
+          "group": "player",
+          "signature": "interface PlayerScope",
+          "documented": true,
+          "summary": "What the signed-in player has in your game: everything a character has, and\nthe store passes they hold. Reached as `gem.me`.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "saving-player-progress",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PlayerScope.settings",
+          "name": "settings",
+          "anchor": "playerscope-settings",
+          "group": "player",
+          "signature": "readonly settings: SettingsApi",
+          "documented": true,
+          "summary": "Small named values your game chooses to persist — a difficulty, a control\nscheme, a last-used loadout.\n\nPer key, so two settings written from two places do not overwrite each\nother. For a whole document of progress, use [EntityScope.saves](api-reference-function.md#entityscope-saves).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.inventory",
+          "name": "inventory",
+          "anchor": "playerscope-inventory",
+          "group": "player",
+          "signature": "readonly inventory: InventoryApi",
+          "documented": true,
+          "summary": "What this player owns — items, and the progressions they are working\nthrough. Reads are cached; writes go through\n[EntityScope.mutations](api-reference-function.md#entityscope-mutations).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.currencies",
+          "name": "currencies",
+          "anchor": "playerscope-currencies",
+          "group": "player",
+          "signature": "readonly currencies: CurrenciesApi",
+          "documented": true,
+          "summary": "Currency balances.\n\nA currency the player holds none of is simply absent rather than present as\nzero, so read it as a lookup with a default rather than a list to iterate.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.mutations",
+          "name": "mutations",
+          "anchor": "playerscope-mutations",
+          "group": "player",
+          "signature": "readonly mutations: MutationsApi",
+          "documented": true,
+          "summary": "Changing what this player has — spending currency, granting items, running\na crafting recipe, advancing a progression.\n\nSeparate from [EntityScope.inventory](api-reference-function.md#entityscope-inventory) on purpose: reads are cached and\nsafe to repeat, writes are neither, and one object holding both makes that\ndistinction invisible where you call it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.saves",
+          "name": "saves",
+          "anchor": "playerscope-saves",
+          "group": "player",
+          "signature": "readonly saves: SavesApi",
+          "documented": true,
+          "summary": "Saved progress — a world, a campaign, a replay. One document per key.\n\nThe line against [EntityScope.settings](api-reference-function.md#entityscope-settings) is what the value is, not how\nbig it is: a setting is a value your game names, a save is an opaque\ndocument the platform stores and hands back. A chosen difficulty is a\nsetting; the campaign it applies to is a save.\n\n**Every save key must be declared in your game config first.** Writing to an\nundeclared key fails with a message naming it.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "saving-player-progress",
+              "anchor": null
+            }
+          ]
+        },
+        {
+          "id": "PlayerScope.orders",
+          "name": "orders",
+          "anchor": "playerscope-orders",
+          "group": "player",
+          "signature": "readonly orders: OrdersApi",
+          "documented": true,
+          "summary": "This entity's order history — a read-only record of changes that happened.\n\nCreating an order is [EntityScope.mutations](api-reference-function.md#entityscope-mutations); this answers \"what\nhappened\" and \"did my write land\" (`orders.get(orderId)`).",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.progressions",
+          "name": "progressions",
+          "anchor": "playerscope-progressions",
+          "group": "player",
+          "signature": "readonly progressions: ProgressionsApi",
+          "documented": true,
+          "summary": "Progressions this entity is working through — a projection over the same\ncached snapshot [EntityScope.inventory](api-reference-function.md#entityscope-inventory) serves.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": []
+        },
+        {
+          "id": "PlayerScope.passes",
+          "name": "passes",
+          "anchor": "playerscope-passes",
+          "group": "player",
+          "signature": "readonly passes: PassesApi",
+          "documented": true,
+          "summary": "Which store passes the player holds, of those the platform lets games see.\nFor drawing a door; your function or server decides what a pass unlocks.",
+          "deprecated": null,
+          "params": [],
+          "returns": null,
+          "throws": null,
+          "example": null,
+          "defaultValue": null,
+          "guides": [
+            {
+              "slug": "arcade-and-store",
+              "anchor": null
+            }
+          ]
+        },
         {
           "id": "Setting",
           "name": "Setting",
@@ -38994,7 +39650,7 @@
           "name": "me",
           "anchor": "gemfunction-me",
           "group": "start",
-          "signature": "readonly me: EntityScope",
+          "signature": "readonly me: PlayerScope",
           "documented": true,
           "summary": "The invoking player's data in your game — settings, inventory, currencies,\nsaves. Throws on a game-server invocation, which has no player.",
           "deprecated": null,