Interface MutableAvatarProvider

Provider for custom mannequins. The methods defined by this interface are used to store the data for the avatar. How you store the data is completely up to you.

interface MutableAvatarProvider {
    deleteById(id: ReferenceData): Awaitable<void>;
    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>;
    setGender(id: ReferenceData, gender: Gender): Awaitable<void>;
    setName(id: ReferenceData, name: string): Awaitable<void>;
    setThumbnail(id: ReferenceData, thumbnail: string): Awaitable<void>;
    storeById(id: ReferenceData, asset: AssetInfo): Awaitable<void>;
}

Hierarchy (view full)

AvatarProvider
- MutableAvatarProvider

Implemented by

LocalCustomAvatars

Index

Methods

deleteById getById getGender getIds getName getThumbnail setGender setName setThumbnail storeById

Methods

deleteById

deleteById(id): Awaitable<void>
Deletes the avatar with the given id
Parameters
- id: ReferenceData
  Unique ID auf the avatar
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:135

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 AvatarProvider.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>
Inherited from AvatarProvider.getGender
- 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 AvatarProvider.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>
Inherited from AvatarProvider.getName
- 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>
Inherited from AvatarProvider.getThumbnail
- Defined in packages/public-types/src/mdrc.ts:92

setGender

setGender(id, gender): Awaitable<void>
Sets the gender of the avatar with the given ID.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- gender: Gender
  Genderof the avatar
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:153

setName

setName(id, name): Awaitable<void>
Sets the name for the avatar with the given ID.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- name: string
  Name of the avatar
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:147

setThumbnail

setThumbnail(id, thumbnail): Awaitable<void>
Sets the thumbnail for the avatar encoded as base64 string.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- thumbnail: string
  Thumbnail png in base64 format
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:159

storeById

storeById(id, asset): Awaitable<void>
Stores the avatar's assets persistently for the given ID. How you actually store them is up to you.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- asset: AssetInfo
  Asset container object
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:141

Interface MutableAvatarProvider

Hierarchy (view full)

Implemented by

Index

Methods

Methods

deleteById

Parameters

Returns Awaitable<void>

getById

Parameters

Returns Awaitable<undefined | AssetInfo>

getGender

Parameters

Returns Awaitable<undefined | Gender>

getIds

Returns Awaitable<ReferenceData[]>

getName

Parameters

Returns Awaitable<undefined | string>

getThumbnail

Parameters

Returns Awaitable<undefined | string>

setGender

Parameters

Returns Awaitable<void>

setName

Parameters

Returns Awaitable<void>

setThumbnail

Parameters

Returns Awaitable<void>

storeById

Parameters

Returns Awaitable<void>

Settings

On This Page