roavatar-renderer 1.4.5 → 1.5.1

package/dist/index.d.ts

@@ -234,7 +234,14 @@ export declare class AnimatorWrapper extends InstanceWrapper {
      */
     getCurrentAnimationTrack(): AnimationTrack | undefined;
     /**
-     * Loads a new animation
+     * Loads an animation (not to be confused with an avatar animation like those found on the catalog)
+     * @param id
+     * @param forceLoop Forces animation track to loop
+     * @returns AnimationTrack on success
+     */
+    loadAnimation(id: bigint, forceLoop?: boolean): Promise<AnimationTrack | Response | undefined>;
+    /**
+     * Loads a new avatar animation (catalog run animation or emote, not to be confused with a creator store animation)
      * @param id
      * @param isEmote
      * @param forceLoop Forces animation track to loop
@@ -243,7 +250,7 @@ export declare class AnimatorWrapper extends InstanceWrapper {
     loadAvatarAnimation(id: bigint, isEmote?: boolean, forceLoop?: boolean): Promise<Response | undefined>;
     /**
      * Switches to new animation
-     * @param name Animation name, such as "idle", "walk" or "emote.1234"
+     * @param name Animation name, such as "idle", "walk", "emote.1234" or "id.1234"
      * @param type
      * @returns If animation sucessfully played
      */
@@ -276,13 +283,14 @@ export declare const animNamesR6: AnimationSet;
  */
 export declare const API: {
     Misc: {
-        startCurrentlyLoadingAssets: () => void;
-        stopCurrentlyLoadingAssets: () => void;
+        startCurrentlyLoadingAssets: (label: string) => void;
+        stopCurrentlyLoadingAssets: (label: string) => void;
         idFromStr: (str: string) => number;
         parseAssetString: (str: string) => string;
         getCDNURLFromAssetDelivery: (url: string, headers?: any) => Promise<string | Response>;
         assetURLToCDNURL: (url: string | number | bigint, headers?: any, extraStr?: string) => Promise<string | Response>;
         getCurrentlyLoading: () => boolean;
+        getCurrentlyLoadingLabels: () => string[];
     };
     Events: {
         OnLoadingAssets: Event_2;
@@ -571,6 +579,21 @@ export declare const AvatarType: {
  */
 export declare function averageVec3(vecs: Vec3[]): Vec3;
 
+/**
+ *
+ * @param promise
+ * @param time
+ */
+export declare function awaitTimeout<T>(promise: Promise<T>, time?: number): Promise<T | Response>;
+
+/**
+ *
+ * @param promise
+ * @param time
+ * @throws
+ */
+export declare function awaitTimeoutThrows<T>(promise: Promise<T>, time?: number): Promise<T>;
+
 /**
  * @category Mesh
  */
@@ -980,6 +1003,8 @@ export declare function createWeightsForMeshChunked(mesh: FileMesh, ref_mesh: Fi
  */
 export declare function cross(a: Vec3, b: Vec3): Vec3;
 
+export declare type CurrentlyLoadingUpdateType = "start" | "finish";
+
 export declare const DataType: {
     String: number;
     Bool: number;
@@ -1084,8 +1109,6 @@ export declare function dot(v0: Vec3, v1: Vec3): number;
 
 export declare function download(filename: string, text: string): void;
 
-export declare const EmitterGroupDescClassTypes: string[];
-
 /**
  * @category DataModel
  */
@@ -1316,6 +1339,8 @@ export declare const FLAGS: {
     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 */
     THUMBNAIL_TIMEOUT: number;
+    /**Always render attachments even when theyre set to not be visible */
+    ALWAYS_SHOW_ATTACHMENTS: boolean;
     /**shows ThreeJS SkeletonHelper */
     SHOW_SKELETON_HELPER: boolean;
     /**skeleton is updated every frame */
@@ -1691,6 +1716,7 @@ export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
      */
     private _applyAccessories;
     private _applyMakeup;
+    private _loadDefaultAnimation;
     /**
      * @returns undefined on success
      */
@@ -2393,8 +2419,6 @@ export declare class NumberSequenceKeypoint {
     isSame(other: NumberSequenceKeypoint): boolean;
 }
 
-export declare const ObjectDescClassTypes: string[];
-
 declare class OctreeChild<T> {
     bounds: Bounds;
     data: T;
@@ -2580,6 +2604,8 @@ export declare class OutfitRenderer {
      * @param name The name of the animation, for example "idle", "run" or "emote.1234"
      */
     setMainAnimation(name: string): void;
+    /**Calls destroy on the rig and stops animating, the OutfitRenderer should not be interacted with after this */
+    destroy(): void;
 }
 
 declare class PartCurve {
@@ -2724,6 +2750,7 @@ export declare class RBFDeformerPatch {
     patchCount: number;
     epsilon: number;
     affectBones: boolean;
+    hasSolved: boolean;
     id: number;
     /**
      * Creates the deformer and prepares for deformation
@@ -2998,8 +3025,9 @@ export declare const RegularBodyColors: string[];
  * Abstract class used to describe all rendered instances
  */
 declare class RenderDesc extends DisposableDesc {
+    static classTypes: string[];
     renderScene: RBXRendererScene;
-    results?: THREE.Mesh[];
+    results?: THREE.Object3D[];
     instance?: Instance;
     constructor(renderScene: RBXRendererScene);
     isSame(_other: RenderDesc): boolean;
@@ -3009,8 +3037,11 @@ declare class RenderDesc extends DisposableDesc {
     virtualTransferFrom(_other: RenderDesc): void;
     virtualFromRenderDesc(_other: RenderDesc): void;
     fromInstance(_child: Instance): void;
-    compileResults(_renderer: THREE.WebGLRenderer, _scene: THREE.Scene): Promise<THREE.Mesh[] | Response | undefined>;
+    compileResults(_renderer: THREE.WebGLRenderer, _scene: THREE.Scene): Promise<THREE.Object3D[] | Response | undefined>;
     updateResults(): void;
+    static shouldRenderInstance(_instance: Instance): boolean;
+    static register(): void;
+    static(): typeof RenderDesc;
 }
 
 export declare function replaceBodyPart(rig: Instance, child: Instance): void;
@@ -3276,6 +3307,7 @@ export declare class SoundWrapper extends InstanceWrapper {
     get data(): SoundWrapperData;
     created(): void;
     _updateVolume(): void;
+    setPlaying(value: boolean): void;
     playSource(): void;
     Play(): void;
     Stop(): void;