set_game_score()

Client.set_game_score()

Set the score of the specified user in a game.

Parameters
  • user_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • score (int) – New score, must be non-negative.

  • force (bool, optional) – Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.

  • disable_edit_message (bool, optional) – Pass True, if the game message should not be automatically edited to include the current scoreboard.

  • chat_id (int | str, optional) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str). Required if inline_message_id is not specified.

  • message_id (int, optional) – Identifier of the sent message. Required if inline_message_id is not specified.

Returns

Message | bool – On success, if the message was sent by the bot, the edited message is returned, True otherwise.

Example

# Set new score
app.set_game_score(user_id, 1000)

# Force set new score
app.set_game_score(user_id, 25, force=True)