Repository navigation
Expand file tree
/
Copy pathset_game_score.py
More file actions
100 lines (83 loc) · 3.94 KB
/
Copy pathset_game_score.py
File metadata and controls
100 lines (83 loc) · 3.94 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import hydrogram
from hydrogram import raw, types
class SetGameScore:
async def set_game_score(
self: hydrogram.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,
) -> types.Message | bool:
# inline_message_id: str = None): TODO Add inline_message_id
"""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.
Returns:
:obj:`~hydrogram.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)
"""
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 or None,
edit_message=not disable_edit_message or None,
)
)
for i in r.updates:
if isinstance(i, (raw.types.UpdateEditMessage, raw.types.UpdateEditChannelMessage)):
return await types.Message._parse(
client=self,
message=i.message,
users={i.id: i for i in r.users},
chats={i.id: i for i in r.chats},
)
return True