Variable APIConst

Type Declaration

• Asset: {
      GetAssetBuffer: (
          url: string,
          headers?: HeadersInit,
          extraStr?: string,
      ) => Promise<ArrayBuffer | Response>;
      GetAssetTypeId: (assetId: string | number) => Promise<number | Response>;
      GetMesh: (
          url: string,
          headers?: HeadersInit,
          readOnly?: boolean,
      ) => Promise<Response | FileMesh>;
      GetRBX: (
          url: string,
          headers?: HeadersInit,
          contentRepresentationPriorityList?: any,
      ) => Promise<Response | RBX>;
      IsLayered: (id: number) => Promise<boolean | Response>;
  }

  • GetAssetBuffer: (
        url: string,
        headers?: HeadersInit,
        extraStr?: string,
    ) => Promise<ArrayBuffer | Response>

  • GetAssetTypeId: (assetId: string | number) => Promise<number | Response>

  • GetMesh: (
        url: string,
        headers?: HeadersInit,
        readOnly?: boolean,
    ) => Promise<Response | FileMesh>

  • GetRBX: (
        url: string,
        headers?: HeadersInit,
        contentRepresentationPriorityList?: any,
    ) => Promise<Response | RBX>

    Remember to call .Destroy() on the Instance returned by RBX.generateTree() to avoid memory leaks

  • IsLayered: (id: number) => Promise<boolean | Response>

• Auth: { GetAuth: () => Promise<Authentication> }

