Metatell AI Bot - v0.0.10
    Preparing search index...

    Interface AgentClient

    interface AgentClient {
        connect(options: ConnectionOptions): Promise<void>;
        disconnect(): Promise<void>;
        getAvailableAnimations(): Promise<VRMAnimation[]>;
        getCurrentAnimation(): null | string;
        getRateLimit(key: "messages" | "moves" | "looks"): undefined | number;
        getStatus(): ConnectionStatus;
        getUser(id: string): undefined | UserAvatar;
        getUsers(): UserAvatar[];
        getUsersNearby(radius: number): UserAvatar[];
        isVoiceMuted(): boolean;
        join(room: string): Promise<void>;
        leave(): Promise<void>;
        look(
            target: { x: number; y: number; z: number } | { userId: string },
        ): Promise<void>;
        lookAtNearest(): Promise<void>;
        move(position: { x: number; y: number; z: number }): Promise<void>;
        muteVoice(muted: boolean): Promise<void>;
        off<E extends keyof AgentClientEvents>(
            event: E,
            handler: AgentClientEvents[E],
        ): this;
        on<E extends keyof AgentClientEvents>(
            event: E,
            handler: AgentClientEvents[E],
        ): this;
        playAnimation(
            animationId: string,
            options?: AnimationPlayOptions,
        ): Promise<AnimationPlaybackResult>;
        send(message: string): Promise<void>;
        sendVoiceFrame(pcmData: Int16Array): Promise<void>;
        setRateLimit(key: "messages" | "moves" | "looks", perSecond: number): void;
        stopAnimation(): Promise<void>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • target: { x: number; y: number; z: number } | { userId: string }

      Returns Promise<void>

    • Parameters

      • key: "messages" | "moves" | "looks"
      • perSecond: number

      Returns void