feat: ✨ Add Member.display_avatar_decoration and Member.guild_avatar_decoration (#3109)

* Fix User.nameplate being entirely broken

* Fix nameplate updating

* Add nameplate bug changelog

* Turn nameplate into a property for cleaner handling

* Remove unnecessary import

* Turn primary_guild into a property for easier handling

* Make event fire on avatar decoration change

* Update changelog

* First semi-working version

* Add new class to docs

* Fix PR number

* Fix typo..

* Add ability to compare collectibles and nameplates

* Minor fix

* Missing word

* Simplify nameplate return code

* Move __all__ up

* Apply code change requests

* Make sure attribute shows in IDEs

* Apply code change requests

* Update changelog

* Implement `Member.display_avatar_decoration`

* Apply code change requests

* Apply code change requests

* Correct typehint

* Add avatar decoration type

* Add avatar decoration field to member type

---------

Signed-off-by: ToothyDev <55001472+ToothyDev@users.noreply.github.com>

Author: ToothyDev

CHANGELOG.md

@@ -20,6 +20,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#3107](https://github.com/Pycord-Development/pycord/pull/3107))
 - Added the ability to compare instances of `Nameplate`.
   ([#3107](https://github.com/Pycord-Development/pycord/pull/3107))
+- Added `Member.display_avatar_decoration` and `Member.guild_avatar_decoration`.
+  ([#3109](https://github.com/Pycord-Development/pycord/pull/3109))
 
 ### Changed
 

discord/member.py

@@ -46,6 +46,7 @@
 from .permissions import Permissions
 from .primary_guild import PrimaryGuild
 from .role import RoleColours
+from .types.collectibles import AvatarDecoration
 from .user import BaseUser, User, _UserTag
 from .utils import MISSING
 
@@ -296,6 +297,7 @@ class Member(discord.abc.Messageable, _UserTag):
         "_banner",
         "communication_disabled_until",
         "flags",
+        "_avatar_decoration",
     )
 
     if TYPE_CHECKING:
@@ -317,6 +319,7 @@ class Member(discord.abc.Messageable, _UserTag):
         communication_disabled_until: datetime.datetime | None
         primary_guild: PrimaryGuild | None
         collectibles: Collectibles | None
+        avatar_decoration: Asset | None
 
     def __init__(
         self, *, data: MemberWithUserPayload, guild: Guild, state: ConnectionState
@@ -341,6 +344,9 @@ def __init__(
             data.get("communication_disabled_until")
         )
         self.flags: MemberFlags = MemberFlags._from_value(data.get("flags", 0))
+        self._avatar_decoration: AvatarDecoration | None = data.get(
+            "avatar_decoration_data"
+        )
 
     def __str__(self) -> str:
         return str(self._user)
@@ -418,6 +424,7 @@ def _copy(cls: type[M], member: M) -> M:
         self._banner = member._banner
         self.communication_disabled_until = member.communication_disabled_until
         self.flags = member.flags
+        self._avatar_decoration = member._avatar_decoration
 
         # Reference will not be copied unless necessary by PRESENCE_UPDATE
         # See below
@@ -449,6 +456,7 @@ def _update(self, data: MemberPayload) -> None:
             data.get("communication_disabled_until")
         )
         self.flags = MemberFlags._from_value(data.get("flags", 0))
+        self._avatar_decoration = data.get("avatar_decoration_data")
 
     def _presence_update(
         self, data: PartialPresenceUpdate, user: UserPayload
@@ -663,6 +671,31 @@ def guild_avatar(self) -> Asset | None:
             self._state, self.guild.id, self.id, self._avatar
         )
 
+    @property
+    def display_avatar_decoration(self) -> Asset | None:
+        """Returns the member's displayed avatar decoration.
+
+        For regular members this is just their avatar decoration, but
+        if they have a guild specific avatar decoration then that
+        is returned instead.
+
+        .. versionadded:: 2.8
+        """
+        return self.guild_avatar_decoration or self._user.avatar_decoration
+
+    @property
+    def guild_avatar_decoration(self) -> Asset | None:
+        """Returns an :class:`Asset` for the guild specific avatar decoration
+        the member has. If unavailable, ``None`` is returned.
+
+        .. versionadded:: 2.8
+        """
+        if self._avatar_decoration is None:
+            return None
+        return Asset._from_avatar_decoration(
+            self._state, self.id, self._avatar_decoration.get("asset")
+        )
+
     @property
     def display_banner(self) -> Asset | None:
         """Returns the member's display banner.

discord/types/collectibles.py

@@ -38,3 +38,8 @@ class Nameplate(TypedDict):
     asset: str
     label: str
     palette: str
+
+
+class AvatarDecoration(TypedDict):
+    sku_id: Snowflake
+    asset: str

discord/types/member.py

@@ -25,7 +25,7 @@
 
 from typing import TypedDict
 
-from .collectibles import Collectibles
+from .collectibles import AvatarDecoration, Collectibles
 from .snowflake import SnowflakeList
 from .user import User
 
@@ -52,6 +52,7 @@ class Member(PartialMember, total=False):
     communication_disabled_until: str
     flags: int
     collectibles: Collectibles
+    avatar_decoration_data: AvatarDecoration
 
 
 class _OptionalMemberWithUser(PartialMember, total=False):
@@ -60,6 +61,7 @@ class _OptionalMemberWithUser(PartialMember, total=False):
     premium_since: str
     pending: bool
     permissions: str
+    avatar_decoration_data: AvatarDecoration
 
 
 class MemberWithUser(_OptionalMemberWithUser):