roavatar-renderer 1.2.14 → 1.2.15

package/README.md

@@ -1,21 +1,25 @@
 # Renderer for RoAvatar
-This is the Roblox avatar renderer made for https://github.com/steinann/RoAvatar
+The Roblox Avatar renderer used by https://github.com/steinann/RoAvatar
 
-It was originally a part of that repository but has now gained independence
+Links: [npm](https://www.npmjs.com/package/roavatar-renderer) | [GitHub](https://github.com/steinann/RoAvatar-Renderer)
 
-Also available on npm: https://www.npmjs.com/package/roavatar-renderer
+> **IMPORTANT** <br>
+> Assets are *NOT* included in the npm module or this repository, you have to get them from the main RoAvatar repository OR set
+> ```FLAGS.ONLINE_ASSETS = true```
 
-IMPORTANT: Assets are NOT included in the npm module or this repository, you have to get them from the main RoAvatar repository OR set FLAGS.ONLINE_ASSETS = true
+Basic example on how to load an avatar using OutfitRenderer (to make it simpler):
 
-Basic example on how to load an avatar, that is also untested:
+**HTML:**
 ```html
-<!--I know this is kind of terrible but... it has to be included-->
+<!--This script has to be loaded in before loading any meshes-->
 <script src="/draco_decoder.js"></script>
 ```
+**TYPESCRIPT:**
 ```ts
 //setup flags that are compatible with you environment
-    FLAGS.ONLINE_ASSETS = false //set this to true if you want assets to be loaded from roblox instead of locally
+    FLAGS.ONLINE_ASSETS = true //set false to true if you want assets to be loaded locally
 
+    //if we arent using online assets we have to provide the renderer with the paths
     if (!FLAGS.ONLINE_ASSETS) {
         //path to asset files from RoAvatar
         FLAGS.ASSETS_PATH = chrome.runtime.getURL("assets/rbxasset/")
@@ -47,9 +51,11 @@ if (!(outfit instanceof Outfit)) throw new Error("Failed to get outfit")
     //used by api
     const auth = new Authentication()
     //manages outfit rendering for you
-    const outfitRenderer = new OutfitRenderer(auth, outfit, "roavatar://")
+    const outfitRenderer = new OutfitRenderer(auth, outfit)
     outfitRenderer.startAnimating()
     outfitRenderer.setMainAnimation("idle")
 ```
 
-See the RoAvatar source code to know more, especially avatarPreview.tsx is useful
+More info available in ```/docs```
+
+Also the OutfitRenderer code or RoAvatar source code is useful, especially ```avatarPreview.ts```

package/dist/index.d.ts

@@ -880,6 +880,10 @@ declare class Event_2 {
 }
 export { Event_2 as Event }
 
+export declare function exposeAPI(): void;
+
+export declare function exposeMesh(): void;
+
 export declare const FaceControlNames: string[];
 
 export declare class FaceControlsWrapper extends InstanceWrapper {
@@ -1279,7 +1283,7 @@ export declare class Instance {
     PropOrDefault(name: string, def: unknown): unknown;
     PropertyType(name: string): number | undefined;
     getPropertyNames(): string[];
-    setParent(instance: Instance | undefined | null): void;
+    setParent(instance: Instance | undefined | null, fireEvents?: boolean): void;
     Destroy(): void;
     GetFullName(): string;
     GetChildren(): Instance[];
@@ -1882,13 +1886,15 @@ export declare class OutfitRenderer {
     hasNewUpdate: boolean;
     lastFrameTime: number;
     animationInterval?: NodeJS.Timeout;
+    animationFPS: number;
+    deltaTimeMultiplier: number;
     /**
      * Creates a new OutfitRenderer which makes it easy to render outfits
      * @param auth The authentication object, you should have one you use for everything
      * @param outfit The outfit you want to render, it can be updated later by calling setOutfit()
-     * @param rigPath The path that contains RigR6.rbxm and RigR15.rbxm, for example "../assets/"
+     * @param rigPath The path that contains RigR6.rbxm and RigR15.rbxm, should always be "roavatar://" as rig path is now controlled by FLAGS
      */
-    constructor(auth: Authentication, outfit: Outfit, rigPath: string);
+    constructor(auth: Authentication, outfit: Outfit, rigPath?: string);
     /**
      * Updates the current rig, called internally by _updateOutfit()
      */

package/dist/index.js

@@ -29537,16 +29537,16 @@ const FLAGS = {
 };
 function log(critical, ...args) {
   if (critical || FLAGS.VERBOSE_LOGGING) {
-    console.log(args);
+    console.log(...args);
   }
 }
 function warn(critical, ...args) {
   if (critical || FLAGS.VERBOSE_LOGGING) {
-    console.warn(args);
+    console.warn(...args);
   }
 }
 function error(...args) {
-  console.error(args);
+  console.error(...args);
 }
 function time(label) {
   if (FLAGS.VERBOSE_LOGGING) {
@@ -30266,7 +30266,7 @@ class Instance {
   getPropertyNames() {
     return Array.from(this._properties.keys());
   }
-  setParent(instance) {
+  setParent(instance, fireEvents = true) {
     if (!instance) {
       instance = void 0;
     }
@@ -30286,10 +30286,14 @@ class Instance {
     }
     if (instance) {
       instance.children.push(this);
-      instance.ChildAdded.Fire(this);
-      instance.AncestryChanged.Fire(this, instance);
     }
-    this.AncestryChanged.Fire(this, instance);
+    if (fireEvents) {
+      if (instance) {
+        instance.ChildAdded.Fire(this);
+        instance.AncestryChanged.Fire(this, instance);
+      }
+      this.AncestryChanged.Fire(this, instance);
+    }
   }
   Destroy() {
     for (const connection of this._connectionReferences) {
@@ -30344,8 +30348,8 @@ class Instance {
     return childrenList;
   }
   GetDescendants() {
-    let descendants = this.children;
-    for (const child of this.children) {
+    let descendants = this.GetChildren();
+    for (const child of this.GetChildren()) {
       descendants = descendants.concat(child.GetDescendants());
     }
     return descendants;
@@ -30840,6 +30844,7 @@ class RBX {
           const content = new Content();
           content.sourceType = sourceTypes[i];
           switch (content.sourceType) {
+            //2 - Uri, 0 - Object/None,
             case 0:
               break;
             case 1:
@@ -41185,7 +41190,7 @@ function TraverseRigFromAttachmentsInternal(self2, part, characterParts, buildJo
     if (attachment.className === "Attachment") {
       const attachmentName = attachment.Prop("Name");
       const findPos = attachmentName.indexOf(rigAttachmentName);
-      if (findPos) {
+      if (findPos !== -1) {
         const jointName = attachmentName.substring(0, findPos);
         const joint = part.FindFirstChild(jointName);
         if (!joint || joint.className !== "Motor6D") {
@@ -41193,6 +41198,7 @@ function TraverseRigFromAttachmentsInternal(self2, part, characterParts, buildJo
             if (part !== characterPart) {
               const matchingAttachment = characterPart.FindFirstChild(attachmentName);
               if (matchingAttachment && matchingAttachment.className === "Attachment") {
+                log(false, "matchingAtt", part, characterPart, attachmentName);
                 AdjustRootRigAttachmentPosition(self2, part, characterPart, attachment, matchingAttachment);
                 {
                   createJoint(jointName, attachment, matchingAttachment);
@@ -42630,6 +42636,26 @@ class MeshDesc {
     const meshIdStr = child.Property("MeshId");
     this.mesh = meshIdStr;
     this.scaleIsRelative = true;
+    if (!FLAGS.AVATAR_JOINT_UPGRADE) {
+      if (child.FindFirstChildOfClass("Bone")) {
+        this.canHaveSkinning = false;
+      } else {
+        if (child.Prop("Name").includes("Arm")) {
+          const rig = child.parent;
+          if (rig) {
+            const humanoid = rig.FindFirstChildOfClass("Humanoid");
+            if (humanoid) {
+              const side = child.Prop("Name").startsWith("Right") ? "Right" : "Left";
+              const handName = side + "Hand";
+              const hand = rig.FindFirstChild(handName);
+              if (hand && hand.FindFirstChildOfClass("Bone")) {
+                this.canHaveSkinning = false;
+              }
+            }
+          }
+        }
+      }
+    }
     const surfaceAppearance = child.FindLastChildOfClass("SurfaceAppearance");
     if (surfaceAppearance) {
       const color = surfaceAppearance.HasProperty("Color") ? surfaceAppearance.Prop("Color") : new Color3(1, 1, 1);
@@ -43980,6 +44006,7 @@ function setBoneToCFrame$1(bone, cf) {
   bone.rotation.y = rad(cf.Orientation[1]);
   bone.rotation.z = rad(cf.Orientation[2]);
 }
+const BaseR15Bones = ["Root", "HumanoidRootNode", "LowerTorso", "UpperTorso", "RightUpperArm", "RightLowerArm", "RightHand", "LeftUpperArm", "LeftLowerArm", "LeftHand", "Head", "DynamicHead"];
 function getJointForInstances$1(parent, child, includeTransform) {
   const childMotor = child.FindFirstChildOfClass("Motor6D");
   const parentMotor = parent.FindFirstChildOfClass("Motor6D");
@@ -44007,6 +44034,21 @@ function boneIsChildOf(bone, parentName) {
   }
   return false;
 }
+function getBoneBaseR15Parent(bone) {
+  let currentParent = bone.parent;
+  if (!currentParent) return;
+  while (currentParent && !BaseR15Bones.includes(currentParent.name)) {
+    currentParent = currentParent.parent;
+  }
+  if (!currentParent) {
+    return bone.parent;
+  } else {
+    return currentParent;
+  }
+}
+function boneIsBaseR15(bone) {
+  return BaseR15Bones.includes(bone.name);
+}
 function getMotorsInRig(rigChildren) {
   const motors = [];
   for (const child of rigChildren) {
@@ -44025,15 +44067,17 @@ function getBoneDependencies(rig) {
   let currentSearchOrigin = hrp ? ["Root"] : [];
   const children = rig.GetChildren();
   const motors = getMotorsInRig(children);
+  const searchedParts = [];
   while (currentSearch.length > 0 && currentSearch[0]) {
     const newCurrentSearch = [];
     const newCurrentSearchOrigin = [];
     for (let i = 0; i < currentSearch.length; i++) {
       const toSearch = currentSearch[i];
+      searchedParts.push(toSearch);
       const selfName = toSearch === hrp ? "HumanoidRootNode" : toSearch.Prop("Name");
       names.set(selfName, currentSearchOrigin[i]);
       for (const motor of motors) {
-        if (motor.Prop("Part0") === toSearch) {
+        if (motor.Prop("Part0") === toSearch && !searchedParts.includes(motor.parent)) {
           newCurrentSearch.push(motor.parent);
           newCurrentSearchOrigin.push(selfName);
         }
@@ -44237,7 +44281,8 @@ let SkeletonDesc$1 = class SkeletonDesc {
     for (let i = 0; i < this.bones.length; i++) {
       const bone = this.bones[i];
       const partEquivalent = this.getPartEquivalent(selfInstance, bone.name);
-      const parentPartEquivalent = bone.parent ? bone.parent.name !== "HumanoidRootNode" ? this.getPartEquivalent(selfInstance, bone.parent.name) : humanoidRootPartEquivalent : void 0;
+      const boneParent = boneIsBaseR15(bone) ? getBoneBaseR15Parent(bone) : bone.parent;
+      const parentPartEquivalent = boneParent ? boneParent.name !== "HumanoidRootNode" ? this.getPartEquivalent(selfInstance, boneParent.name) : humanoidRootPartEquivalent : void 0;
       let rootBoneCF = new CFrame();
       if (bone.name === "Root") {
         rootBoneCF = rootBoneCFog;
@@ -47206,6 +47251,32 @@ function isSameAccessoryDesc(desc0, desc1) {
 function isSameMakeupDesc(desc0, desc1) {
   return hasSameVal(desc0, desc1, "AssetId") && hasSameVal(desc0, desc1, "MakeupType") && hasSameVal(desc0, desc1, "Order");
 }
+function moveAttachmentsToBase(rigPart) {
+  let nextCollapse = rigPart.GetChildren();
+  let cframeHierarchy = new Array(nextCollapse.length).fill(new CFrame());
+  while (nextCollapse.length > 0) {
+    const newNextCollapse = [];
+    const newCFrameHierarchy = [];
+    for (let i = 0; i < nextCollapse.length; i++) {
+      const child = nextCollapse[i];
+      if (child.className !== "Bone" && child.className !== "Attachment" || !child.HasProperty("CFrame")) {
+        continue;
+      }
+      const selfCFrameHierarchy = cframeHierarchy[i];
+      const originalCFrame = child.Prop("CFrame");
+      const newCFrame = selfCFrameHierarchy.multiply(originalCFrame);
+      child.setProperty("CFrame", newCFrame);
+      const childChildren = child.GetChildren();
+      for (const childChild of childChildren) {
+        newNextCollapse.push(childChild);
+        newCFrameHierarchy.push(newCFrame);
+      }
+      child.setParent(rigPart);
+    }
+    nextCollapse = newNextCollapse;
+    cframeHierarchy = newCFrameHierarchy;
+  }
+}
 class HumanoidDescriptionWrapper extends InstanceWrapper {
   static className = "HumanoidDescription";
   static requiredProperties = [
@@ -47860,6 +47931,9 @@ class HumanoidDescriptionWrapper extends InstanceWrapper {
                   if (R15Folder) {
                     const children = R15Folder.GetChildren();
                     for (const child of children) {
+                      if (!FLAGS.AVATAR_JOINT_UPGRADE) {
+                        moveAttachmentsToBase(child);
+                      }
                       replaceBodyPart(rig, child);
                     }
                   }
@@ -49473,6 +49547,14 @@ class HSR {
     }
   }
 }
+function exposeAPI() {
+  globalThis.API = API;
+  globalThis.APICACHE = CACHE;
+  globalThis.Authentication = Authentication;
+}
+function exposeMesh() {
+  globalThis.fileMeshToTHREEGeometry = fileMeshToTHREEGeometry;
+}
 function getCorners(cframe, size) {
   const halfX = size.X / 2;
   const halfY = size.Y / 2;
@@ -49586,13 +49668,15 @@ class OutfitRenderer {
   hasNewUpdate = false;
   lastFrameTime = Date.now() / 100;
   animationInterval;
+  animationFPS = 60;
+  deltaTimeMultiplier = 1;
   /**
    * Creates a new OutfitRenderer which makes it easy to render outfits
    * @param auth The authentication object, you should have one you use for everything
    * @param outfit The outfit you want to render, it can be updated later by calling setOutfit()
-   * @param rigPath The path that contains RigR6.rbxm and RigR15.rbxm, for example "../assets/"
+   * @param rigPath The path that contains RigR6.rbxm and RigR15.rbxm, should always be "roavatar://" as rig path is now controlled by FLAGS
    */
-  constructor(auth, outfit, rigPath) {
+  constructor(auth, outfit, rigPath = "roavatar://") {
     this.auth = auth;
     this.outfit = outfit;
     this.currentRigType = outfit.playerAvatarType;
@@ -49703,7 +49787,7 @@ class OutfitRenderer {
    */
   startAnimating() {
     if (this.animationInterval !== void 0) return;
-    this.lastFrameTime = Date.now() / 100;
+    this.lastFrameTime = Date.now() / 1e3;
     this.animationInterval = setInterval(() => {
       if (this.currentRig && this.doCameraUpdate) {
         this.centerCamera();
@@ -49713,7 +49797,7 @@ class OutfitRenderer {
         if (humanoid) {
           const animator = humanoid.FindFirstChildOfClass("Animator");
           if (animator) {
-            const deltaTime = Date.now() / 1e3 - this.lastFrameTime;
+            const deltaTime = (Date.now() / 1e3 - this.lastFrameTime) * this.deltaTimeMultiplier;
             this.lastFrameTime = Date.now() / 1e3;
             const animatorW = new AnimatorWrapper(animator);
             animatorW.renderAnimation(deltaTime);
@@ -49722,7 +49806,7 @@ class OutfitRenderer {
           }
         }
       }
-    }, 1e3 / 60);
+    }, 1e3 / this.animationFPS);
   }
   /**
    * Stops updating the animation of the outfit per frame
@@ -49730,6 +49814,7 @@ class OutfitRenderer {
   stopAnimating() {
     if (this.animationInterval) {
       clearInterval(this.animationInterval);
+      this.animationInterval = void 0;
     }
   }
   /**
@@ -49913,6 +49998,8 @@ export {
   divide,
   dot,
   download,
+  exposeAPI,
+  exposeMesh,
   floor,
   gaussian_rbf,
   generateUUIDv4,

package/package.json

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