Interface AvatarProvider

Provides information & assets for the avatars available in the dressing room.

interface AvatarProvider {
    getById(id: ReferenceData): Awaitable<undefined | AssetInfo>;
    getGender(id: ReferenceData): Awaitable<undefined | Gender>;
    getIds(): Awaitable<ReferenceData[]>;
    getName(id: ReferenceData): Awaitable<undefined | string>;
    getThumbnail(id: ReferenceData): Awaitable<undefined | string>;
}

Hierarchy (view full)

AssetProvider
- AvatarProvider
  - MutableAvatarProvider

Index

Methods

getById getGender getIds getName getThumbnail

Methods

getById

getById(id): Awaitable<undefined | AssetInfo>
Returns the asset bundle for a specific resource
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Awaitable<undefined | AssetInfo>
Inherited from AssetProvider.getById
- Defined in packages/public-types/src/mdrc.ts:41

getGender

getGender(id): Awaitable<undefined | Gender>
Returns the gender of an avatar as enum.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Awaitable<undefined | Gender>
- Defined in packages/public-types/src/mdrc.ts:97

getIds

getIds(): Awaitable<ReferenceData[]>
Returns a list of ids for the available resources for this provider.

Returns Awaitable<ReferenceData[]>
Inherited from AssetProvider.getIds
- Defined in packages/public-types/src/mdrc.ts:36

getName

getName(id): Awaitable<undefined | string>
Returns the display name of the avatar as string. This will be shown in the avatar selection drawer.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:86

getThumbnail

getThumbnail(id): Awaitable<undefined | string>
Returns an url to the thumbail image of the avatar. This will be shown in the avater selection drawer. Thumbnails should ideally be square.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:92