roavatar-renderer 1.5.11 → 1.5.13

package/dist/index.d.ts

@@ -341,6 +341,7 @@ export declare const API: {
          */
         GetRBX: (url: string, headers?: HeadersInit, contentRepresentationPriorityList?: any) => Promise<Response | RBX>;
         GetMesh: (url: string, headers?: HeadersInit, readOnly?: boolean) => Promise<FileMesh | Response>;
+        GetAssetTypeId: (assetId: string | number) => Promise<number | Response>;
         IsLayered: (id: number) => Promise<boolean | Response>;
     };
     Catalog: {
@@ -1439,12 +1440,16 @@ export declare const FLAGS: {
     AUTO_RESTORE_CONTEXT: boolean;
     /**RenderTarget textures are converted to CanvasTextures which can be exported */
     RENDERTARGET_TO_CANVASTEXTURE: boolean;
-    /**Amount of time thumbnail generator will wait after no assets are being loaded to resolve, should be a little time at least so particles can render */
+    /**Amount of time thumbnail generator will wait after no assets are being loaded to resolve, should be a little time at least so particles can render OR just set PARTICLES_START_FULL = true */
     THUMBNAIL_TIMEOUT: number;
     /**Always render attachments even when theyre set to not be visible */
     ALWAYS_SHOW_ATTACHMENTS: boolean;
     /**Multiplier for delta time used by renderer things (does not affect datamodel side of things but particles and such instead) */
     RENDERER_DELTA_TIME_MULTIPLIER: number;
+    /**How many seconds particles will presimulate (mainly so they arent incomplete in thumbnail generations) */
+    PARTICLES_START_FULL: number;
+    /**Framerate of presimulation particles */
+    PARTICLES_START_FULL_FRAMERATE: number;
     /**shows ThreeJS SkeletonHelper */
     SHOW_SKELETON_HELPER: boolean;
     /**if set the skeleton helper will only show if the instance has the name */
@@ -1565,9 +1570,12 @@ export declare function generateModelThumbnail(auth: Authentication, renderScene
  * **Example on generating 1000x1000 webp thumbnail for blank outfit**
  * ```ts
  * const outfit = new Outfit()
+ * FLAGS.THUMBNAIL_TIMEOUT = 1 //makes thumbnail generation faster
+ * FLAGS.PARTICLES_START_FULL = 10 //makes emitters appear as if theyve been there for some time (10 seconds)
  * FLAGS.RENDERTARGET_TO_CANVASTEXTURE = true //required for gltf export
  * const result = await generateOutfitThumbnail(new Authentication(), outfit, [1000,1000], "webp", 0.99)
  * FLAGS.RENDERTARGET_TO_CANVASTEXTURE = false
+ * FLAGS.PARTICLES_START_FULL = 0
  * console.log(result)
  * ```
  */
@@ -2718,6 +2726,7 @@ export declare class OutfitRenderer {
     currentRigType: AvatarType;
     doCameraUpdateOnLoad: boolean; /**Makes camera update when new avatar has loaded */
     doCameraUpdate: boolean; /**Does camera update every frame */
+    doAddInstance: boolean; /**If outfitRenderer should call RBXRenderer.addInstance() */
     currentlyChangingRig: boolean;
     currentlyUpdating: boolean;
     hasNewUpdate: boolean;
@@ -2762,6 +2771,10 @@ export declare class OutfitRenderer {
      * Starts updating the animation of the outfit per frame
      */
     startAnimating(): void;
+    /**
+     * Updates the animation once
+     */
+    animateOnce(deltaTimeOverride?: number): void;
     /**
      * Stops updating the animation of the outfit per frame
      */
@@ -2769,8 +2782,9 @@ export declare class OutfitRenderer {
     /**
      * Sets the current animation being played
      * @param name The name of the animation, for example "idle", "run" or "emote.1234"
+     * @returns If the animation started playing, it may start playing later if it has been queued despite returning false
      */
-    setMainAnimation(name: string): void;
+    setMainAnimation(name: string): Promise<boolean>;
     /**Calls destroy on the rig and stops animating, the OutfitRenderer should not be interacted with after this */
     destroy(): void;
 }

package/dist/index.js

@@ -29864,6 +29864,8 @@ const FLAGS = {
   THUMBNAIL_TIMEOUT: 500,
   ALWAYS_SHOW_ATTACHMENTS: false,
   RENDERER_DELTA_TIME_MULTIPLIER: 1,
+  PARTICLES_START_FULL: 0,
+  PARTICLES_START_FULL_FRAMERATE: 20,
   //skeleton
   SHOW_SKELETON_HELPER: false,
   SKELETON_HELPER_INSTANCE_NAME: void 0,
@@ -33766,6 +33768,27 @@ class Outfit {
       }
     }
     await Promise.all(assetPromises);
+    const assetDeliveryPromises = [];
+    for (const asset of assetsToAdd) {
+      const assetId = asset.id;
+      if (assetId && !this.getAssetId(assetId)) {
+        assetDeliveryPromises.push(new Promise((resolve) => {
+          API.Asset.GetAssetTypeId(assetId).then((assetTypeId) => {
+            if (!(assetTypeId instanceof Response)) {
+              if (Number(assetTypeId) === assetTypeId) {
+                this.addAsset(assetId, assetTypeId, `${AssetTypes[assetTypeId] || "Asset"} (${assetId})`);
+                resolve(void 0);
+              } else {
+                resolve(void 0);
+              }
+            } else {
+              resolve(void 0);
+            }
+          });
+        }));
+      }
+    }
+    await Promise.all(assetDeliveryPromises);
     for (const assetToAdd of assetsToAdd) {
       let asset = void 0;
       for (const assetIn of this.assets) {
@@ -36348,6 +36371,14 @@ const API = {
         }
       }
     },
+    GetAssetTypeId: async function(assetId) {
+      const response = await RBLXGet("https://assetdelivery.roblox.com/v2/asset?id=" + assetId);
+      if (response.status !== 200) {
+        return response;
+      }
+      const body = await response.json();
+      return body.assetTypeId;
+    },
     IsLayered: async function(id) {
       const cached = CACHE.IsLayered.get(id);
       if (cached !== void 0) {
@@ -50278,6 +50309,14 @@ class EmitterGroupDesc extends RenderDesc {
       this.disposeMeshes(scene, originalResults);
       this.disposeRenderLists(renderer);
     }
+    if (FLAGS.PARTICLES_START_FULL) {
+      for (const emitterDesc of this.emitterDescs) {
+        for (let i = 0; i < Math.min(emitterDesc.lifetime.Max * FLAGS.PARTICLES_START_FULL_FRAMERATE, FLAGS.PARTICLES_START_FULL * FLAGS.PARTICLES_START_FULL_FRAMERATE); i++) {
+          emitterDesc.tick(1 / FLAGS.PARTICLES_START_FULL_FRAMERATE, this);
+          emitterDesc.updateResult(this.renderScene);
+        }
+      }
+    }
     return this.results;
   }
   updateResults() {
@@ -51484,6 +51523,8 @@ class OutfitRenderer {
   /**Makes camera update when new avatar has loaded */
   doCameraUpdate = false;
   /**Does camera update every frame */
+  doAddInstance = true;
+  /**If outfitRenderer should call RBXRenderer.addInstance() */
   currentlyChangingRig = false;
   currentlyUpdating = false;
   hasNewUpdate = false;
@@ -51534,7 +51575,7 @@ class OutfitRenderer {
             dataModel.Destroy();
             this.currentRig = newRig;
             this.currentlyChangingRig = false;
-            RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
+            if (this.doAddInstance) RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
             resolve(newRig);
           } else {
             this.onError.Fire("rig");
@@ -51572,7 +51613,7 @@ class OutfitRenderer {
             }
             this.currentlyUpdating = false;
             if (this.currentRig) {
-              RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
+              if (this.doAddInstance) RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
               if (this.doCameraUpdateOnLoad) {
                 this.centerCamera();
               }
@@ -51590,9 +51631,11 @@ class OutfitRenderer {
             }
           });
         } else {
+          this.onError.Fire("rig");
           this.currentlyUpdating = false;
         }
       } else {
+        this.onError.Fire("rig");
         this.currentlyUpdating = false;
       }
     });
@@ -51633,21 +51676,27 @@ class OutfitRenderer {
       if (this.currentRig && this.doCameraUpdate) {
         this.centerCamera();
       }
-      if (this.currentRig && this.auth) {
-        const humanoid = this.currentRig.FindFirstChildOfClass("Humanoid");
-        if (humanoid) {
-          const animator = humanoid.FindFirstChildOfClass("Animator");
-          if (animator) {
-            const deltaTime = (Date.now() / 1e3 - this.lastFrameTime) * this.deltaTimeMultiplier;
-            this.lastFrameTime = Date.now() / 1e3;
-            const animatorW = new AnimatorWrapper(animator);
-            animatorW.renderAnimation(deltaTime);
-            this.currentRig.preRender();
-            RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
-          }
+      this.animateOnce();
+    }, 1e3 / this.animationFPS);
+  }
+  /**
+   * Updates the animation once
+   */
+  animateOnce(deltaTimeOverride) {
+    if (this.currentRig && this.auth) {
+      const humanoid = this.currentRig.FindFirstChildOfClass("Humanoid");
+      if (humanoid) {
+        const animator = humanoid.FindFirstChildOfClass("Animator");
+        if (animator) {
+          const deltaTime = deltaTimeOverride || (Date.now() / 1e3 - this.lastFrameTime) * this.deltaTimeMultiplier;
+          this.lastFrameTime = Date.now() / 1e3;
+          const animatorW = new AnimatorWrapper(animator);
+          animatorW.renderAnimation(deltaTime);
+          this.currentRig.preRender();
+          if (this.doAddInstance) RBXRenderer.addInstance(this.currentRig, this.auth, this.renderScene);
         }
       }
-    }, 1e3 / this.animationFPS);
+    }
   }
   /**
    * Stops updating the animation of the outfit per frame
@@ -51661,26 +51710,36 @@ class OutfitRenderer {
   /**
    * Sets the current animation being played
    * @param name The name of the animation, for example "idle", "run" or "emote.1234"
+   * @returns If the animation started playing, it may start playing later if it has been queued despite returning false
    */
   setMainAnimation(name) {
-    if (this.currentRig) {
-      const humanoid = this.currentRig.FindFirstChildOfClass("Humanoid");
-      if (humanoid) {
-        const animator = humanoid.FindFirstChildOfClass("Animator");
-        if (animator) {
-          const animatorW = new AnimatorWrapper(animator);
-          const successfullyPlayed = animatorW.playAnimation(name);
-          if (!successfullyPlayed && name.startsWith("emote.") && name) {
-            const emoteId = BigInt(name.split(".")[1]);
-            animatorW.loadAvatarAnimation(emoteId, true, true).then(() => {
-              animatorW.playAnimation(name);
-            });
+    return new Promise((resolve) => {
+      if (this.currentRig) {
+        const humanoid = this.currentRig.FindFirstChildOfClass("Humanoid");
+        if (humanoid) {
+          const animator = humanoid.FindFirstChildOfClass("Animator");
+          if (animator) {
+            const animatorW = new AnimatorWrapper(animator);
+            const successfullyPlayed = animatorW.playAnimation(name);
+            if (!successfullyPlayed && name.startsWith("emote.") && name) {
+              const emoteId = BigInt(name.split(".")[1]);
+              animatorW.loadAvatarAnimation(emoteId, true, true).then(() => {
+                resolve(animatorW.playAnimation(name));
+              });
+            } else {
+              resolve(false);
+            }
+          } else {
+            resolve(false);
           }
+        } else {
+          resolve(false);
         }
+      } else {
+        this._queuedMainAnimation = name;
+        resolve(false);
       }
-    } else {
-      this._queuedMainAnimation = name;
-    }
+    });
   }
   /**Calls destroy on the rig and stops animating, the OutfitRenderer should not be interacted with after this */
   destroy() {
@@ -51755,15 +51814,26 @@ async function generateOutfitThumbnail(auth, outfit, size = [150, 150], type = "
     const renderScene = RBXRenderer.addScene();
     setupThumbnailScene(renderScene);
     const outfitRenderer = new OutfitRenderer(auth, outfit, renderScene);
+    outfitRenderer.doAddInstance = false;
     if (outfit.playerAvatarType === AvatarType.R6) outfitRenderer.deltaTimeMultiplier = 0;
-    outfitRenderer.startAnimating();
-    if (!outfit.containsAssetType("Gear")) {
-      if (outfit.playerAvatarType === AvatarType.R15) {
-        outfitRenderer.setMainAnimation("pose");
+    API.Misc.startCurrentlyLoadingAssets("thumbnail-animation");
+    outfitRenderer.onSuccess.Connect(() => {
+      if (!outfit.containsAssetType("Gear")) {
+        if (outfit.playerAvatarType === AvatarType.R15) {
+          outfitRenderer.setMainAnimation("pose").then(() => {
+            API.Misc.stopCurrentlyLoadingAssets("thumbnail-animation");
+          });
+        } else {
+          outfitRenderer.setMainAnimation("idle").then(() => {
+            API.Misc.stopCurrentlyLoadingAssets("thumbnail-animation");
+          });
+        }
+      } else {
+        outfitRenderer.setMainAnimation("toolnone").then(() => {
+          API.Misc.stopCurrentlyLoadingAssets("thumbnail-animation");
+        });
       }
-    } else {
-      outfitRenderer.setMainAnimation("toolnone");
-    }
+    });
     let exportTimeout = !API.Misc.getCurrentlyLoading() ? setTimeout(doExport, FLAGS.THUMBNAIL_TIMEOUT) : void 0;
     const onLoadingConnection = API.Events.OnLoadingAssets.Connect((currentlyLoading) => {
       if (exportTimeout) {
@@ -51777,10 +51847,10 @@ async function generateOutfitThumbnail(auth, outfit, size = [150, 150], type = "
     async function doExport() {
       onLoadingConnection.Disconnect();
       if (outfitRenderer.currentRig) {
+        outfitRenderer.animateOnce(!outfit.containsAssetType("Gear") && outfit.playerAvatarType === AvatarType.R6 ? 0 : 1);
         const thumbnailResult = await generateModelThumbnail(auth, renderScene, outfitRenderer.currentRig, size, type, quality, gltfAutoDownload);
         console.log("Generated outfit thumbnail after seconds:", (performance.now() - startTime) / 1e3);
         resolve(thumbnailResult);
-        outfitRenderer.stopAnimating();
         if (outfitRenderer.currentRig) outfitRenderer.currentRig.Destroy();
       } else {
         resolve(void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "roavatar-renderer",
-  "version": "1.5.11",
+  "version": "1.5.13",
   "description": "A renderer for Roblox avatars, used by the RoAvatar extension.",
   "author": "steinan",
   "type": "module",