roavatar-renderer 1.2.5 → 1.2.6

package/README.md

@@ -23,7 +23,10 @@ Basic example on how to load an avatar, that is also untested:
     //actually creating renderer
     const includeScene = true
     const includeControls = true
-    await RBXRenderer.fullSetup(includeScene, includeControls)
+    const success = await RBXRenderer.fullSetup(includeScene, includeControls)
+    if (!success) {
+        //roavatar-renderer automatically displays an error, but your own behavior can be included here (like a fallback)
+    }
     //renderer customization
     RBXRenderer.setBackgroundColor( 0xffffff )
     RBXRenderer.setRendererSize(1000,500)

package/dist/index.d.ts

@@ -200,7 +200,7 @@ export declare const API: {
         idFromStr: (str: string) => number;
         parseAssetString: (str: string) => string;
         getCDNURLFromAssetDelivery: (url: string, headers?: any) => Promise<string | Response>;
-        assetURLToCDNURL: (url: string | number | bigint, headers?: any) => Promise<string | Response>;
+        assetURLToCDNURL: (url: string | number | bigint, headers?: any, extraStr?: string) => Promise<string | Response>;
     };
     Events: {
         OnLoadingAssets: Event_2;
@@ -223,6 +223,7 @@ export declare const API: {
         WearOutfit: (auth: Authentication, outfit: Outfit, onlyItems: boolean) => Promise<[boolean, boolean]>;
         SaveOutfitNoRetry: (auth: Authentication, outfit: Outfit) => Promise<Response>;
         GetAvatarDetails: (userId: number) => Promise<Response | Outfit>;
+        GetHeadShapes: (pageToken: string | null | undefined) => Promise<AvatarInventory_Result | Response>;
         GetAvatarInventory: (sortOption: string, pageToken: string | null | undefined, itemInfos?: ItemSort[]) => Promise<AvatarInventory_Result | Response>;
         GetOutfitDetails: (outfitId: number | string, userId: number) => Promise<Response | Outfit>;
         SaveOutfit: (auth: Authentication, outfit: Outfit) => Promise<Response>;
@@ -238,8 +239,8 @@ export declare const API: {
         SetThumbnailCustomization: (auth: Authentication, body: ThumbnailsCustomization_Payload) => Promise<Response>;
     };
     Asset: {
-        GetAssetBuffer: (url: string, headers?: HeadersInit) => Promise<Response | ArrayBuffer>;
-        GetRBX: (url: string, headers?: HeadersInit) => Promise<Response | RBX>;
+        GetAssetBuffer: (url: string, headers?: HeadersInit, extraStr?: string) => Promise<Response | ArrayBuffer>;
+        GetRBX: (url: string, headers?: HeadersInit, contentRepresentationPriorityList?: any) => Promise<Response | RBX>;
         GetMesh: (url: string, headers?: HeadersInit, readOnly?: boolean) => Promise<FileMesh | Response>;
         IsLayered: (id: number) => Promise<boolean | Response>;
     };
@@ -263,8 +264,8 @@ export declare const API: {
         GetUserInfo: () => Promise<UserInfo | undefined>;
     };
     Thumbnails: {
-        GetThumbnail: (auth: Authentication, type: string, id: number | string, size?: string) => Promise<string | undefined>;
-        UncacheThumbnail: (type: string, id: number | string, size?: string) => void;
+        GetThumbnail: (auth: Authentication, type: string, id: number | string, size?: string, headShape?: string) => Promise<string | undefined>;
+        UncacheThumbnail: (type: string, id: number | string, size?: string, headShape?: string) => void;
         RenderOutfit: (auth: Authentication, outfit: Outfit, attempt?: number) => Promise<string | undefined>;
     };
     LocalOutfit: {
@@ -315,7 +316,7 @@ export declare class AssetMeta {
     position?: VecXYZ;
     rotation?: VecXYZ;
     scale?: VecXYZ;
-    headShape?: number;
+    headShape?: string;
     staticFacialAnimation?: boolean;
     constructor();
     clone(): AssetMeta;
@@ -330,7 +331,7 @@ export declare type AssetMetaJson = {
     scale?: VecXYZ | Vecxyz | null;
     order?: number | null;
     puffiness?: number | null;
-    headShape?: "Invalid" | number;
+    headShape?: "Invalid" | string | number;
     staticFacialAnimation?: boolean;
 };
 
@@ -578,6 +579,7 @@ export declare interface BundleDetails_Result {
         name: string;
         owned: boolean;
         type: "Asset" | "UserOutfit";
+        supportsHeadShapes?: boolean;
     }[];
     collectibleItemId: string;
     creatorHasVerifiedBadge: boolean;
@@ -640,6 +642,8 @@ export declare class CFrame {
 
 export declare function clamp(v0: Vec3, lower: Vec3, higher: Vec3): Vec3;
 
+export declare function cleanString(inputString: string): string;
+
 export declare function clonePrimitiveArray<T>(arr: T[]): T[];
 
 export declare function cloneSearch_Payload(data: Search_Payload): Search_Payload;
@@ -1080,7 +1084,7 @@ declare class HSRAVIS {
     clone(): HSRAVIS;
 }
 
-declare type HumanoidDescriptionDiff = "scale" | "bodyColor" | "animation" | "bodyPart" | "clothing" | "face" | "accessory" | "makeup" | "gear";
+declare type HumanoidDescriptionDiff = "scale" | "bodyColor" | "animation" | "bodyPart" | "clothing" | "face" | "accessory" | "makeup" | "gear" | "staticFacialAnimation";
 
 export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
     static className: string;
@@ -1101,7 +1105,9 @@ export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
     getBodyPartDescription(bodyPart: number): Instance | undefined;
     getBodyPartColor(bodyPart: number): Color3;
     setBodyPartId(bodyPart: number, id: bigint): void;
+    setBodyPartHeadShape(bodyPart: number, headShape: string): void;
     getBodyPartId(bodyPart: number): bigint;
+    getBodyPartHeadShape(bodyPart: number): string;
     createRigData(): RigData | undefined;
     fromOutfit(outfit: Outfit): Promise<Instance | Response>;
     _applyScale(humanoid: Instance): void;
@@ -1273,6 +1279,7 @@ export declare interface ItemDetail_Result {
     name: string;
     offsaleDeadline: null;
     saleLocationType: SaleLocationType;
+    supportsHeadShapes?: boolean;
     taxonomy: {
         taxonomyId: string;
         taxonomyName: string;
@@ -1292,7 +1299,9 @@ export declare class ItemInfo {
     price?: number;
     limitedType?: "Limited" | "LimitedUnique";
     offsale?: boolean;
-    constructor(itemType: ItemType, type: string, id: number | string, name: string);
+    supportsHeadShapes?: boolean;
+    headShape?: string;
+    constructor(itemType: ItemType, type: string, id: number | string, name: string, supportsHeadShapes?: boolean);
 }
 
 export declare class ItemSort {
@@ -1341,7 +1350,7 @@ export declare class LocalOutfit {
     toJson(): LocalOutfitJson;
     fromJson(data: LocalOutfitJson): this;
     update(outfit: Outfit): void;
-    toOutfit(): Promise<Outfit>;
+    toOutfit(auth: Authentication): Promise<Outfit>;
 }
 
 export declare interface LocalOutfitJson {
@@ -1750,15 +1759,15 @@ export declare class Outfit {
     containsAssetType(assetType: string): boolean;
     removeAsset(assetId: number): void;
     removeAssetType(type: string | number): void;
-    addAsset(id: number, type: string | number, name: string): void;
+    addAsset(id: number, type: string | number, name: string, supportsHeadShapes?: boolean): void;
     fixOrders(): void;
     isOrderUsed(order: number, self?: Asset): boolean;
     getNextOrder(order: number): number;
-    addAssetId(assetId: number): Promise<boolean>;
+    addAssetId(assetId: number, auth: Authentication): Promise<boolean>;
     addBundleId(bundleId: number): Promise<boolean>;
     getAssetId(assetId: number): Asset | undefined;
-    fromLook(look: Look_Result["look"]): Promise<boolean>;
-    fromBuffer(buffer: ArrayBuffer): Promise<this>;
+    fromLook(look: Look_Result["look"], auth: Authentication): Promise<boolean>;
+    fromBuffer(buffer: ArrayBuffer, auth: Authentication): Promise<Response | Outfit>;
     toBuffer(): ArrayBuffer;
 }
 
@@ -2027,7 +2036,7 @@ export declare class RBXRenderer {
     static scene: THREE.Scene;
     static camera: THREE.PerspectiveCamera;
     static controls: OrbitControls | undefined;
-    static renderer: THREE.WebGLRenderer;
+    static renderer?: THREE.WebGLRenderer;
     static effectComposer: EffectComposer | undefined;
     static shadowEnabled: boolean;
     static shadowResolution: [number, number];
@@ -2043,9 +2052,16 @@ export declare class RBXRenderer {
     static ambientLight?: THREE.AmbientLight;
     static directionalLight?: THREE.DirectionalLight;
     static directionalLight2?: THREE.DirectionalLight;
+    static failedToCreate: boolean;
+    static error?: unknown;
     static boilerplateSetup(): Promise<void>;
-    /**Fully sets up renderer with scene, camera and frame rendering*/
-    static fullSetup(includeScene?: boolean, includeControls?: boolean): Promise<void>;
+    static showErrorHTML(): Promise<void>;
+    /**Fully sets up renderer with scene, camera and frame rendering
+     * @returns success
+     */
+    static fullSetup(includeScene?: boolean, includeControls?: boolean): Promise<boolean>;
+    /**Creates canvasContainer */
+    static createContainer(): void;
     /**Sets up the THREE.js renderer */
     static create(): void;
     /**Sets up a basic scene with lighting
@@ -2077,14 +2093,14 @@ export declare class RBXRenderer {
      * @deprecated Use getRendererElement instead which includes the loading icon
      * @returns The element for the renderer canvas
      */
-    static getRendererDom(): HTMLCanvasElement;
+    static getRendererDom(): HTMLCanvasElement | undefined;
     /**
      * @returns An element containing the renderer canvas
      */
     static getRendererElement(): HTMLDivElement;
     static getRendererCamera(): THREE.PerspectiveCamera;
     static getRendererControls(): OrbitControls | undefined;
-    static getRenderer(): THREE.WebGLRenderer;
+    static getRenderer(): THREE.WebGLRenderer | undefined;
     static getScene(): THREE.Scene;
     /**@deprecated
      * This function is unstable and can throw errors, but might work