RTSDK
    Preparing search index...

    Interface WorldInterface

    interface WorldInterface {
        background?: null | string;
        controls?: {
            allowMuteAll?: boolean;
            disableHideVideo?: boolean;
            isMobileDisabled?: boolean;
            isShowingCurrentGuests?: boolean;
        };
        created?: object;
        credentials?: InteractiveCredentials;
        dataObject?: null
        | object;
        description?: string;
        enforceWhitelistOnLogin?: boolean;
        forceAuthOnLogin?: boolean;
        height?: number;
        heroImage?: string;
        jwt?: string;
        mapExists?: boolean;
        name?: string;
        redirectTo?: null | string;
        requestOptions: object;
        spawnPosition?: { x?: number; y?: number };
        tileBackgroundEverywhere?: null | boolean;
        topia: Topia;
        urlSlug: string;
        useTopiaPassword?: boolean;
        width?: number;
        dropScene(
            __namedParameters: {
                assetSuffix: string;
                position: object;
                sceneId: string;
            },
        ): Promise<object | ResponseType>;
        fetchDataObject(
            appPublicKey?: string,
            appJWT?: string,
            sharedAppPublicKey?: string,
            sharedAppJWT?: string,
        ): Promise<void | ResponseType>;
        fetchDetails(): Promise<void | ResponseType>;
        fetchDroppedAssets(): Promise<void | ResponseType>;
        fetchDroppedAssetsBySceneDropId(
            __namedParameters: { sceneDropId: string; uniqueName?: string },
        ): Promise<DroppedAsset[]>;
        fetchDroppedAssetsWithUniqueName(
            __namedParameters: {
                isPartial?: boolean;
                isReversed?: boolean;
                uniqueName: string;
            },
        ): Promise<DroppedAsset[]>;
        fetchLandmarkZones(
            landmarkZoneName?: string,
            sceneDropId?: string,
        ): Promise<DroppedAsset[]>;
        fetchSceneDropIds(): Promise<object | ResponseType>;
        fetchScenes(): Promise<object | ResponseType>;
        fetchWebhooks(): Promise<void | ResponseType>;
        fetchWorldAnalytics(
            __namedParameters: {
                dateValue: number;
                periodType: "week" | "month" | "quarter" | "year";
                year: number;
            },
        ): Promise<void | ResponseType>;
        fireToast(
            __namedParameters: FireToastInterface,
        ): Promise<void | ResponseType>;
        getAllParticles(): Promise<ResponseType>;
        incrementDataObjectValue(
            path: string,
            amount: number,
            options: object,
        ): Promise<void | ResponseType>;
        replaceScene(sceneId: string): Promise<void | ResponseType>;
        setDataObject(
            dataObject: undefined | null | object,
            options: object,
        ): Promise<void | ResponseType>;
        triggerActivity(
            __namedParameters: {
                assetId: string;
                excludeFromNotification?: (string | number)[];
                type: WorldActivityType;
            },
        ): Promise<string | ResponseType>;
        triggerParticle(
            __namedParameters: {
                duration?: number;
                id?: string;
                name?: string;
                position?: object;
            },
        ): Promise<string | ResponseType>;
        updateCloseWorldSettings(
            __namedParameters: {
                closeWorldDescription: string;
                isWorldClosed: boolean;
            },
        ): Promise<void | ResponseType>;
        updateCustomTextDroppedAssets(
            droppedAssetsToUpdate: DroppedAsset[],
            style: object,
        ): Promise<object>;
        updateDataObject(
            dataObject: object,
            options: object,
        ): Promise<void | ResponseType>;
        updateDetails(
            __namedParameters: WorldDetailsInterface,
        ): Promise<void | ResponseType>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    background? controls? created? credentials? dataObject? description? enforceWhitelistOnLogin? forceAuthOnLogin? height? heroImage? jwt? mapExists? name? redirectTo? requestOptions spawnPosition? tileBackgroundEverywhere? topia urlSlug useTopiaPassword? width?

    Methods

    dropScene fetchDataObject fetchDetails fetchDroppedAssets fetchDroppedAssetsBySceneDropId fetchDroppedAssetsWithUniqueName fetchLandmarkZones fetchSceneDropIds fetchScenes fetchWebhooks fetchWorldAnalytics fireToast getAllParticles incrementDataObjectValue replaceScene setDataObject triggerActivity triggerParticle updateCloseWorldSettings updateCustomTextDroppedAssets updateDataObject updateDetails

    Properties

    background?: null | string
    controls?: {
        allowMuteAll?: boolean;
        disableHideVideo?: boolean;
        isMobileDisabled?: boolean;
        isShowingCurrentGuests?: boolean;
    }
    created?: object
    credentials?: InteractiveCredentials
    dataObject?: null | object
    description?: string
    enforceWhitelistOnLogin?: boolean
    forceAuthOnLogin?: boolean
    height?: number
    heroImage?: string
    jwt?: string
    mapExists?: boolean
    name?: string
    redirectTo?: null | string
    requestOptions: object
    spawnPosition?: { x?: number; y?: number }
    tileBackgroundEverywhere?: null | boolean
    topia: Topia
    urlSlug: string
    useTopiaPassword?: boolean
    width?: number

    Methods

    • Parameters

      • __namedParameters: { assetSuffix: string; position: object; sceneId: string }

      Returns Promise<object | ResponseType>

    • Parameters

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

      Returns Promise<void | ResponseType>

    • Returns Promise<void | ResponseType>

    • Returns Promise<void | ResponseType>

    • Parameters

      • __namedParameters: { sceneDropId: string; uniqueName?: string }

      Returns Promise<DroppedAsset[]>

    • Parameters

      • __namedParameters: { isPartial?: boolean; isReversed?: boolean; uniqueName: string }

      Returns Promise<DroppedAsset[]>

    • Parameters

      • OptionallandmarkZoneName: string
      • OptionalsceneDropId: string

      Returns Promise<DroppedAsset[]>

    • Returns Promise<object | ResponseType>

    • Returns Promise<object | ResponseType>

    • Returns Promise<void | ResponseType>

    • Parameters

      • __namedParameters: {
            dateValue: number;
            periodType: "week" | "month" | "quarter" | "year";
            year: number;
        }

      Returns Promise<void | ResponseType>

    • Parameters

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

      Returns Promise<void | ResponseType>

    • Parameters

      • sceneId: string

      Returns Promise<void | ResponseType>

    • Parameters

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

      Returns Promise<void | ResponseType>

    • Parameters

      • __namedParameters: {
            assetId: string;
            excludeFromNotification?: (string | number)[];
            type: WorldActivityType;
        }

      Returns Promise<string | ResponseType>

    • Parameters

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

      Returns Promise<string | ResponseType>

    • Parameters

      • __namedParameters: { closeWorldDescription: string; isWorldClosed: boolean }

      Returns Promise<void | ResponseType>

    • Parameters

      Returns Promise<object>

    • Parameters

      • dataObject: object
      • options: object

      Returns Promise<void | ResponseType>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods