Game Class

extends Base

Properties

  • animation: Animation
  • client: Client
  • description: string
  • photo:
  • text: string
  • textEntities:
  • title: string

Methods

{
  "id": 1305,
  "name": "Game",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "children": [
    {
      "id": 1306,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 35,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1307,
          "name": "new Game",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/Game.ts",
              "line": 35,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1308,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1309,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1305,
            "name": "Game",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1315,
      "name": "animation",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Animation that will be displayed in the game message in chats.\nUpload via [BotFather](https://t.me/botfather)."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 32,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 617,
        "name": "Animation",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1316,
      "name": "client",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isInherited": true
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Base.ts",
          "line": 4,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1,
        "name": "Client",
        "package": "tgkit",
        "qualifiedName": "default"
      },
      "inheritedFrom": {
        "type": "reference",
        "target": -1,
        "name": "Base.client"
      }
    },
    {
      "id": 1311,
      "name": "description",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Description of the game"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 12,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1312,
      "name": "photo",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Photo that will be displayed in the game message in chats."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 15,
          "character": 1
        }
      ],
      "type": {
        "type": "array",
        "elementType": {
          "type": "reference",
          "target": 1726,
          "name": "PhotoSize",
          "package": "tgkit",
          "qualifiedName": "default"
        }
      }
    },
    {
      "id": 1313,
      "name": "text",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Brief description of the game or high scores included in the game message.\nCan be automatically edited to include current high scores for the game\nwhen the bot calls "
          },
          {
            "kind": "code",
            "text": "`<Client>.setGameScore()`"
          },
          {
            "kind": "text",
            "text": ", or manually edited as a regular message.\n0-4096 characters."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 23,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1314,
      "name": "textEntities",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Special entities that appear in *text*, such as usernames, URLs, bot commands, etc."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 26,
          "character": 1
        }
      ],
      "type": {
        "type": "array",
        "elementType": {
          "type": "reference",
          "target": 1625,
          "name": "MessageEntity",
          "package": "tgkit",
          "qualifiedName": "default"
        }
      }
    },
    {
      "id": 1310,
      "name": "title",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Title of the game"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Game.ts",
          "line": 9,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1306
      ]
    },
    {
      "title": "Properties",
      "children": [
        1315,
        1316,
        1311,
        1312,
        1313,
        1314,
        1310
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/Game.ts",
      "line": 7,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}