Game

class telegram.Game(title, description, photo, text=None, text_entities=None, animation=None, *, api_kwargs=None)

Bases: telegram.TelegramObject

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their title, description and photo are equal.

Available In

telegram.Message.game

Parameters:

• title (str) – Title of the game.

• description (str) – Description of the game.

• photo (Sequence[telegram.PhotoSize]) –

  Photo that will be displayed in the game message in chats.

  Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

• text (str, optional) – Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls telegram.Bot.set_game_score(), or manually edited using telegram.Bot.edit_message_text(). 0-4096 characters.

• text_entities (Sequence[telegram.MessageEntity], optional) –

  Special entities that appear in text, such as usernames, URLs, bot commands, etc.

  Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

• animation (telegram.Animation, optional) –

  Animation that will be displayed in the game message in chats. Upload via BotFather.

title

Title of the game.

Type:

str

description

Description of the game.

Type:

str

photo

Photo that will be displayed in the game message in chats.

Changed in version 20.0: This attribute is now an immutable tuple.

Type:

Tuple[telegram.PhotoSize]

text

Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls telegram.Bot.set_game_score(), or manually edited using telegram.Bot.edit_message_text(). 0-4096 characters.

Type:

str

text_entities

Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. This tuple is empty if the message does not contain text entities.

Changed in version 20.0: This attribute is now an immutable tuple.

Type:

Tuple[telegram.MessageEntity]

animation

Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.

Type:

telegram.Animation

classmethod de_json(data, bot=None)

See telegram.TelegramObject.de_json().

parse_text_entities(types=None)

Returns a dict that maps telegram.MessageEntity to str. It contains entities from this message filtered by their type attribute as the key, and the text that each entity belongs to as the value of the dict.

Note

This method should always be used instead of the text_entities attribute, since it calculates the correct substring from the message text based on UTF-16 codepoints. See parse_text_entity for more info.

Parameters:

types (List[str], optional) – List of telegram.MessageEntity types as strings. If the type attribute of an entity is contained in this list, it will be returned. Defaults to telegram.MessageEntity.ALL_TYPES.

Returns:

A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints.

Return type:

Dict[telegram.MessageEntity, str]

parse_text_entity(entity)

Returns the text from a given telegram.MessageEntity.

Note

This method is present because Telegram calculates the offset and length in UTF-16 codepoint pairs, which some versions of Python don’t handle automatically. (That is, you can’t just slice Message.text with the offset and length.)

Parameters:

entity (telegram.MessageEntity) – The entity to extract the text from. It must be an entity that belongs to this message.

Returns:

The text of the given entity.

Return type:

str

Raises:

RuntimeError – If this game has no text.