Documentation / scene / AvatarWardrobe

Class: AvatarWardrobe

Defined in: libs/scene/src/avatar/wardrobe.ts:133

High level avatar outfit controller.

The wardrobe keeps one avatar SkeletonRig as the animation source and binds equipped clothing meshes to that rig with new SkinBindings.

Extends

• Disposable

Constructors

Constructor

new AvatarWardrobe(options): AvatarWardrobe

Defined in: libs/scene/src/avatar/wardrobe.ts:143

Parameters

options

AvatarWardrobeOptions

Returns

AvatarWardrobe

Overrides

Disposable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6107

Returns

boolean

Inherited from

Disposable.disposed

---

root

Get Signature

get root(): SceneNode

Defined in: libs/scene/src/avatar/wardrobe.ts:166

Returns

SceneNode

---

rig

Get Signature

get rig(): SkeletonRig

Defined in: libs/scene/src/avatar/wardrobe.ts:170

Returns

SkeletonRig

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:630

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:634

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:638

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

Disposable.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:642

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

Disposable.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6108

Returns

void

Inherited from

Disposable.dispose

---

from()

static from(root, options?): AvatarWardrobe

Defined in: libs/scene/src/avatar/wardrobe.ts:162

Parameters

root

SceneNode

options?

Omit<AvatarWardrobeOptions, "root">

Returns

AvatarWardrobe

---

getEquipped()

getEquipped(slot?): AvatarOutfitInstance[]

Defined in: libs/scene/src/avatar/wardrobe.ts:174

Parameters

slot?

string

Returns

AvatarOutfitInstance[]

---

equip()

equip(source, options?): Promise<AvatarOutfitInstance>

Defined in: libs/scene/src/avatar/wardrobe.ts:181

Parameters

source

AvatarOutfitSource

options?

AvatarEquipOptions

Returns

Promise<AvatarOutfitInstance>

---

unequip()

unequip(slotOrInstance): void

Defined in: libs/scene/src/avatar/wardrobe.ts:255

Parameters

slotOrInstance

string | AvatarOutfitInstance

Returns

void

---

clear()

clear(): void

Defined in: libs/scene/src/avatar/wardrobe.ts:265

Returns

void

---

validateOutfit()

validateOutfit(source, options?): AvatarOutfitValidation

Defined in: libs/scene/src/avatar/wardrobe.ts:271

Parameters

source

SceneNode

options?

AvatarEquipOptions

Returns

AvatarOutfitValidation

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/avatar/wardrobe.ts:336

Returns

void

Overrides

Disposable.onDispose