AvatarService
Reading and saving the player's avatar.
On this page
The platform avatar. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
Methods#
GetAvatar#
HTTP
POST /neo.platform.v1.AvatarService/GetAvatar
Content-Type: application/jsonAuth: A signed-in account or a guest.
Also callable with a scoped token: avatar.
Request: GetAvatarRequest. Response: Avatar.
SetAvatar#
HTTP
POST /neo.platform.v1.AvatarService/SetAvatar
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Also callable with a scoped token: avatar.
Request: SetAvatarRequest. Response: Avatar.
Types#
Avatar#
| Field | Type | Description |
|---|---|---|
userId | string | |
specVersion | number | |
body | string | |
tints | object (map of string to string) | Per-part tints, "#rrggbb". |
wornItemIds | array of string | Worn item ids, in layer order. |
emotes | object (map of number to string) | Emote item ids by slot 1-8. |
updatedAt | string | |
base | string | The 3D base body, for example "mannequin". |
proportions | Proportions |
GetAvatarRequest#
| Field | Type | Description |
|---|---|---|
userId | string |
Proportions#
Body proportions as factors on the base body (1.0 = the base). The ranges keep animations planted and collision-free on every body: height 0.8-1.2, head 0.8-1.3, torso/arms/legs 0.85-1.15, shoulders 0.8-1.25, hips 0.85-1.2. 0 (unset) means 1.0.
| Field | Type | Description |
|---|---|---|
height | number | |
head | number | |
torso | number | |
arms | number | |
legs | number | |
shoulders | number | |
hips | number |
SetAvatarRequest#
| Field | Type | Description |
|---|---|---|
body | string | |
tints | object (map of string to string) | |
wornItemIds | array of string | |
emotes | object (map of number to string) | |
base | string | Empty keeps the current base; an absent proportions message keeps the current proportions, so the 2D web editor and the 3D editor can't clobber each other's fields. |
proportions | Proportions |