2020-04-10 19:22:45 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2023-01-01 21:31:29 +01:00
|
|
|
# Copyright (C) 2015-2023
|
2020-04-10 19:22:45 +02:00
|
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program 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 Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
|
|
"""This module contains an object that represents a Telegram Dice."""
|
2022-10-07 11:51:53 +02:00
|
|
|
from typing import ClassVar, List
|
2020-04-10 19:22:45 +02:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram import constants
|
|
|
|
from telegram._telegramobject import TelegramObject
|
2022-10-07 11:51:53 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2020-04-10 19:22:45 +02:00
|
|
|
|
|
|
|
class Dice(TelegramObject):
|
|
|
|
"""
|
2020-06-22 20:09:52 +02:00
|
|
|
This object represents an animated emoji with a random value for currently supported base
|
|
|
|
emoji. (The singular form of "dice" is "die". However, PTB mimics the Telegram API, which uses
|
|
|
|
the term "dice".)
|
2020-05-02 11:56:52 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
|
|
considered equal, if their :attr:`value` and :attr:`emoji` are equal.
|
|
|
|
|
2020-05-02 11:56:52 +02:00
|
|
|
Note:
|
2022-11-22 11:07:42 +01:00
|
|
|
If :attr:`emoji` is :tg-const:`telegram.Dice.DARTS`, a value of 6 currently
|
|
|
|
represents a bullseye, while a value of 1 indicates that the dartboard was missed.
|
|
|
|
However, this behaviour is undocumented and might be changed by Telegram.
|
2020-04-10 19:22:45 +02:00
|
|
|
|
2022-11-22 11:07:42 +01:00
|
|
|
If :attr:`emoji` is :tg-const:`telegram.Dice.BASKETBALL`, a value of 4 or 5
|
|
|
|
currently score a basket, while a value of 1 to 3 indicates that the basket was missed.
|
|
|
|
However, this behaviour is undocumented and might be changed by Telegram.
|
2020-06-22 20:09:52 +02:00
|
|
|
|
2022-11-22 11:07:42 +01:00
|
|
|
If :attr:`emoji` is :tg-const:`telegram.Dice.FOOTBALL`, a value of 4 to 5
|
|
|
|
currently scores a goal, while a value of 1 to 3 indicates that the goal was missed.
|
|
|
|
However, this behaviour is undocumented and might be changed by Telegram.
|
2020-11-29 16:20:46 +01:00
|
|
|
|
2022-11-22 11:07:42 +01:00
|
|
|
If :attr:`emoji` is :tg-const:`telegram.Dice.BOWLING`, a value of 6 knocks
|
|
|
|
all the pins, while a value of 1 means all the pins were missed.
|
|
|
|
However, this behaviour is undocumented and might be changed by Telegram.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
2022-11-22 11:07:42 +01:00
|
|
|
If :attr:`emoji` is :tg-const:`telegram.Dice.SLOT_MACHINE`, each value
|
|
|
|
corresponds to a unique combination of symbols, which
|
2023-01-01 16:24:00 +01:00
|
|
|
can be found in our
|
|
|
|
:wiki:`wiki <Code-snippets#map-a-slot-machine-dice-value-to-the-corresponding-symbols>`.
|
2022-01-21 16:51:03 +01:00
|
|
|
However, this behaviour is undocumented and might be changed by Telegram.
|
2020-11-29 16:20:46 +01:00
|
|
|
|
2022-11-22 11:07:42 +01:00
|
|
|
..
|
|
|
|
In args, some links for limits of `value` intentionally point to constants for only
|
|
|
|
one emoji of a group to avoid duplication. For example, maximum value for Dice, Darts and
|
|
|
|
Bowling is linked to a constant for Bowling.
|
|
|
|
|
2020-04-10 19:22:45 +02:00
|
|
|
Args:
|
2022-11-22 11:07:42 +01:00
|
|
|
value (:obj:`int`): Value of the dice.
|
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BOWLING`
|
|
|
|
for :tg-const:`telegram.Dice.DICE`, :tg-const:`telegram.Dice.DARTS` and
|
|
|
|
:tg-const:`telegram.Dice.BOWLING` base emoji,
|
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BASKETBALL`
|
|
|
|
for :tg-const:`telegram.Dice.BASKETBALL` and :tg-const:`telegram.Dice.FOOTBALL`
|
|
|
|
base emoji,
|
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_SLOT_MACHINE`
|
|
|
|
for :tg-const:`telegram.Dice.SLOT_MACHINE` base emoji.
|
2020-05-02 11:56:52 +02:00
|
|
|
emoji (:obj:`str`): Emoji on which the dice throw animation is based.
|
2020-12-30 15:59:50 +01:00
|
|
|
|
|
|
|
Attributes:
|
|
|
|
value (:obj:`int`): Value of the dice.
|
2023-01-01 16:24:00 +01:00
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BOWLING`
|
|
|
|
for :tg-const:`telegram.Dice.DICE`, :tg-const:`telegram.Dice.DARTS` and
|
|
|
|
:tg-const:`telegram.Dice.BOWLING` base emoji,
|
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BASKETBALL`
|
|
|
|
for :tg-const:`telegram.Dice.BASKETBALL` and :tg-const:`telegram.Dice.FOOTBALL`
|
|
|
|
base emoji,
|
|
|
|
:tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_SLOT_MACHINE`
|
|
|
|
for :tg-const:`telegram.Dice.SLOT_MACHINE` base emoji.
|
2020-12-30 15:59:50 +01:00
|
|
|
emoji (:obj:`str`): Emoji on which the dice throw animation is based.
|
|
|
|
|
2020-04-10 19:22:45 +02:00
|
|
|
"""
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2021-08-19 22:01:10 +02:00
|
|
|
__slots__ = ("emoji", "value")
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
def __init__(self, value: int, emoji: str, *, api_kwargs: JSONDict = None):
|
|
|
|
super().__init__(api_kwargs=api_kwargs)
|
2023-02-02 18:55:07 +01:00
|
|
|
self.value: int = value
|
|
|
|
self.emoji: str = emoji
|
2020-04-10 19:22:45 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
self._id_attrs = (self.value, self.emoji)
|
|
|
|
|
2022-12-15 15:00:36 +01:00
|
|
|
self._freeze()
|
|
|
|
|
2021-10-19 18:28:19 +02:00
|
|
|
DICE: ClassVar[str] = constants.DiceEmoji.DICE # skipcq: PTC-W0052
|
|
|
|
""":const:`telegram.constants.DiceEmoji.DICE`"""
|
|
|
|
DARTS: ClassVar[str] = constants.DiceEmoji.DARTS
|
|
|
|
""":const:`telegram.constants.DiceEmoji.DARTS`"""
|
|
|
|
BASKETBALL: ClassVar[str] = constants.DiceEmoji.BASKETBALL
|
|
|
|
""":const:`telegram.constants.DiceEmoji.BASKETBALL`"""
|
|
|
|
FOOTBALL: ClassVar[str] = constants.DiceEmoji.FOOTBALL
|
|
|
|
""":const:`telegram.constants.DiceEmoji.FOOTBALL`"""
|
|
|
|
SLOT_MACHINE: ClassVar[str] = constants.DiceEmoji.SLOT_MACHINE
|
|
|
|
""":const:`telegram.constants.DiceEmoji.SLOT_MACHINE`"""
|
|
|
|
BOWLING: ClassVar[str] = constants.DiceEmoji.BOWLING
|
2021-03-14 16:41:35 +01:00
|
|
|
"""
|
2021-10-19 18:28:19 +02:00
|
|
|
:const:`telegram.constants.DiceEmoji.BOWLING`
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
.. versionadded:: 13.4
|
|
|
|
"""
|
2021-10-19 18:28:19 +02:00
|
|
|
ALL_EMOJI: ClassVar[List[str]] = list(constants.DiceEmoji)
|
|
|
|
"""List[:obj:`str`]: A list of all available dice emoji."""
|
2022-11-22 11:07:42 +01:00
|
|
|
|
|
|
|
MIN_VALUE: ClassVar[int] = constants.DiceLimit.MIN_VALUE
|
|
|
|
""":const:`telegram.constants.DiceLimit.MIN_VALUE`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_BOWLING: ClassVar[int] = constants.DiceLimit.MAX_VALUE_BOWLING
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_BOWLING`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_DARTS: ClassVar[int] = constants.DiceLimit.MAX_VALUE_DARTS
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_DARTS`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_DICE: ClassVar[int] = constants.DiceLimit.MAX_VALUE_DICE
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_DICE`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_BASKETBALL: ClassVar[int] = constants.DiceLimit.MAX_VALUE_BASKETBALL
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_BASKETBALL`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_FOOTBALL: ClassVar[int] = constants.DiceLimit.MAX_VALUE_FOOTBALL
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_FOOTBALL`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
MAX_VALUE_SLOT_MACHINE: ClassVar[int] = constants.DiceLimit.MAX_VALUE_SLOT_MACHINE
|
|
|
|
""":const:`telegram.constants.DiceLimit.MAX_VALUE_SLOT_MACHINE`
|
|
|
|
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
"""
|