RTSDK
    Preparing search index...

    Interface VisitorInterface

    interface VisitorInterface {
        color?: string;
        credentials?: InteractiveCredentials;
        dataObject?: null | object;
        displayName?: string;
        gestureType?: number;
        hidden?: boolean;
        id?: number;
        inventoryItems: UserInventoryItem[];
        isAdmin?: boolean;
        isBackground?: boolean;
        isMobile?: boolean;
        isRecording?: boolean;
        isRecordingBot?: boolean;
        jwt?: string;
        landmarkZonesString?: string;
        lastUpdate?: number;
        movedOn?: number;
        moveFrom?: object;
        moveTo?: { x?: number; y?: number };
        muted?: boolean;
        performer?: boolean;
        performerNear?: boolean;
        privateZoneId?: string;
        requestOptions: object;
        shareScreen?: boolean;
        sitting?: boolean;
        topia: Topia;
        urlSlug: string;
        username?: string;
        closeIframe(droppedAssetId: string): Promise<void | ResponseType>;
        createNpc(
            userInventoryItemId: string,
            options?: { showNameplate?: boolean },
        ): Promise<Visitor>;
        deleteNpc(): Promise<void>;
        fetchDataObject(
            appPublicKey?: string,
            appJWT?: string,
            sharedAppPublicKey?: string,
            sharedAppJWT?: string,
        ): Promise<void | ResponseType>;
        fetchInventoryItem(
            item: InventoryItemInterface,
        ): Promise<UserInventoryItem>;
        fetchInventoryItems(): Promise<void>;
        fetchVisitor(): Promise<void | ResponseType>;
        fireToast(
            __namedParameters: FireToastInterface,
        ): Promise<void | ResponseType>;
        getAllParticles(): Promise<ResponseType>;
        getExpressions(
            __namedParameters: { getUnlockablesOnly?: boolean; name?: string },
        ): Promise<ResponseType>;
        getNpc(): Promise<null | Visitor>;
        grantExpression(
            __namedParameters: { id?: string; name?: string },
        ): Promise<ResponseType>;
        grantInventoryItem(
            item: InventoryItemInterface,
            quantity: number,
        ): Promise<UserInventoryItem>;
        incrementDataObjectValue(
            path: string,
            amount: number,
            options: object,
        ): Promise<void | ResponseType>;
        modifyInventoryItemQuantity(
            item: UserInventoryItemInterface | InventoryItemInterface,
            quantity: number,
        ): Promise<UserInventoryItem>;
        moveVisitor(
            __namedParameters: MoveVisitorInterface,
        ): Promise<void | ResponseType>;
        openIframe(
            __namedParameters: OpenIframeInterface,
        ): Promise<void | ResponseType>;
        reloadIframe(droppedAssetId: string): Promise<void | ResponseType>;
        sendSignalToVisitor(
            signal: any,
        ): Promise<void | ResponseType & { answerSignal: any }>;
        setDataObject(
            dataObject: undefined | null | object,
            options: object,
        ): Promise<void | ResponseType>;
        triggerParticle(
            __namedParameters: { duration?: number; id?: string; name?: string },
        ): Promise<string | ResponseType>;
        turnAVOff(): Promise<void | ResponseType>;
        updateDataObject(
            dataObject: object,
            options: object,
        ): Promise<void | ResponseType>;
        updatePublicKeyAnalytics(
            analytics?: AnalyticType[],
        ): Promise<void | ResponseType>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    color? credentials? dataObject? displayName? gestureType? hidden? id? inventoryItems isAdmin? isBackground? isMobile? isRecording? isRecordingBot? jwt? landmarkZonesString? lastUpdate? movedOn? moveFrom? moveTo? muted? performer? performerNear? privateZoneId? requestOptions shareScreen? sitting? topia urlSlug username?

    Methods

    closeIframe createNpc deleteNpc fetchDataObject fetchInventoryItem fetchInventoryItems fetchVisitor fireToast getAllParticles getExpressions getNpc grantExpression grantInventoryItem incrementDataObjectValue modifyInventoryItemQuantity moveVisitor openIframe reloadIframe sendSignalToVisitor setDataObject triggerParticle turnAVOff updateDataObject updatePublicKeyAnalytics

    Properties

    color?: string
    credentials?: InteractiveCredentials
    dataObject?: null | object
    displayName?: string
    gestureType?: number
    hidden?: boolean
    id?: number
    inventoryItems: UserInventoryItem[]
    isAdmin?: boolean
    isBackground?: boolean
    isMobile?: boolean
    isRecording?: boolean
    isRecordingBot?: boolean
    jwt?: string
    landmarkZonesString?: string
    lastUpdate?: number
    movedOn?: number
    moveFrom?: object
    moveTo?: { x?: number; y?: number }
    muted?: boolean
    performer?: boolean
    performerNear?: boolean
    privateZoneId?: string
    requestOptions: object
    shareScreen?: boolean
    sitting?: boolean
    topia: Topia
    urlSlug: string
    username?: string

    Methods

    • Parameters

      • droppedAssetId: string

      Returns Promise<void | ResponseType>

    • Parameters

      • userInventoryItemId: string
      • Optionaloptions: { showNameplate?: boolean }

      Returns Promise<Visitor>

    • Returns Promise<void>

    • Parameters

      • OptionalappPublicKey: string
      • OptionalappJWT: string
      • OptionalsharedAppPublicKey: string
      • OptionalsharedAppJWT: string

      Returns Promise<void | ResponseType>

    • Returns Promise<void>

    • Returns Promise<void | ResponseType>

    • Parameters

      • __namedParameters: { getUnlockablesOnly?: boolean; name?: string }

      Returns Promise<ResponseType>

    • Returns Promise<null | Visitor>

    • Parameters

      • __namedParameters: { id?: string; name?: string }

      Returns Promise<ResponseType>

    • Parameters

      • path: string
      • amount: number
      • options: object

      Returns Promise<void | ResponseType>

    • Parameters

      • droppedAssetId: string

      Returns Promise<void | ResponseType>

    • Parameters

      • signal: any

      Returns Promise<void | ResponseType & { answerSignal: any }>

    • Parameters

      • dataObject: undefined | null | object
      • options: object

      Returns Promise<void | ResponseType>

    • Parameters

      • __namedParameters: { duration?: number; id?: string; name?: string }

      Returns Promise<string | ResponseType>

    • Returns Promise<void | ResponseType>

    • Parameters

      • dataObject: object
      • options: object

      Returns Promise<void | ResponseType>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods