@@ -38,19 +38,23 @@ class HypeChatData:
38
38
-----------
39
39
amount: :class:`int`
40
40
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.
43
44
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.
45
47
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.
47
51
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 .
49
53
"""
50
54
51
55
def __init__ (self , tags : dict ) -> None :
52
56
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 " ])
54
58
self .currency : str = tags ["pinned-chat-paid-currency" ]
55
59
self .is_system_message : bool = tags ["pinned-chat-paid-is-system-message" ] == "1"
56
60
self .level : str = tags ["pinned-chat-paid-level" ]
0 commit comments