• Avatar: {
      CreateOutfitModel: (
          auth: Authentication,
          model: OutfitModel,
      ) => Promise<Response>;
      DeleteOutfit: (
          auth: Authentication,
          outfitId: string | number,
      ) => Promise<Response>;
      EquipEmote: (
          auth: Authentication,
          assetId: string | number,
          slot: number,
      ) => Promise<Response>;
      GetAvatarDetails: (userId: number) => Promise<Response | Outfit>;
      GetAvatarInventory: (
          sortOption: string,
          pageToken: string | null | undefined,
          itemInfos?: ItemSort[],
      ) => Promise<Response | AvatarInventory_Result>;
      GetAvatarModel: () => Promise<Response | OutfitModel>;
      GetAvatarRules: () => Promise<Response>;
      GetEmotes: () => Promise<Response>;
      GetHeadShapes: (
          pageToken: string | null | undefined,
      ) => Promise<Response | AvatarInventory_Result>;
      GetOutfitDetails: (
          outfitId: string | number,
          userId: number,
      ) => Promise<Response | Outfit>;
      GetOutfitModel: (
          id: string | number,
          creatorId: number,
      ) => Promise<Response | OutfitModel>;
      GetThumbnailCustomizations: () => Promise<
          Response
          | ThumbnailCustomizations_Result,
      >;
      GetUserAvatarModel: (userId: number) => Promise<Response | OutfitModel>;
      GetUserOutfits: (
          userId: number,
      ) => Promise<Response | GetUserOutfits_Result>;
      PatchOutfit: (
          auth: Authentication,
          outfitId: string | number,
          patchData: any,
      ) => Promise<Response>;
      RedrawThumbnail: (auth: Authentication) => Promise<Response>;
      ResetThumbnailCustomization: (
          auth: Authentication,
          thumbnailType: number,
      ) => Promise<Response>;
      SaveOutfit: (auth: Authentication, outfit: Outfit) => Promise<Response>;
      SaveOutfitNoRetry: (
          auth: Authentication,
          outfit: Outfit,
      ) => Promise<Response>;
      SetThumbnailCustomization: (
          auth: Authentication,
          body: ThumbnailsCustomization_Payload,
      ) => Promise<Response>;
      UnequipEmote: (auth: Authentication, slot: number) => Promise<Response>;
      UpdateAvatarModel: (
          auth: Authentication,
          model: OutfitModel,
          updateTypes?: AvatarModelUpdateType[],
      ) => Promise<Response>;
      UpdateOutfit: (
          auth: Authentication,
          outfitId: string | number,
          newOutfit: Outfit,
      ) => Promise<Response>;
      UpdateOutfitModel: (
          auth: Authentication,
          model: OutfitModel,
          id: number,
          updateTypes?: AvatarModelUpdateType[],
      ) => Promise<Response>;
      WearOutfit: (
          auth: Authentication,
          outfit: Outfit,
          onlyItems: boolean,
      ) => Promise<[boolean, boolean]>;
  }

  • CreateOutfitModel: (auth: Authentication, model: OutfitModel) => Promise<Response>

  • DeleteOutfit: (auth: Authentication, outfitId: string | number) => Promise<Response>

  • EquipEmote: (
        auth: Authentication,
        assetId: string | number,
        slot: number,
    ) => Promise<Response>

  • GetAvatarDetails: (userId: number) => Promise<Response | Outfit>

  • GetAvatarInventory: (
        sortOption: string,
        pageToken: string | null | undefined,
        itemInfos?: ItemSort[],
    ) => Promise<Response | AvatarInventory_Result>

  • GetAvatarModel: () => Promise<Response | OutfitModel>

  • GetAvatarRules: () => Promise<Response>

  • GetEmotes: () => Promise<Response>

  • GetHeadShapes: (
        pageToken: string | null | undefined,
    ) => Promise<Response | AvatarInventory_Result>

  • GetOutfitDetails: (outfitId: string | number, userId: number) => Promise<Response | Outfit>

    Deprecated

    Use GetOutfitModel instead

  • GetOutfitModel: (id: string | number, creatorId: number) => Promise<Response | OutfitModel>

  • GetThumbnailCustomizations: () => Promise<Response | ThumbnailCustomizations_Result>

  • GetUserAvatarModel: (userId: number) => Promise<Response | OutfitModel>

  • GetUserOutfits: (userId: number) => Promise<Response | GetUserOutfits_Result>

  • PatchOutfit: (
        auth: Authentication,
        outfitId: string | number,
        patchData: any,
    ) => Promise<Response>

    Deprecated

    Use UpdateOutfitModel instead

  • RedrawThumbnail: (auth: Authentication) => Promise<Response>

  • ResetThumbnailCustomization: (auth: Authentication, thumbnailType: number) => Promise<Response>

  • SaveOutfit: (auth: Authentication, outfit: Outfit) => Promise<Response>

    Deprecated

    Use CreateOutfitModel instead

  • SaveOutfitNoRetry: (auth: Authentication, outfit: Outfit) => Promise<Response>

  • SetThumbnailCustomization: (
        auth: Authentication,
        body: ThumbnailsCustomization_Payload,
    ) => Promise<Response>

  • UnequipEmote: (auth: Authentication, slot: number) => Promise<Response>

  • UpdateAvatarModel: (
        auth: Authentication,
        model: OutfitModel,
        updateTypes?: AvatarModelUpdateType[],
    ) => Promise<Response>

  • UpdateOutfit: (
        auth: Authentication,
        outfitId: string | number,
        newOutfit: Outfit,
    ) => Promise<Response>

    Deprecated

    Use UpdateOutfitModel instead

  • UpdateOutfitModel: (
        auth: Authentication,
        model: OutfitModel,
        id: number,
        updateTypes?: AvatarModelUpdateType[],
    ) => Promise<Response>

  • WearOutfit: (
        auth: Authentication,
        outfit: Outfit,
        onlyItems: boolean,
    ) => Promise<[boolean, boolean]>

• Catalog: {
      GetBundleDetails: (
          bundleId: string | number,
      ) => Promise<Response | BundleDetails_Result>;
      GetItemDetails: (
          auth: Authentication,
          items: { id: number; itemType: "Asset" | "Bundle" }[],
      ) => Promise<Response | ItemDetails_Result>;
      GetMarketplaceWidgets: (
          context?: string,
      ) => Promise<Response | MarketplaceWidgets_Result>;
      GetMarketplaceWidgetsSearch: (
          query: string,
      ) => Promise<Response | MarketplaceWidgets_Result>;
      GetNavigationMenuItems: () => Promise<Response | NavigationMenuItems>;
      GetTopics: (
          auth: Authentication,
          body: GetTopics_Payload,
      ) => Promise<Response | GetTopics_Result>;
      Search: (
          __namedParameters: Search_Payload,
          cursor?: string,
      ) => Promise<Response | Search_Result>;
  }

