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

    Interface IAvatarController

    interface IAvatarController {
        destroy(): Promise<void>;
        getCurrentAnimation(): string | null;
        getState(): AvatarState | null;
        move(position: Position): Promise<void>;
        playAnimation(
            animationId: string,
            options?: AnimationPlayOptions,
        ): Promise<AnimationPlaybackResult>;
        resyncAvatar(): Promise<void>;
        rotate(rotation: Rotation): Promise<void>;
        spawn(
            avatarId: string,
            position?: Position,
            avatarSrc?: string,
        ): Promise<void>;
        stopAnimation(): Promise<void>;
        updateState(state: Partial<AvatarState>): Promise<void>;
    }
    Index
    destroy getCurrentAnimation getState move playAnimation resyncAvatar rotate spawn stopAnimation updateState

    • Returns Promise<void>

    • Get current animation ID

      Returns string | null

      Current animation ID or null

    • Returns AvatarState | null

    • Parameters

      Returns Promise<void>

    • Play an animation on the avatar

      Parameters

      • animationId: string

        A preset ID or an ID returned for the current avatar

      • Optionaloptions: AnimationPlayOptions

        Animation playback options

      Returns Promise<AnimationPlaybackResult>

      Promise resolving to playback result

    • Resync avatar state for newly joined users Sends the complete avatar state with isFirstSync flag

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • avatarId: string
      • Optionalposition: Position
      • OptionalavatarSrc: string

      Returns Promise<void>

    • Stop current animation

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods