Skip to content

Commit c9cbe0a

Browse files
committed
Update hypechatdata to official spec
Update hypechatdata to official spec
1 parent 1553a0b commit c9cbe0a

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

twitchio/message.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,23 @@ class HypeChatData:
3838
-----------
3939
amount: :class:`int`
4040
The amount paid.
41-
canonical_amount: :class:`int`
42-
The canonical amount paid(?) # FIXME: figure this out before next version release
41+
exponent: :class:`int`
42+
Indicates how many decimal points this currency represents partial amounts in.
43+
Decimal points start from the right side of the value defined in pinned-chat-paid-amount.
4344
currency: :class:`str`
44-
The currency paid in, in standard form (eg. USD, EUR, GBP).
45+
The currency paid in, uses ISO 4217 alphabetic currency code (eg. USD, EUR, GBP).
46+
The ISO 4217 alphabetic currency code the user has sent the Hype Chat in.
4547
is_system_message: :class:`bool`
46-
Whether this Hype Chat originated from a user or Twitch.
48+
A Boolean value that determines if the message sent with the Hype Chat was filled in by the system.
49+
If True, the user entered no message and the body message was automatically filled in by the system.
50+
If False, the user provided their own message to send with the Hype Chat.
4751
level: :class:`str`
48-
The level this Hype Chat reached. For some reason this is a spelled out number (ex ``TWO``).
52+
The level of the Hype Chat, in English. e.g. ONE, TWO, THREE up to TEN.
4953
"""
5054

5155
def __init__(self, tags: dict) -> None:
5256
self.amount: int = int(tags["pinned-chat-paid-amount"])
53-
self.canonical_amount: int = int(tags["pinned-chat-paid-canonical-amount"])
57+
self.exponent: int = int(tags["pinned-chat-paid-exponent"])
5458
self.currency: str = tags["pinned-chat-paid-currency"]
5559
self.is_system_message: bool = tags["pinned-chat-paid-is-system-message"] == "1"
5660
self.level: str = tags["pinned-chat-paid-level"]

0 commit comments

Comments
 (0)