roavatar-renderer 1.5.8 → 1.5.10

package/README.md

@@ -17,7 +17,8 @@ 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.ONLINE_ASSETS = true //set false to true if you want assets to be loaded locally
+    FLAGS.FETCH_FUNC = undefined //undefined is the default fetch() function, this flag can be used to intercept requests
+    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
     if (!FLAGS.ONLINE_ASSETS) {
@@ -55,5 +56,7 @@ if (!(outfit instanceof Outfit)) throw new Error("Failed to get outfit")
     outfitRenderer.startAnimating()
     outfitRenderer.setMainAnimation("idle")
 ```
+**RESULT:**
+<img src="https://devforum-uploads.s3.dualstack.us-east-2.amazonaws.com/uploads/original/5X/9/f/a/d/9fadf25d9770b63e8a2e480369930cad94ad04aa.png">
 
 Also the OutfitRenderer code or RoAvatar source code is useful, especially ```avatarPreview.ts```

package/dist/index.d.ts

@@ -114,7 +114,7 @@ export declare const AlphaMode: {
 /**
  * @category InstanceWrapper
  */
-export declare class AnimationConstraintWrapper extends InstanceWrapper {
+export declare class AnimationConstraintWrapper extends ConstraintWrapper {
     static className: string;
     static requiredProperties: string[];
     setup(): void;
@@ -332,6 +332,13 @@ export declare const API: {
     };
     Asset: {
         GetAssetBuffer: (url: string, headers?: HeadersInit, extraStr?: string) => Promise<Response | ArrayBuffer>;
+        /**
+         * Remember to call .Destroy() on the Instance returned by RBX.generateTree() to avoid memory leaks
+         * @param url
+         * @param headers
+         * @param contentRepresentationPriorityList
+         * @returns
+         */
         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>;
@@ -348,6 +355,9 @@ export declare const API: {
         GetMarketplaceWidgetsSearch: (query: string) => Promise<MarketplaceWidgets_Result | Response>;
         GetMarketplaceWidgets: (context?: string) => Promise<MarketplaceWidgets_Result | Response>;
     };
+    Develop: {
+        GetLatestVersions: (auth: Authentication, assetIds: number[]) => Promise<Response | LatestVersions_Result>;
+    };
     Inventory: {
         GetInventory: (userId: number, assetType: number, cursor?: string) => Promise<Response>;
         IsItemOwned: (userId: number, itemType: string, assetId: number) => Promise<any>;
@@ -387,6 +397,45 @@ export declare const API: {
 
 export declare function arrayBufferToBase64(buffer: ArrayBuffer): string;
 
+export declare class Assembly {
+    id: number;
+    rootNode: AssemblyNode;
+    allNodes: AssemblyNode[] | undefined;
+    allConnectors: Instance[] | undefined;
+    constructor(rootPart: Instance);
+    getNodeDescendants(): AssemblyNode[];
+    getPartDescendants(): Instance[];
+    getAllConnectors(): Instance[];
+    getNode(name: string): AssemblyNode | undefined;
+    getPart(name: string): Instance | undefined;
+    traverseTree(): void;
+    traverseCFrame(node: AssemblyNode, includeTransform: boolean, applyRoot?: boolean): CFrame;
+    traverseInstance(node: AssemblyNode): Instance[];
+    destroy(): void;
+}
+
+export declare class AssemblyNode {
+    depth: number;
+    nodes: AssemblyNode[];
+    part: Instance;
+    children: Instance[];
+    connectors: Instance[];
+    parent: AssemblyNode | Assembly;
+    assembly: Assembly;
+    traversedRestCFrame: CFrame;
+    traversedTransformCFrame: CFrame;
+    constructor(assembly: Assembly, parent: AssemblyNode | Assembly, depth: number, part: Instance, already?: Instance[]);
+    getNodeChildren(): AssemblyNode[];
+    getNodeDescendants(): AssemblyNode[];
+    getParentConnector(): Instance | undefined;
+    getConnectorOffset(includeTransform: boolean): CFrame;
+    _traverseTree(transform: CFrame, rest: CFrame): void;
+    /**
+     * Should only be called when destroying entire assembly by calling Assembly.destroy()
+     */
+    destroy(): void;
+}
+
 /** @category Outfit */
 export declare class Asset {
     id: number;
@@ -503,7 +552,7 @@ export declare class AttachmentWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
     setup(): void;
-    getWorldCFrame(): CFrame;
+    getWorldCFrame(includeTransform?: boolean): CFrame;
 }
 
 /** @category API */
@@ -614,6 +663,26 @@ declare class BaseKeyframeGroup {
     getHigherKeyframe(time: number): BaseKeyframe | null;
 }
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class BasePartWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+    get data(): BasePartWrapperData;
+    created(): void;
+    preRender(): void;
+    GetAssemblyNode(): AssemblyNode;
+    GetAssembly(): Assembly;
+    GetConnectors(): Instance[];
+    GetConnectedParts(): Instance[];
+}
+
+declare class BasePartWrapperData {
+    assemblyNode?: AssemblyNode;
+}
+
 /**@category Outfit */
 export declare type BodyColor3Name = "headColor3" | "torsoColor3" | "rightArmColor3" | "leftArmColor3" | "rightLegColor3" | "leftLegColor3";
 
@@ -724,6 +793,15 @@ export declare const BodyPartNameToEnum: {
     [K in string]: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class BoneWrapper extends AttachmentWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 /**
  * @category Mesh
  */
@@ -795,18 +873,29 @@ export declare interface BundleDetails_Result {
 export declare const BundleTypes: string[];
 
 export declare const CACHE: {
-    AssetBuffer: Map<string, Promise<ArrayBuffer | Response>>;
-    RBX: Map<string, RBX>;
-    Mesh: Map<string, FileMesh>;
-    Image: Map<string, HTMLImageElement | Promise<HTMLImageElement | undefined> | undefined>;
-    Thumbnails: Map<string, string | undefined>;
-    ItemOwned: Map<string, [boolean, number]>;
-    IsLayered: Map<number, boolean>;
-    AvatarInventoryItem: Map<string, AvatarInventory_Result>;
-    ItemDetails: Map<string, ItemDetail_Result>;
+    AssetBuffer: Cache_2<string, Promise<ArrayBuffer | Response>>;
+    RBX: Cache_2<string, RBX>;
+    Mesh: Cache_2<string, FileMesh>;
+    Image: Cache_2<string, HTMLImageElement | Promise<HTMLImageElement | undefined> | undefined>;
+    Thumbnails: Cache_2<string, string | undefined>;
+    ItemOwned: Cache_2<string, [boolean, number]>;
+    IsLayered: Cache_2<number, boolean>;
+    AvatarInventoryItem: Cache_2<string, AvatarInventory_Result>;
+    ItemDetails: Cache_2<string, ItemDetail_Result>;
     UserInfo: undefined;
 };
 
+declare class Cache_2<K, V> {
+    map: Map<K, V>;
+    lastAccess: Map<K, number>;
+    maxEntries: number;
+    constructor(maxEntries?: number);
+    get(key: K): V | undefined;
+    set(key: K, value: V): Cache_2<K, V>;
+    has(key: K): boolean;
+    delete(key: K): boolean;
+}
+
 /**
  * @category Mesh
  */
@@ -929,6 +1018,15 @@ export declare class Connection {
     Disconnect(): void;
 }
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class ConstraintWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 /**
  * @category DataModelProperty
  */
@@ -1212,6 +1310,8 @@ export declare class FileMesh {
     fromBuffer(buffer: ArrayBuffer): Promise<void>;
     stripLODS(): void;
     padSkinnings(): void;
+    setBoneSource(name: string): void;
+    setBoneSourceSize(): void;
     combine(other: FileMesh): void;
     removeDuplicateVertices(distance?: number): number;
     removeFaces(indices: number[]): void;
@@ -1223,24 +1323,20 @@ export declare class FileMesh {
  * Bone inside SKINNING in FileMesh
  * @category Mesh */
 export declare class FileMeshBone {
+    name?: string;
     boneNameIndex: number;
     parentIndex: number;
     lodParentIndex: number;
     culling: number;
     rotationMatrix: Mat3x3;
     position: Vec3;
+    sourcePart?: string;
+    sourceOffset: CFrame;
+    sourceSize?: Vec3;
+    sourceScaled: Vec3;
     clone(): FileMeshBone;
 }
 
-/**
- * Contains bone weights for a single vert
- * @category Mesh */
-export declare class FileMeshSkinning {
-    subsetIndices: Vec4;
-    boneWeights: Vec4;
-    clone(): FileMeshSkinning;
-}
-
 /**
  * Section of mesh inside SKINNING in FileMesh
  * @category Mesh */
@@ -1271,6 +1367,10 @@ export declare const FLAGS: {
     AVATAR_JOINT_UPGRADE: boolean;
     /**wip, only for memory leak debugging */
     INSTANCE_GARBAGE_COLLECT: boolean;
+    /**makes welds immediately update (bad for performance) */
+    LEGACY_WELD_BEHAVIOR: boolean;
+    /**caches hierarchy of joints and removes directionality (required for AVATAR_JOINT_UPGRADE)*/
+    USE_ASSEMBLY: boolean;
     /**outfits returned by api use Color3 instead of BrickColor */
     BODYCOLOR3: boolean;
     /**allows API to cache data */
@@ -1293,7 +1393,10 @@ export declare const FLAGS: {
     API_REQUEST_PREFIX: string;
     /**credentials request type when fetching from API_DOMAIN and credentials are usually include */
     INCLUDE_REQUEST_CREDENTIALS_OVERRIDE: RequestCredentials;
+    /**if requests should be retried once after failing */
     API_REQUEST_RETRY: boolean;
+    /**the fetch function the api will use */
+    FETCH_FUNC: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>) | undefined;
     /**loads assets from assetdelivery instead of local files */
     ONLINE_ASSETS: boolean;
     /**path to rbxasset:// local files*/
@@ -1330,8 +1433,6 @@ export declare const FLAGS: {
     GEAR_ENABLED: boolean;
     /**makes Audio instances play sound when played */
     AUDIO_ENABLED: boolean;
-    /**makes welds immediately update (bad for performance) */
-    LEGACY_WELD_BEHAVIOR: boolean;
     /**enables full texture compilation using ThreeJS RenderTarget */
     USE_RENDERTARGET: boolean;
     /**the renderer will attempt to restore the webgl context when it is lost */
@@ -1342,15 +1443,21 @@ export declare const FLAGS: {
     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;
     /**shows ThreeJS SkeletonHelper */
     SHOW_SKELETON_HELPER: boolean;
+    /**if set the skeleton helper will only show if the instance has the name */
+    SKELETON_HELPER_INSTANCE_NAME: string | undefined;
     /**skeleton is updated every frame */
     UPDATE_SKELETON: boolean;
     /**skeleton is animated every frame */
     ANIMATE_SKELETON: boolean;
     /**autoskin is applied even when its disabled */
     AUTO_SKIN_EVERYTHING: boolean;
-    /**skeleton is local instead of global (broken) */
+    /**skeleton is local instead of global (broken)
+     * @deprecated No longer does anything
+     */
     USE_LOCAL_SKELETONDESC: boolean;
     /**enables HSR (hidden surface removal) */
     ENABLE_HSR: boolean;
@@ -1530,10 +1637,16 @@ export declare function getOriginalAttachmentPosition(attachment: Instance): Vec
 
 export declare function getOriginalSize(part: Instance): Vector3;
 
+export declare function getPartAssemblyScore(part: Instance): number;
+
+export declare function getPartsInAssembly_Generate(part: Instance): Instance[];
+
 export declare function getRandomBetweenInclusive(min: number, max: number, randomVal?: number): number;
 
 export declare function getRigExtentsWorld(rig: Instance): [Vector3, Vector3];
 
+export declare function getRootAssemblyPart_Generate(part: Instance): Instance;
+
 /**@category API */
 export declare interface GetSubscription_Result {
     "subscriptionProductModel": {
@@ -1779,6 +1892,7 @@ export declare class Instance {
     parent?: Instance;
     destroyed: boolean;
     private _hasWrappered;
+    wrapperInitialized: boolean;
     classID?: number;
     objectFormat?: number;
     ChildAdded: Event_2;
@@ -1786,6 +1900,7 @@ export declare class Instance {
     Destroying: Event_2;
     Changed: Event_2;
     AncestryChanged: Event_2;
+    referencedByChanged: Event_2;
     constructor(className: string, notComplete?: boolean);
     get id(): string;
     set name(value: string);
@@ -1796,6 +1911,7 @@ export declare class Instance {
     removeConnectionReference(connection: Connection): void;
     addReferencedBy(instance: Instance): void;
     removeReferencedBy(instance: Instance): void;
+    getReferencedBy(): Instance[];
     addProperty(property: Property, value?: unknown): void;
     fixPropertyName(name: string): string;
     setProperty(name: string, value: unknown, supressEvents?: boolean): void;
@@ -1829,6 +1945,7 @@ export declare class Instance {
     Child(name: string): Instance | undefined;
     FindFirstChildOfClass(className: string): Instance | undefined;
     FindLastChildOfClass(className: string): Instance | undefined;
+    IsA(className: string): boolean;
     preRender(): void;
 }
 
@@ -1949,6 +2066,26 @@ export declare class ItemSort {
 
 declare type ItemType = "Asset" | "Bundle" | "Outfit" | "Look" | "Avatar" | "None";
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class JointInstanceWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+    get data(): JointInstanceWrapperData;
+    created(): void;
+    preRender(): void;
+    getAssemblyOffset(includeTransform: boolean): CFrame;
+    update(affectedPart?: number): void;
+}
+
+declare class JointInstanceWrapperData {
+    part0ChangedConnection?: Connection;
+    lastUpdateTime: number;
+    timeUpdates: number;
+}
+
 declare class KDNode {
     point: Vec3;
     index: number;
@@ -1958,6 +2095,15 @@ declare class KDNode {
     constructor(point: Vec3, index: number, axis: number);
 }
 
+/**@category API */
+export declare interface LatestVersions_Result {
+    "results": {
+        assetId: number;
+        status: "Success" | string;
+        versionNumber: number;
+    }[];
+}
+
 /**
  * @deprecated Superseded by RBFDeformerPatch
  * @category Mesh
@@ -2145,7 +2291,7 @@ export declare const MakeupType: {
 /**
  * @category InstanceWrapper
  */
-export declare class ManualWeldWrapper extends WeldWrapper {
+export declare class ManualWeldWrapper extends JointInstanceWrapper {
     static className: string;
 }
 
@@ -2225,6 +2371,15 @@ declare class MeshCollider {
     raycast(ray: Ray_2): boolean;
 }
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class MeshPartWrapper extends BasePartWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 /**@category DataModelEnum */
 export declare const MeshType: {
     Brick: number;
@@ -2257,7 +2412,7 @@ export declare class ModelWrapper extends InstanceWrapper {
 /**
  * @category InstanceWrapper
  */
-export declare class Motor6DWrapper extends WeldWrapper {
+export declare class Motor6DWrapper extends JointInstanceWrapper {
     static className: string;
     static requiredProperties: string[];
     setup(): void;
@@ -2590,7 +2745,7 @@ export declare class OutfitRenderer {
     /**
      * Updates the current rig, called internally by _updateOutfit()
      */
-    _setRigTo(newRigType: AvatarType): Promise<Instance | Response>;
+    _setRigTo(newRigType: AvatarType): Promise<Response | Instance>;
     /**
      * Rerenders the current outfit, called internally by setOutfit() and constructor
      */
@@ -2684,6 +2839,15 @@ export declare const PartType: {
     CornerWedge: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class PartWrapper extends BasePartWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 declare class PRNT {
     instanceCount: number;
     childReferents: number[];
@@ -3305,21 +3469,24 @@ declare class SimpleView {
     readUint8(): number;
 }
 
-/**
- * Class inside FileMesh that contains skinning data
- * @category Mesh */
 export declare class SKINNING {
-    numSkinnings: number;
-    skinnings: FileMeshSkinning[];
-    numBones: number;
+    _numskinnings: number;
+    private _indices;
+    private _weights;
     bones: FileMeshBone[];
-    nameTableSize: number;
-    nameTable: string[];
-    numSubsets: number;
-    subsets: FileMeshSubset[];
     clone(): SKINNING;
-    getBone(boneName: string): FileMeshBone | undefined;
-    getSubsetIndex(vertIndex: number): number;
+    get numskinnings(): number;
+    set numskinnings(value: number);
+    get indices(): Uint16Array<ArrayBufferLike>;
+    get weights(): Float32Array<ArrayBufferLike>;
+    getIndex(i: number): Vec4;
+    setIndex(i: number, value: Vec4): void;
+    getWeight(i: number): Vec4;
+    setWeight(i: number, value: Vec4): void;
+    readSkinning(view: SimpleView, i: number): void;
+    increaseSkinnings(add: number): void;
+    onlySkinnings(only: number[]): void;
+    getBone(name: string): FileMeshBone | undefined;
 }
 
 export declare function snapToNumber(value: number, numbers: number[]): number;
@@ -3590,6 +3757,13 @@ export declare function Wait(time: number): Promise<unknown>;
 /** @category Outfit */
 export declare const WearableAssetTypes: string[];
 
+/**
+ * @category InstanceWrapper
+ */
+export declare class WedgePartWrapper extends BasePartWrapper {
+    static className: string;
+}
+
 /**
  * @category Mesh
  */
@@ -3608,20 +3782,8 @@ export declare type WeightChunk3 = WeightChunk & {
 /**
  * @category InstanceWrapper
  */
-export declare class WeldWrapper extends InstanceWrapper {
+export declare class WeldWrapper extends JointInstanceWrapper {
     static className: string;
-    static requiredProperties: string[];
-    setup(): void;
-    get data(): WeldWrapperData;
-    created(): void;
-    preRender(): void;
-    update(affectedPart?: number): void;
-}
-
-declare class WeldWrapperData {
-    part0ChangedConnection?: Connection;
-    lastUpdateTime: number;
-    timeUpdates: number;
 }
 
 export declare const WorkerTypeToFunction: {