CityGame

SUBSCRIBE game/get

SUB game/get

Gets a Game's State

SUBSCRIBE game/get

Message

Payload

  • game object
    Hide game attributes Show game attributes object
    • id string
    • started boolean
    • tiles array[object]
      Hide tiles attributes Show tiles attributes array[object]
      • user object
        Hide user attribute Show user attribute object
      • x integer
      • y integer
      • type string

        Values are COMMERCIAL, MANUFACTURING, RESIDENTIAL, or STREET.

      • level integer
    • buildableTiles array[object]
      Hide buildableTiles attributes Show buildableTiles attributes array[object]
    • users array[object]
      Hide users attributes Show users attributes array[object]
    • remainingTurns array[object]
      Hide remainingTurns attribute Show remainingTurns attribute array[object]
      • user object
        Hide user attribute Show user attribute object
  • user object
    Hide user attributes Show user attributes object
  • type string
  • appVersion string
Payload example 
{
  "game": {
    "id": "HX8K0S",
    "started": true,
    "tiles": [
      {
        "user": {
          "id": "8a7f197a-7707-409b-ace4-9ad038e7a0de"
        },
        "x": 0,
        "y": 0,
        "type": "COMMERCIAL",
        "level": 1
      }
    ],
    "buildableTiles": [
      {
        "x": 0,
        "y": 0
      }
    ],
    "users": [
      {
        "name": "Alice",
        "id": "dd5fe58c-f28a-4836-be05-893f0011c2d9",
        "bank": 1000,
        "isAi": false
      }
    ],
    "remainingTurns": [
      {
        "user": {
          "id": "8a7f197a-7707-409b-ace4-9ad038e7a0de"
        }
      }
    ]
  },
  "user": {
    "name": "Alice",
    "id": "dd5fe58c-f28a-4836-be05-893f0011c2d9"
  },
  "type": "GetGameResponse",
  "appVersion": "1.4.0"
}