• Develop: {
      GetLatestVersions: (
          auth: Authentication,
          assetIds: number[],
      ) => Promise<Response | LatestVersions_Result>;
  }

• Economy: { GetAssetDetails: (assetId: number) => Promise<Response> }

• Events: { OnLoadingAssets: Event }

• Generic: {
      GetBrowser: () => RoAvatarBrowser;
      GetManifestVersion: () => string;
      GetRoAvatarData: () => Promise<Response | RoAvatarData | undefined>;
      IsDevMode: () => boolean;
      JoinPlace: (placeId: number) => void;
      LoadImage: (url: string) => Promise<HTMLImageElement | undefined>;
  }

• Inventory: {
      GetInventory: (
          userId: number,
          assetType: number,
          cursor?: string,
      ) => Promise<Response>;
      IsItemOwned: (
          userId: number,
          itemType: string,
          assetId: number,
      ) => Promise<any>;
  }

• LocalOutfit: {
      GetLocalOutfits: () => Promise<LocalOutfit[]>;
      SetLocalOutfits: (localOutfits: LocalOutfit[]) => Promise<undefined>;
  }

• Looks: {
      CreateLook: (
          auth: Authentication,
          outfit: Outfit,
          name: string,
          description: string,
      ) => Promise<Response>;
      DeleteLook: (auth: Authentication, lookId: string) => Promise<Response>;
      GetLook: (lookId: string) => Promise<Response | Look_Result>;
      GetUserLooks: (
          userId: number,
          cursor?: string,
      ) => Promise<Response | UserLooks_Result>;
  }

• Misc: {
      assetURLToCDNURL: (
          url: string | number | bigint,
          headers?: any,
          extraStr?: string,
      ) => Promise<string | Response>;
      getCDNURLFromAssetDelivery: (
          url: string,
          headers?: any,
      ) => Promise<string | Response>;
      getCurrentlyLoading: () => boolean;
      getCurrentlyLoadingLabels: () => string[];
      idFromStr: (str: string) => number;
      parseAssetString: (str: string) => string;
      startCurrentlyLoadingAssets: (label: string) => void;
      stopCurrentlyLoadingAssets: (label: string) => void;
  }

• PremiumFeatures: {
      GetSubscription: (
          userId: number,
      ) => Promise<Response | GetSubscription_Result>;
  }

• RBLXDelete: (
      url: string,
      auth: Authentication,
      body: any,
      attempt?: number,
  ) => Promise<Response>

• RBLXGet: (
      url: string,
      headers?: any,
      includeCredentials?: boolean,
      attempt?: number,
  ) => Promise<Response>

• RBLXPatch: (
      url: string,
      auth: Authentication,
      body: any,
      attempt?: number,
  ) => Promise<Response>

• RBLXPost: (
      url: string,
      auth: Authentication | undefined,
      body: any,
      attempt?: number,
      method?: string,
  ) => Promise<Response>

• Subscriptions: { HasPlus: () => Promise<boolean | Response> }

• Thumbnails: {
      GetThumbnail: (
          auth: Authentication,
          type: string,
          id: string | number,
          size?: string,
          headShape?: string,
      ) => Promise<string | undefined>;
      RenderOutfit: (
          auth: Authentication,
          outfit: Outfit,
          size?: string,
          thumbnailType?: string,
          attempt?: number,
      ) => Promise<string | undefined>;
      UncacheThumbnail: (
          type: string,
          id: string | number,
          size?: string,
          headShape?: string,
      ) => void;
  }

• Users: {
      GetIdsFromUsernames: (usernames: string[]) => Promise<any>;
      GetInfoForId: (userId: number) => Promise<Response | GetInfoForId_Result>;
      GetUserInfo: () => Promise<UserInfo | undefined>;
      UserOmniSearch: (
          query: string,
          cursor?: string,
      ) => Promise<Response | UserOmniSearch_Result>;
  }