metatell Bot SDK - v2.0.0
    Preparing search index...

    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
    clearCache getAvailableAnimations getDefaultAnimations loadAnimation setCurrentAvatarId validateAnimation

    • Clear animation cache

      Returns void

    • Get available animations for an avatar

      Parameters

      • avatarId: string

        The avatar ID

      Returns Promise<VRMAnimation[]>

      Promise resolving to array of available animations

    • Get default animations (presets)

      Returns VRMAnimation[]

      Array of preset animations

    • Load animation data from the current avatar's available animations

      Parameters

      • animationId: string

        The animation ID

      Returns Promise<VRMAnimation>

      Promise resolving to animation data

    • Set current avatar ID for animation lookup and validation

      Parameters

      • avatarId: string

        The avatar ID

      Returns void

    • Validate if animation is available for the current avatar

      Parameters

      • animationId: string

        The animation ID

      Returns Promise<boolean>

      Promise resolving to boolean

    Settings
    Member Visibility

    On This Page
    Methods