# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import pyrogram
from pyrogram import raw, types, utils
from pyrogram.methods.messages.inline_session import invoke_inline
class SetGameScore:
async def set_game_score(
self: pyrogram.Client,
user_id: int | str,
score: int,
force: bool | None = None,
disable_edit_message: bool | None = None,
chat_id: int | str | None = None,
message_id: int | None = None,
inline_message_id: str | None = None,
) -> types.Message | bool:
"""Set the score of the specified user in a game.
.. include:: /_includes/usable-by/bots.rst
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.
inline_message_id (``str``, *optional*):
Identifier of the inline message.
Required if chat_id and message_id are not specified.
Returns:
:obj:`~pyrogram.types.Message` | ``bool``: On success, if the message was sent by the bot, the edited
message is returned, True otherwise.
Example:
.. code-block:: python
# Set new score
await app.set_game_score(user_id, 1000)
# Force set new score
await app.set_game_score(user_id, 25, force=True)
"""
if inline_message_id is not None:
unpacked = utils.unpack_inline_message_id(inline_message_id)
dc_id = unpacked.dc_id
return await invoke_inline(
self,
dc_id,
raw.functions.messages.SetInlineGameScore(
id=unpacked,
user_id=await self.resolve_peer(user_id),
score=score,
force=force if force is not None else None,
edit_message=not disable_edit_message or None,
),
)
else:
if chat_id is None or message_id is None:
raise ValueError(
"Either (chat_id, message_id) or inline_message_id must be provided"
)
r = await self.invoke(
raw.functions.messages.SetGameScore(
peer=await self.resolve_peer(chat_id),
score=score,
id=message_id,
user_id=await self.resolve_peer(user_id),
force=force if force is not None else None,
edit_message=not disable_edit_message or None,
)
)
if isinstance(r, bool):
return r
for i in r.updates:
if isinstance(
i,
(
raw.types.UpdateEditMessage,
raw.types.UpdateEditEphemeralMessage,
raw.types.UpdateEditChannelMessage,
),
):
return await types.Message._parse(
self, i.message, {i.id: i for i in r.users}, {i.id: i for i in r.chats}
)
return True