Class AirshipAvatarSingleton

Access using Airship.Avatar. Avatar singleton provides utilities for working with visual elements of a character

Can be used to load outfits from the server

Index

Methods

LoadDefaultOutfit LoadOutfit

Methods

`Private` LoadDefaultOutfit

LoadDefaultOutfit(builder): void
Load a default outfit onto the character so they aren't naked
Parameters
- builder: AccessoryBuilder
  accessory builder for character
Returns void

LoadOutfit

LoadOutfit(builder, outfit, options?): Promise<void>
Load an outfit onto an accessory builder.

Note: if used on a character, this will not persist across respawns. If you're using a character, it's recommended to use character.LoadOutfit()
Parameters
- builder: AccessoryBuilder
  accessory builder for character
- outfit: SelectedOutfit
  outfit from server
- options: {
  removeOldClothingAccessories?: boolean;
  } = {}
  optional params
  - Optional removeOldClothingAccessories?: boolean
Returns Promise<void>