Skip to content

Commit a8849b2

Browse files
committed
document nameplates
1 parent a3369d8 commit a8849b2

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/reference.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
352352
| Role Icon | role-icons/[role_id](/docs/topics/permissions#role-object)/[role_icon](/docs/topics/permissions#role-object).png | PNG, JPEG, WebP |
353353
| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/docs/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP |
354354
| Guild Member Banner | guilds/[guild_id](/docs/resources/guild#guild-object)/users/[user_id](/docs/resources/user#user-object)/banners/[member_banner](/docs/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF |
355+
| Nameplate Asset | assets/collectibles/[asset](/docs/resources/user#nameplate-structure)/asset.webm | WebM |
355356

356357
\* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. (example: `a_1269e74af4df7417b13759eae50c83dc`)
357358

docs/resources/user.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ There are other rules and restrictions not shared here for the sake of spam and
4747
| premium_type? | integer | the [type of Nitro subscription](/docs/resources/user#user-object-premium-types) on a user's account | identify |
4848
| public_flags? | integer | the public [flags](/docs/resources/user#user-object-user-flags) on a user's account | identify |
4949
| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the user's avatar decoration | identify |
50+
| collectibles? | ?[collectibles](/docs/resources/user#collectibles) object | data for the user's collectibles | identify
5051

5152
###### Example User
5253

@@ -183,6 +184,30 @@ The role connection object that an application has attached to a user.
183184
| platform_username | ?string | the username on the platform a bot has connected (max 100 characters) |
184185
| metadata | object | object mapping [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected |
185186

187+
### Collectibles
188+
189+
The collectibles the user has.
190+
191+
###### Collectible Structure
192+
193+
| Field | Type | Description |
194+
|------------|--------|------------------------------------------------------------------------------|
195+
| nameplate? | object | object mapping of [nameplate data](/docs/resources/user#nameplate-structure) |
196+
197+
198+
### Nameplate
199+
200+
The nameplate the user currently has.
201+
202+
###### Nameplate Structure
203+
| Field | Type | Description |
204+
|---------|-----------|-----------------------------------------------------------------|
205+
| sku_id | snowflake | id of the nameplate's decoration SKU |
206+
| asset | string | path to the [nameplate asset](/docs/reference#image-formatting) |
207+
| label | string | the label of this nameplate |
208+
| palette | string | the name of the most dominant colour in this nameplate |
209+
210+
186211
## Get Current User
187212
<Route method="GET">/users/@me</Route>
188213

0 commit comments

Comments
 (0)