Skip to content

Commit 8e9bd1c

Browse files
Added nameplate documentation (#7614)
* Added nameplate documentation * Add better example and palette strings * Oops
1 parent 67905f9 commit 8e9bd1c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/resources/user.mdx

Lines changed: 33 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

@@ -66,6 +67,14 @@ There are other rules and restrictions not shared here for the sake of spam and
6667
"avatar_decoration_data": {
6768
"sku_id": "1144058844004233369",
6869
"asset": "a_fed43ab12698df65902ba06727e20c0e"
70+
},
71+
"collectibles": {
72+
"nameplate": {
73+
"sku_id": "2247558840304243311",
74+
"asset": "nameplates/nameplates/twilight/",
75+
"label": "",
76+
"palette": "cobalt"
77+
}
6978
}
7079
}
7180
```
@@ -112,6 +121,30 @@ The data for the user's [avatar decoration](https://support.discord.com/hc/en-us
112121
| asset | string | the [avatar decoration hash](/docs/reference#image-formatting) |
113122
| sku_id | snowflake | id of the avatar decoration's SKU |
114123

124+
### Collectibles
125+
126+
The collectibles the user has, excluding Avatar Decorations and Profile Effects.
127+
128+
###### Collectible Structure
129+
130+
| Field | Type | Description |
131+
|------------|--------|----------------------------------------------------------------------------------------|
132+
| nameplate? | object | object mapping of [nameplate data](/docs/resources/user#nameplate-nameplate-structure) |
133+
134+
135+
### Nameplate
136+
137+
The nameplate the user has.
138+
139+
###### Nameplate Structure
140+
141+
| Field | Type | Description |
142+
|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------|
143+
| sku_id | snowflake | id of the nameplate SKU |
144+
| asset | string | path to the [nameplate asset](/docs/reference#image-formatting) |
145+
| label | string | the label of this nameplate. Currently unused |
146+
| palette | string | background color of the nameplate, one of: `crimson`, `berry`, `sky`, `teal`, `forest`, `bubble_gum`, `violet`, `cobalt`, `clover`, `lemon`, `white` |
147+
115148
### Connection Object
116149

117150
The connection object that the user has attached.

0 commit comments

Comments
 (0)