roavatar-renderer 1.6.4 → 1.6.6

package/README.md

@@ -17,7 +17,7 @@ Basic example on how to load an avatar using OutfitRenderer (to make it simpler)
 **TYPESCRIPT:**
 ```ts
 //setup flags that are compatible with you environment
-    FLAGS.FETCH_FUNC = undefined //undefined is the default fetch() function, this flag can be used to intercept requests
+    FLAGS.FETCH_FUNC = undefined //undefined is the default fetch() function, this flag can be used to intercept requests (though make sure to keep request headers)
     FLAGS.ONLINE_ASSETS = true //set true to false if you want assets to be loaded locally
 
     //if we arent using online assets we have to provide the renderer with the paths
@@ -60,5 +60,8 @@ if (!(outfitModel instanceof OutfitModel)) throw new Error("Failed to get outfit
 **RESULT:**
 <img src="https://devforum-uploads.s3.dualstack.us-east-2.amazonaws.com/uploads/original/5X/9/f/a/d/9fadf25d9770b63e8a2e480369930cad94ad04aa.png">
 
-For more examples check out the OutfitRenderer, BackgroundRenderer, RoAvatar (avatarPreview.tsx) or RoValra (ItemRender.ts) source code
+For more code examples check out the OutfitRenderer, BackgroundRenderer, RoAvatar (avatarPreview.tsx) or RoValra (ItemRender.ts) source code
+
+For a live renderer example on a website check out https://roavatar.net
+
 There is also a discord server you can ask for help in: https://discord.gg/PHa5Vgtbva

package/dist/index.d.ts

@@ -598,7 +598,7 @@ export declare class Authentication {
     getSessionUUID(): string;
 }
 
-declare interface AvatarConfigurations {
+export declare interface AvatarConfigurations {
     emotes?: {
         assetId: number;
         assetName: string;
@@ -1579,7 +1579,7 @@ export declare const FLAGS: {
     INCLUDE_REQUEST_CREDENTIALS_OVERRIDE: RequestCredentials;
     /**if requests should be retried once after failing */
     API_REQUEST_RETRY: boolean;
-    /**the fetch function the api will use */
+    /**the fetch function the api will use, make sure it doesnt ignore request headers */
     FETCH_FUNC: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>) | undefined;
     /**a function all image urls will go through before being loaded, the return value is the new image url */
     IMAGE_FUNC: ((input: string) => Promise<string>) | undefined;
@@ -2026,7 +2026,7 @@ export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
     getAccessoryIds(): bigint[];
     getAccessoryDescriptionWithId(id: bigint): Instance | undefined;
     getBodyPartDescription(bodyPart: number): Instance | undefined;
-    getBodyPartColor(bodyPart: number): Color3;
+    getBodyPartColor(bodyPart: number): Color3 | undefined;
     setBodyPartId(bodyPart: number, id: bigint): void;
     setBodyPartHeadShape(bodyPart: number, headShape: string): void;
     getBodyPartId(bodyPart: number): bigint;
@@ -2940,6 +2940,7 @@ export declare class Outfit {
     toJson(removeNotOwnedAssets?: boolean): OutfitJson;
     toCleanJson(removeNotOwnedAssets?: boolean): OutfitJson;
     toCleanJsonV4(removeNotOwnedAssets?: boolean): OutfitJson;
+    toMinimalJson(): OutfitJson;
     fromJson(outfitJson: OutfitJson): void;
     /**
      * @deprecated Incorrect, use getValidationIssues() instead
@@ -3006,6 +3007,7 @@ export declare class OutfitModel {
     thumbnailCustomizations?: ThumbnailCustomization[];
     profileFrame: undefined;
     fromJson(outfitModel: AvatarModel_Result | OutfitModel_Result): OutfitModel;
+    toOutfitModelJson(): OutfitModel_Result;
     clone(): OutfitModel;
 }
 
@@ -3678,12 +3680,12 @@ declare class RenderDesc extends DisposableDesc {
     compiled: boolean;
     failed: boolean;
     constructor(renderScene: RBXRendererScene);
-    isSame(_other: RenderDesc): boolean;
-    needsRegeneration(_other: RenderDesc): boolean;
-    fromRenderDesc(other: RenderDesc): void;
-    transferFrom(other: RenderDesc): void;
-    virtualTransferFrom(_other: RenderDesc): void;
-    virtualFromRenderDesc(_other: RenderDesc): void;
+    isSame(_newDesc: RenderDesc): boolean;
+    needsRegeneration(_newDesc: RenderDesc): boolean;
+    fromRenderDesc(newDesc: RenderDesc): void;
+    transferFrom(oldDesc: RenderDesc): void;
+    virtualTransferFrom(_oldDesc: RenderDesc): void;
+    virtualFromRenderDesc(_newDesc: RenderDesc): void;
     fromInstance(_child: Instance): void;
     compileResults(_renderer: THREE.WebGLRenderer, _scene: THREE.Scene): Promise<THREE.Object3D[] | Response | undefined>;
     updateResults(): void;