Interface IAnimationService

Service interface for managing VRM animations

interface IAnimationService {
    clearCache(): void;
    getAvailableAnimations(avatarId: string): Promise<VRMAnimation[]>;
    getDefaultAnimations(): VRMAnimation[];
    loadAnimation(animationId: string): Promise<VRMAnimation>;
    setCurrentAvatarId(avatarId: string): void;
    validateAnimation(animationId: string): Promise<boolean>;
}

Index

Methods

clearCache getAvailableAnimations getDefaultAnimations loadAnimation setCurrentAvatarId validateAnimation

Methods

clearCache

clearCache(): void
Clear animation cache

Returns void
- Defined in packages/core/src/interfaces/IAnimationService.ts:38

getAvailableAnimations

getAvailableAnimations(avatarId: string): Promise<VRMAnimation[]>
Get available animations for an avatar
Parameters
- avatarId: string
  The avatar ID
Returns Promise<VRMAnimation[]>
Promise resolving to array of available animations
- Defined in packages/core/src/interfaces/IAnimationService.ts:13

getDefaultAnimations

getDefaultAnimations(): VRMAnimation[]
Get default animations (presets)

Returns VRMAnimation[]
Array of preset animations
- Defined in packages/core/src/interfaces/IAnimationService.ts:33

loadAnimation

loadAnimation(animationId: string): Promise<VRMAnimation>
Load animation data from the current avatar's available animations
Parameters
- animationId: string
  The animation ID
Returns Promise<VRMAnimation>
Promise resolving to animation data
- Defined in packages/core/src/interfaces/IAnimationService.ts:20

setCurrentAvatarId

setCurrentAvatarId(avatarId: string): void
Set current avatar ID for animation lookup and validation
Parameters
- avatarId: string
  The avatar ID
Returns void
- Defined in packages/core/src/interfaces/IAnimationService.ts:44

validateAnimation

validateAnimation(animationId: string): Promise<boolean>
Validate if animation is available for the current avatar
Parameters
- animationId: string
  The animation ID
Returns Promise<boolean>
Promise resolving to boolean
- Defined in packages/core/src/interfaces/IAnimationService.ts:27