games.atplay.game.invitation Documentation (EN)

main record

An invitation to play a game, with everything needed to execute it

Record Key tid Timestamp-based ID

Properties

game ref games.atplay.game.release Required

No description available.

otherPlayers array of string did Required

Array of DIDs for other players in the game

minLength: 1 items

parameters ref #parameters Optional

Any parameters of play used by the game logic

state ref games.atplay.game.state Required

No description available.

View raw schema

{
  "description": "An invitation to play a game, with everything needed to execute it",
  "key": "tid",
  "record": {
    "properties": {
      "game": {
        "ref": "games.atplay.game.release",
        "type": "ref"
      },
      "otherPlayers": {
        "description": "Array of DIDs for other players in the game",
        "items": {
          "format": "did",
          "type": "string"
        },
        "minLength": 1,
        "type": "array"
      },
      "parameters": {
        "description": "Any parameters of play used by the game logic",
        "ref": "#parameters",
        "type": "ref"
      },
      "state": {
        "ref": "games.atplay.game.state",
        "type": "ref"
      }
    },
    "required": [
      "game",
      "otherPlayers",
      "state"
    ],
    "type": "object"
  },
  "type": "record"
}

parameters object

Open-ended container for a game's parameters. Game logic interprets the fields.

This object has no properties defined.

View raw schema

{
  "description": "Open-ended container for a game's parameters. Game logic interprets the fields.",
  "properties": {},
  "type": "object"
}