roavatar-renderer 1.4.0 → 1.4.1

package/dist/index.d.ts

@@ -6,14 +6,19 @@ export declare const AbbreviationToFaceControlProperty: {
     [K in string]: string;
 };
 
+/** @category Outfit */
 export declare const AccessoryAssetTypes: string[];
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class AccessoryDescriptionWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
     setup(): void;
 }
 
+/** @category Outfit */
 export declare const accessoryRefinementLowerBounds: {
     [K in string]: {
         "position": {
@@ -28,8 +33,10 @@ export declare const accessoryRefinementLowerBounds: {
     };
 };
 
+/** @category Outfit */
 export declare const accessoryRefinementTypes: number[];
 
+/** @category Outfit */
 export declare const accessoryRefinementUpperBounds: typeof accessoryRefinementLowerBounds;
 
 export declare const AccessoryType: {
@@ -55,6 +62,9 @@ export declare const AccessoryType: {
     Eyelash: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class AccessoryWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -63,8 +73,12 @@ export declare class AccessoryWrapper extends InstanceWrapper {
     AccessoryBuildWeld(): void;
 }
 
+/** @category Outfit */
 export declare const ActualBundleTypes: string[];
 
+/**
+ * @category Mesh
+ */
 export declare function add(v0: Vec3, v1: Vec3): Vec3;
 
 export declare const AllAccessorySorts: ItemSort[];
@@ -81,8 +95,12 @@ export declare const AllCharacterSorts: ItemSort[];
 
 export declare const AllClothingSorts: ItemSort[];
 
+/** @category Outfit */
 export declare const AllHeadShapes: string[];
 
+/**
+ * @category DataModel
+ */
 export declare const AllInstances: Instance[];
 
 export declare const AlphaMode: {
@@ -91,6 +109,9 @@ export declare const AlphaMode: {
     TintMask: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class AnimationConstraintWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -172,6 +193,9 @@ export declare class AnimationTrack {
 
 declare type AnimationTrackType = "Sequence" | "Curve";
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class AnimatorWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -180,15 +204,15 @@ export declare class AnimatorWrapper extends InstanceWrapper {
     get data(): AnimatorWrapperData;
     updateToolAnimation(rig: Instance): void;
     updateToolConnections(): void;
-    _pickRandom(entries: AnimationSetEntry[]): AnimationSetEntry;
-    _getTrack(id: string): AnimationTrack | undefined;
-    _switchAnimation(name: string): boolean;
+    private _pickRandom;
+    private _getTrack;
+    private _switchAnimation;
     stopMoodAnimation(): void;
-    _switchMoodAnimation(name: string): boolean;
+    private _switchMoodAnimation;
     stopToolAnimation(): void;
-    _switchToolAnimation(name: string): boolean;
+    private _switchToolAnimation;
     isValidTrackForSet(track: AnimationTrack, name: string): boolean;
-    _fixUnloaded(): void;
+    private _fixUnloaded;
     restPose(includeMotors?: boolean, includeFACS?: boolean): void;
     renderAnimation(addTime?: number, forceTime?: number, forceKeyframe?: number): void;
     getCurrentAnimationTrack(): AnimationTrack | undefined;
@@ -216,6 +240,10 @@ export declare const animNamesR15: AnimationSet;
 
 export declare const animNamesR6: AnimationSet;
 
+/**
+ * Contains all API methods
+ * @category API
+ */
 export declare const API: {
     Misc: {
         startCurrentlyLoadingAssets: () => void;
@@ -320,6 +348,7 @@ export declare const API: {
 
 export declare function arrayBufferToBase64(buffer: ArrayBuffer): string;
 
+/** @category Outfit */
 export declare class Asset {
     id: number;
     name: string;
@@ -335,6 +364,7 @@ export declare class Asset {
     setOrder(order: number): void;
 }
 
+/** @category Outfit */
 export declare type AssetJson = {
     id?: number;
     name?: string;
@@ -344,6 +374,7 @@ export declare type AssetJson = {
     supportsHeadShapes?: boolean;
 };
 
+/** @category Outfit */
 export declare class AssetMeta {
     version: number;
     order?: number;
@@ -359,6 +390,7 @@ export declare class AssetMeta {
     fromJson(assetMetaJson: AssetMetaJson): void;
 }
 
+/** @category Outfit */
 export declare type AssetMetaJson = {
     version?: number;
     position?: VecXYZ | Vecxyz | null;
@@ -370,6 +402,7 @@ export declare type AssetMetaJson = {
     staticFacialAnimation?: boolean;
 };
 
+/** @category Outfit */
 export declare class AssetType {
     _id: number;
     name: string;
@@ -384,13 +417,16 @@ export declare class AssetType {
     get id(): number;
 }
 
+/** @category Outfit */
 export declare type AssetTypeJson = {
     id?: number;
     name?: string;
 };
 
+/** @category Outfit */
 export declare const AssetTypeNameToId: Map<string, number>;
 
+/** @category Outfit */
 export declare const AssetTypes: string[];
 
 export declare const AssetTypeToAccessoryType: {
@@ -421,6 +457,9 @@ export declare const AssetTypeToMakeupType: {
     EyeMakeup: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class AttachmentWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -428,6 +467,7 @@ export declare class AttachmentWrapper extends InstanceWrapper {
     getWorldCFrame(): CFrame;
 }
 
+/** @category API */
 export declare class Authentication {
     TOKEN?: string;
     SessionUUID?: string;
@@ -486,14 +526,22 @@ export declare interface AvatarInventory_Result {
     nextPageToken: string | null;
 }
 
+/** @category Outfit */
 export declare type AvatarType = "R6" | "R15";
 
+/** @category Outfit */
 export declare const AvatarType: {
     [K in AvatarType]: AvatarType;
 };
 
+/**
+ * @category Mesh
+ */
 export declare function averageVec3(vecs: Vec3[]): Vec3;
 
+/**
+ * @category Mesh
+ */
 export declare function barycentric(p: Vec3, triangle: Triangle): Vec3;
 
 export declare function base64ToArrayBuffer(base64: string): ArrayBuffer;
@@ -511,6 +559,14 @@ declare class BaseKeyframeGroup {
     getHigherKeyframe(time: number): BaseKeyframe | null;
 }
 
+/**
+ * @category Outfit
+ */
+export declare type BodyColor3Name = "headColor3" | "torsoColor3" | "rightArmColor3" | "leftArmColor3" | "rightLegColor3" | "leftLegColor3";
+
+/**
+ * @category Outfit
+ */
 export declare class BodyColor3s {
     colorType: ColorType;
     headColor3: string;
@@ -543,6 +599,9 @@ declare type BodyColor3sJson = {
     leftLegColor3?: string;
 };
 
+/**
+ * @category Outfit
+ */
 export declare class BodyColors {
     colorType: ColorType;
     headColorId: number;
@@ -576,6 +635,9 @@ declare type BodyColorsJson = {
     leftLegColorId?: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class BodyColorsWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -593,6 +655,9 @@ export declare const BodyPart: {
     RightLeg: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class BodyPartDescriptionWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -607,8 +672,12 @@ export declare const BodyPartNameToEnum: {
     [K in string]: number;
 };
 
+/**
+ * @category Mesh
+ */
 declare type Bounds = [Vec3, Vec3];
 
+/** @category Outfit */
 export declare const BrickColors: {
     [K in number]: string;
 };
@@ -619,10 +688,16 @@ export declare function browserSendMessage(data: {
     [K in string]: string;
 }): Promise<any>;
 
+/**
+ * @category Mesh
+ */
 export declare function buildFaceKD(mesh: FileMesh): KDNode | null;
 
 export declare function BuildJoints(self: RigData): void;
 
+/**
+ * @category Mesh
+ */
 export declare function buildVertKD(mesh: FileMesh): KDNode | null;
 
 export declare interface BundleDetails_Result {
@@ -663,6 +738,7 @@ export declare interface BundleDetails_Result {
     unitsAvailableForConsumption: number;
 }
 
+/** @category Outfit */
 export declare const BundleTypes: string[];
 
 export declare const CACHE: {
@@ -678,10 +754,14 @@ export declare const CACHE: {
     UserInfo: undefined;
 };
 
+/**
+ * @category Mesh
+ */
 export declare function calculateMagnitude3D(x: number, y: number, z: number): number;
 
 export declare function calculateMotor6Doffset(motor: Instance, includeTransform?: boolean): CFrame;
 
+/** @category Outfit */
 export declare const CatalogBundleTypes: string[];
 
 export declare const CategoryDictionary: {
@@ -692,6 +772,9 @@ export declare const CategoryDictionary: {
     };
 };
 
+/**
+ * @category DataModelProperty
+ */
 export declare class CFrame {
     Position: Vec3;
     Orientation: Vec3;
@@ -709,6 +792,9 @@ export declare class CFrame {
     isSame(other: CFrame): boolean;
 }
 
+/**
+ * @category Mesh
+ */
 export declare function clamp(v0: Vec3, lower: Vec3, higher: Vec3): Vec3;
 
 export declare function cleanString(inputString: string): string;
@@ -717,16 +803,21 @@ export declare function clonePrimitiveArray<T>(arr: T[]): any[];
 
 export declare function cloneSearch_Payload(data: Search_Payload): Search_Payload;
 
+/**
+ * @category Mesh
+ */
 export declare function closestPointTriangle(p: Vec3, triangle: Triangle): Vec3;
 
-declare type ClothingDiffType = "Shirt" | "Pants" | "GraphicTShirt";
-
+/**
+ * @category DataModelProperty
+ */
 export declare class Color3 {
     R: number;
     G: number;
     B: number;
     constructor(R?: number, G?: number, B?: number);
     clone(): Color3;
+    isSame(other: Color3): boolean;
     toColor3uint8(): Color3uint8;
     multiply(vec3: Color3): Color3;
     divide(vec3: Color3): Color3;
@@ -734,6 +825,9 @@ export declare class Color3 {
     minus(vec3: Color3): Color3;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class Color3uint8 {
     R: number;
     G: number;
@@ -743,24 +837,38 @@ export declare class Color3uint8 {
     toColor3(): Color3;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class ColorSequence {
     keypoints: ColorSequenceKeypoint[];
     static fromColor(color: Color3): ColorSequence;
     clone(): ColorSequence;
+    isSame(other: ColorSequence): boolean;
     getLowerKey(time: number): ColorSequenceKeypoint | null;
     getHigherKey(time: number): ColorSequenceKeypoint | null;
     getValue(time: number): Color3;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class ColorSequenceKeypoint {
     time: number;
     value: Color3;
     constructor(time: number, r: number, g: number, b: number);
     clone(): ColorSequenceKeypoint;
+    isSame(other: ColorSequenceKeypoint): boolean;
 }
 
+/**
+ * @category Outfit
+ */
 export declare type ColorType = "BrickColor" | "Color3";
 
+/**
+ * @category DataModel
+ */
 export declare class Connection {
     Connected: boolean;
     _callback: (...args: unknown[]) => unknown;
@@ -769,6 +877,9 @@ export declare class Connection {
     Disconnect(): void;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class Content {
     sourceType: number;
     uri?: string;
@@ -827,8 +938,14 @@ declare class COREMESH {
 
 export declare function createContentMap(): void;
 
+/**
+ * @category Mesh
+ */
 export declare function createWeightsForMeshChunked(mesh: FileMesh, ref_mesh: FileMesh): WeightChunk[];
 
+/**
+ * @category Mesh
+ */
 export declare function cross(a: Vec3, b: Vec3): Vec3;
 
 export declare const DataType: {
@@ -861,6 +978,9 @@ export declare const DataType: {
     NonSerializable: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class DecalWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -881,8 +1001,10 @@ export declare const DefaultAnimationsR6: typeof DefaultAnimations;
 
 export declare function DefaultGetWorkerFunc(): Worker;
 
+/** @category Outfit */
 export declare const defaultPantAssetIds: number[];
 
+/** @category Outfit */
 export declare const defaultPantTemplateAssetIds: number[];
 
 export declare const DefaultSearchData: {
@@ -891,10 +1013,15 @@ export declare const DefaultSearchData: {
     };
 };
 
+/** @category Outfit */
 export declare const defaultShirtAssetIds: number[];
 
+/** @category Outfit */
 export declare const defaultShirtTemplateAssetIds: number[];
 
+/**
+ * @category Mesh
+ */
 export declare function deformReferenceToBaseBodyParts(reference: FileMesh, targetCages: FileMesh[], targetSizes: Vector3[], targetCFrames: CFrame[]): number[];
 
 export declare function deg(radians: number): number;
@@ -908,16 +1035,28 @@ declare class DisposableDesc {
 
 export declare function disposeMesh(scene: THREE.Scene, mesh: THREE.Mesh): void;
 
+/**
+ * @category Mesh
+ */
 export declare function distance(v0: Vec3, v1: Vec3): number;
 
+/**
+ * @category Mesh
+ */
 export declare function divide(v0: Vec3, v1: Vec3): Vec3;
 
+/**
+ * @category Mesh
+ */
 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
+ */
 declare class Event_2 {
     _callbacks: ((...args: unknown[]) => unknown)[];
     Connect(callback: (...args: unknown[]) => unknown): Connection;
@@ -927,16 +1066,31 @@ declare class Event_2 {
 }
 export { Event_2 as Event }
 
+/**
+ * @category Exposer
+ */
 export declare function exposeAPI(): void;
 
+/**
+ * @category Exposer
+ */
 export declare function exposeFLAGS(): void;
 
+/**
+ * @category Exposer
+ */
 export declare function exposeMesh(): void;
 
+/**
+ * @category Exposer
+ */
 export declare function exposeThumbnailGenerator(): void;
 
 export declare const FaceControlNames: string[];
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class FaceControlsWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -971,6 +1125,10 @@ declare class FACS {
     clone(): FACS;
 }
 
+/**
+ * Obtained from a call to API.Asset.GetMesh()
+ * @category Mesh
+ */
 export declare class FileMesh {
     version: string;
     facsDataFormat: number;
@@ -1029,10 +1187,14 @@ export declare class FileMeshSubset {
     clone(): FileMeshSubset;
 }
 
+/** @category Mesh */
 export declare function fileMeshToTHREEGeometry(mesh: FileMesh, canIncludeSkinning?: boolean, forceVertexColor?: Vector3): THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>;
 
 export declare function FindFirstMatchingAttachment(attachmentName: string, rig: Instance): Instance | null;
 
+/**
+ * @category FLAGS
+ */
 export declare const FLAGS: {
     HAIR_IS_BODYPART: boolean;
     AVATAR_JOINT_UPGRADE: boolean;
@@ -1102,14 +1264,80 @@ declare class FloatCurveKey {
     rightTangent?: number;
 }
 
+/**
+ * @category Mesh
+ */
 export declare function floor(v0: Vec3): Vec3;
 
+/** @category Outfit */
 export declare const FullBodyColors: string[];
 
+/**
+ * @category Mesh
+ */
 export declare function gaussian_rbf(v0: Vec3, v1: Vec3, sigma?: number): number;
 
+/**
+ * Generates a 2d or 3d thumbnail of a model/similar instance
+ * @param auth Authentication
+ * @param renderScene Scene to render inside, do note the scene appearance is not populated automaticall, use setupThumbnailScene()
+ * @param model Model to render
+ * @param size Size of the resulting image, ignored for 3d thumbnails
+ * @param type Type of thumbnail, "png" | "webp" | "gltf"
+ * @param quality Quality of image, with 1 being max-
+ * @param gltfAutoDownload Automatically download gltf file
+ * @returns ThumbnailResult, always a string for 2d thumbnails, 3d can be ArrayBuffer (glb, binary) or {[key: string]: unknown} (gltf, json)
+ *
+ * @category ThumbnailGenerator
+ *
+ * @example
+ * **Example of generating thumbnail of accessory**
+ * ```ts
+ * //config
+ * const ASSETID = 1039433
+ *
+ * //code
+ * FLAGS.ANIMATE_SKELETON = false
+ * FLAGS.UPDATE_SKELETON = true
+ *
+ * const rScene = RBXRenderer.addScene()
+ * setupThumbnailScene(rScene)
+ *
+ * const accessoryrbx = await API.Asset.GetRBX(`rbxassetid://${ASSETID}`, {"Roblox-AssetFormat":"avatar_meshpart_accessory"})
+ * const accessory = accessoryrbx.generateTree().GetChildren()[0]
+ * const handle = accessory.FindFirstChildOfClass("MeshPart")
+ * const cf = handle.Prop("CFrame")
+ * if (!accessory.FindFirstChildOfClass("Camera")) cf.Position = [0,0,0]
+ *
+ * const result = await generateModelThumbnail(new Authentication(), rScene, accessory, [1000,1000], "webp", 0.99)
+ * console.log(result)
+ * console.log(result.length)
+ * ```
+ */
 export declare function generateModelThumbnail(auth: Authentication, renderScene: RBXRendererScene, model: Instance, size?: Vec2, type?: ThumbnailType, quality?: number, gltfAutoDownload?: boolean): Promise<ThumbnailResult>;
 
+/**
+ * Generates a 2d or 3d thumbnail of an outfit
+ * @param auth Authentication
+ * @param outfit Outfit to render
+ * @param size Size of the resulting image, ignored for 3d thumbnails
+ * @param type Type of thumbnail, "png" | "webp" | "gltf"
+ * @param quality Quality of image, with 1 being max
+ * @param gltfAutoDownload Automatically download gltf file
+ * @returns ThumbnailResult, always a string for 2d thumbnails, 3d can be ArrayBuffer (glb, binary) or {[key: string]: unknown} (gltf, json)
+ *
+ * @category ThumbnailGenerator
+ *
+ * @example
+ * **Example on generating 1000x1000 webp thumbnail for blank outfit**
+ * ```ts
+ * const outfit = new Outfit()
+ * 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
+ * console.log(result)
+ * ```
+ */
 export declare function generateOutfitThumbnail(auth: Authentication, outfit: Outfit, size?: Vec2, type?: ThumbnailType, quality?: number, gltfAutoDownload?: boolean): Promise<ThumbnailResult>;
 
 export declare function generateUUIDv4(): string;
@@ -1122,6 +1350,9 @@ export declare function getCameraCFrameForHeadshotCustomized(rig: Instance, fov:
 
 export declare function getCameraOffset(fov: number, extentsSize: Vector3): number;
 
+/**
+ * @category Mesh
+ */
 export declare function getDistIndexArray(ref: FileMesh, dist: FileMesh): (number | undefined)[];
 
 export declare function getExtents(cframe: CFrame, parts: Instance[]): [Vector3, Vector3];
@@ -1144,6 +1375,9 @@ export declare interface GetInfoForId_Result {
     "displayName": string;
 }
 
+/**
+ * @category Mesh
+ */
 export declare function getOffsetArray(inner: FileMesh, outer: FileMesh): ([Vec3, THREE.Quaternion, number] | undefined)[];
 
 export declare function getOriginalAttachmentOrientation(attachment: Instance): Vector3;
@@ -1194,16 +1428,36 @@ export declare interface GetUserOutfits_Result {
     }[];
 }
 
+/**
+ * @category Mesh
+ */
 export declare function getUVtoIndexMap(mesh: FileMesh): Map<number, number>;
 
+/**
+ * @category Mesh
+ */
 export declare function getUVtoIndicesMap(mesh: FileMesh): Map<number, number[]>;
 
 export declare function getWorkerOnMessage(): (event: MessageEvent) => void;
 
+/**
+ * @category InstanceWrapper
+ */
+export declare function GetWrapperForInstance(instance: Instance): InstanceWrapper | undefined;
+
+/**
+ * @category Mesh
+ */
 export declare function hashVec2(x: number, y: number): number;
 
+/**
+ * @category Mesh
+ */
 export declare function hashVec3(x: number, y: number, z: number, distance: number): number;
 
+/**
+ * @category Mesh
+ */
 export declare function hashVec3Safe(a: number | bigint, b: number | bigint, c: number | bigint): bigint;
 
 export declare function hasSameVal(instance0: Instance, instance1: Instance, propertyName: string): boolean;
@@ -1218,6 +1472,9 @@ export declare function hexToRgb(hex: string): {
     b: number;
 } | null;
 
+/**
+ * @category Mesh
+ */
 export declare class HSR {
     rayCount: number;
     rayLength: number;
@@ -1243,6 +1500,9 @@ declare class HSRAVIS {
 
 declare type HumanoidDescriptionDiff = "scale" | "bodyColor" | "animation" | "bodyPart" | "clothing" | "face" | "accessory" | "makeup" | "gear" | "staticFacialAnimation";
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -1266,40 +1526,45 @@ export declare class HumanoidDescriptionWrapper extends InstanceWrapper {
     getBodyPartId(bodyPart: number): bigint;
     getBodyPartHeadShape(bodyPart: number): string;
     createRigData(): RigData | undefined;
+    /**
+     * Update the data of the HumanoidDescription to match that inside an Outfit
+     * @param outfit
+     * @returns HumanoidDescription or Response if it fails
+     */
     fromOutfit(outfit: Outfit): Promise<Instance | Response>;
-    _applyScale(humanoid: Instance): void;
-    _applyBodyColors(humanoid: Instance): void;
+    private _applyScale;
+    private _applyBodyColors;
     /**
      * @returns undefined on success
      */
-    _applyBodyParts(humanoid: Instance, toChange?: number[]): Promise<Response | undefined>;
+    private _applyBodyParts;
     /**
      * @returns undefined on success
      */
-    _applyClothing(humanoid: Instance, toChange?: ClothingDiffType[]): Promise<undefined | Response>;
+    private _applyClothing;
     /**
      * @returns undefined on success
      */
-    _applyFace(humanoid: Instance): Promise<undefined | Response>;
+    private _applyFace;
     /**
      * @returns undefined on success
      */
-    _applyGear(humanoid: Instance): Promise<undefined | Response>;
-    _inheritAccessoryReferences(originalW: HumanoidDescriptionWrapper): void;
-    _inheritMakeupReferences(originalW: HumanoidDescriptionWrapper): void;
+    private _applyGear;
+    private _inheritAccessoryReferences;
+    private _inheritMakeupReferences;
     /**
      * @returns undefined on success
      */
-    _applyAccessories(humanoid: Instance, originalW?: HumanoidDescriptionWrapper, addedIds?: bigint[], removedIds?: bigint[]): Promise<undefined | Response>;
-    _applyMakeup(humanoid: Instance, originalW?: HumanoidDescriptionWrapper, addedIds?: bigint[], removedIds?: bigint[]): Promise<undefined | Response>;
+    private _applyAccessories;
+    private _applyMakeup;
     /**
      * @returns undefined on success
      */
-    _applyAnimations(humanoid: Instance, toChange?: AnimationProp[]): Promise<undefined | Response>;
+    private _applyAnimations;
     /**
      * @returns undefined on success
      */
-    _applyAll(humanoid: Instance): Promise<undefined | Response>;
+    private _applyAll;
     /**
      * @returns Instance on success
      */
@@ -1313,8 +1578,14 @@ export declare const HumanoidRigType: {
 
 export declare function imageUrlToDataUrl(imageUrl: string): Promise<string>;
 
+/**
+ * @category Mesh
+ */
 export declare function inheritSkeleton(to: FileMesh, from: FileMesh): void;
 
+/**
+ * @category Mesh
+ */
 export declare function inheritUV(to: FileMesh, from: FileMesh): void;
 
 declare class INST {
@@ -1326,18 +1597,26 @@ declare class INST {
     clone(): INST;
 }
 
+/**
+ * @category DataModel
+ */
 export declare class Instance {
-    _id: number;
+    private _id;
+    /**
+     * @deprecated Use .Prop("Name") instead
+     */
     _name?: string;
     className: string;
+    /**
+     * @deprecated Do not use this directly
+     */
     _properties: Map<string, Property>;
-    _referencedBy: Instance[];
-    _connectionReferences: Connection[];
-    children: Instance[];
+    private _referencedBy;
+    private _connectionReferences;
+    private _children;
     parent?: Instance;
     destroyed: boolean;
-    hasWrappered: boolean;
-    canGC: boolean;
+    private _hasWrappered;
     classID?: number;
     objectFormat?: number;
     ChildAdded: Event_2;
@@ -1358,7 +1637,21 @@ export declare class Instance {
     fixPropertyName(name: string): string;
     setProperty(name: string, value: unknown, supressEvents?: boolean): void;
     HasProperty(name: string): boolean;
+    /**
+     * Returns the value of a property
+     * @param name Name of property
+     * @returns Property's value
+     *
+     * @throws When property doesn't exist, PropOrDefault is a safer alternative
+     */
     Property(name: string): unknown;
+    /**
+     * Returns the value of a property
+     * @param name Name of property
+     * @returns Property's value
+     *
+     * @throws When property doesn't exist, PropOrDefault is a safer alternative
+     */
     Prop(name: string): unknown;
     PropOrDefault(name: string, def: unknown): unknown;
     PropertyType(name: string): number | undefined;
@@ -1376,7 +1669,13 @@ export declare class Instance {
     preRender(): void;
 }
 
-declare class InstanceWrapper {
+/**
+ * Virtual class for all instance wrapper's
+ *
+ * @category InstanceWrapper
+ * @virtual
+ */
+export declare class InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
     instance: Instance;
@@ -1384,8 +1683,17 @@ declare class InstanceWrapper {
     setup(): void;
     static(): typeof InstanceWrapper;
     static register(): void;
+    /**
+     * @virtual
+     */
     created(): void;
+    /**
+     * @virtual
+     */
     destroy(): void;
+    /**
+     * @virtual
+     */
     preRender(): void;
 }
 
@@ -1447,6 +1755,7 @@ export declare interface ItemDetails_Result {
     data: ItemDetail_Result[];
 }
 
+/** @category Outfit */
 export declare class ItemInfo {
     itemType: ItemType;
     type: string;
@@ -1481,14 +1790,28 @@ declare class KDNode {
     constructor(point: Vec3, index: number, axis: number);
 }
 
+/**
+ * @deprecated Superseded by RBFDeformerPatch
+ * @category Mesh
+ */
 export declare function layerClothingChunked(mesh: FileMesh, ref_mesh: FileMesh, dist_mesh: FileMesh, cacheId?: string): void;
 
+/**
+ * @deprecated Superseded by RBFDeformerPatch
+ * @category Mesh
+ */
 export declare function layerClothingChunkedNormals(mesh: FileMesh, ref_mesh: FileMesh, dist_mesh: FileMesh, cacheId?: string): void;
 
+/**
+ * @deprecated Superseded by RBFDeformerPatch
+ * @category Mesh
+ */
 export declare function layerClothingChunkedNormals2(mesh: FileMesh, ref_mesh: FileMesh, dist_mesh: FileMesh, cacheId?: string): void;
 
+/** @category Outfit */
 export declare const LayeredAssetTypes: string[];
 
+/** @category Outfit */
 export declare const LayeredClothingAssetOrder: {
     [K in number]: number;
 };
@@ -1623,10 +1946,17 @@ export declare interface Look_Result {
 
 export declare const magic = "<roblox!";
 
+/**
+ * @category Mesh
+ */
 export declare function magnitude(v: Vec3): number;
 
+/** @category Outfit */
 export declare const MakeupAssetTypes: string[];
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class MakeupDescriptionWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -1639,6 +1969,9 @@ export declare const MakeupType: {
     Eye: number;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class ManualWeldWrapper extends WeldWrapper {
     static className: string;
 }
@@ -1673,28 +2006,41 @@ export declare interface MarketplaceWidgets_Result {
     configuration: unknown;
 }
 
+/** @category Mesh */
 export declare type Mat3x3 = [number, number, number, number, number, number, number, number, number];
 
+/** @category Mesh */
 export declare type Mat4x4 = [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];
 
 export declare function mathRandom(min: number, max: number): number;
 
+/** @category Outfit */
 export declare const MaxOneOfAssetTypes: string[];
 
 /**
  * @deprecated This is incorrect
+ * @category Outfit
  */
 export declare const MaxPerAsset: {
     [K in string]: number;
 };
 
+/**
+ * @category Mesh
+ */
 export declare function mergeTargetWithReference(reference: FileMesh, target: FileMesh, targetSize: Vector3, targetCFrame: CFrame, ignoredIndices?: number[]): number[];
 
+/**
+ * @category Mesh
+ */
 export declare type MeshChunk = {
     pos: Vec3;
     indices: number[];
 };
 
+/**
+ * @category Mesh
+ */
 declare class MeshCollider {
     mesh: FileMesh;
     octree: OctreeNode<number>;
@@ -1714,10 +2060,17 @@ export declare const MeshType: {
     Wedge: number;
 };
 
+/** @category Outfit */
 export declare const minimumDeltaEBodyColorDifference = 11.4;
 
+/**
+ * @category Mesh
+ */
 export declare function minus(v0: Vec3, v1: Vec3): Vec3;
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class ModelWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -1725,6 +2078,9 @@ export declare class ModelWrapper extends InstanceWrapper {
     GetModelCFrame(): CFrame;
 }
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class Motor6DWrapper extends WeldWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -1734,13 +2090,25 @@ export declare class Motor6DWrapper extends WeldWrapper {
 /**
  * @deprecated Use mountElement instead
  * @param container
+ * @category Renderer
  */
 export declare function mount(container: HTMLDivElement): void;
 
+/**
+ * Mounting function for use with React
+ * @param container Container to mount inside
+ * @category Renderer
+ */
 export declare function mountElement(container: HTMLDivElement): void;
 
+/**
+ * @category Mesh
+ */
 export declare function multiply(v0: Vec3, v1: Vec3): Vec3;
 
+/**
+ * @category Mesh
+ */
 export declare function multiplyMatrixVector(m: Mat3x3, v: Vec3): Vec3;
 
 export declare interface NavigationMenuItems {
@@ -1828,8 +2196,14 @@ export declare const NormalId: {
     Front: number;
 };
 
+/**
+ * @category Mesh
+ */
 export declare function normalize(v: Vec3): Vec3;
 
+/**
+ * @category DataModelProperty
+ */
 export declare class NumberRange {
     Min: number;
     Max: number;
@@ -1838,21 +2212,29 @@ export declare class NumberRange {
     isSame(other: NumberRange): boolean;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class NumberSequence {
     keypoints: NumberSequenceKeypoint[];
     constructor(keypoints?: NumberSequenceKeypoint[]);
     clone(): NumberSequence;
+    isSame(other: NumberSequence): boolean;
     getLowerKey(time: number): NumberSequenceKeypoint | null;
     getHigherKey(time: number): NumberSequenceKeypoint | null;
     getValue(time: number, seed: number): number;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class NumberSequenceKeypoint {
     time: number;
     value: number;
     envelope: number;
     constructor(time: number, value: number, envelope?: number);
     clone(): NumberSequenceKeypoint;
+    isSame(other: NumberSequenceKeypoint): boolean;
 }
 
 export declare const ObjectDescClassTypes: string[];
@@ -1882,10 +2264,20 @@ declare class OctreeNode<T> {
     collideRay(ray: Ray_2): OctreeNode<T>[];
 }
 
+/**
+ * @category Mesh
+ */
 export declare function offsetMesh(mesh: FileMesh, cframe: CFrame): void;
 
+/**
+ * @category Mesh
+ */
 export declare function offsetMeshWithRotation(mesh: FileMesh, cframe: CFrame): void;
 
+/**
+ * Usually obtained from API
+ * @category Outfit
+ */
 export declare class Outfit {
     scale: Scale;
     bodyColors: BodyColors | BodyColor3s;
@@ -1921,7 +2313,9 @@ export declare class Outfit {
     isValid(): boolean;
     getValidationIssues(): ValidationIssue[];
     toHumanoidDescription(): Promise<Document | null>;
+    /** @deprecated */
     fromHumanoidDescription(rootDocument: Document): Promise<void>;
+    /** @deprecated */
     downloadHumanoidDescription(): Promise<void>;
     getAssetsJson(removeNotOwnedAssets?: boolean): AssetJson[];
     containsAsset(assetId: number): boolean;
@@ -1959,12 +2353,17 @@ declare type OutfitJson = {
     scales?: ScaleJson;
 };
 
+/** @category Outfit */
 export declare type OutfitOrigin = "WebAvatar" | "WebOutfit" | "Other" | "Look";
 
+/** @category Outfit */
 export declare const OutfitOrigin: {
     [K in OutfitOrigin]: OutfitOrigin;
 };
 
+/**
+ * @category Renderer
+ */
 export declare class OutfitRenderer {
     auth: Authentication;
     outfit: Outfit;
@@ -2067,6 +2466,9 @@ declare class PROP {
     clone(): PROP;
 }
 
+/**
+ * @category DataModel
+ */
 export declare class Property {
     name?: string;
     typeID?: number;
@@ -2117,18 +2519,27 @@ declare class QuantizedTransform {
 
 export declare function rad(degrees: number): number;
 
+/**
+ * @category DataModelProperty
+ */
 export declare class Ray {
     Origin: Vec3;
     Direction: Vec3;
     clone(): Ray;
 }
 
+/**
+ * @category Mesh
+ */
 declare class Ray_2 {
     origin: Vec3;
     end: Vec3;
     constructor(origin: Vec3, end: Vec3);
 }
 
+/**
+ * @category Mesh
+ */
 export declare class RBFDeformerPatch {
     mesh: FileMesh;
     refVerts: Float32Array;
@@ -2160,6 +2571,10 @@ declare function RBLXPatch(url: string, auth: Authentication, body: any, attempt
 
 declare function RBLXPost(url: string, auth: Authentication | undefined, body: any, attempt?: number, method?: string): Promise<Response>;
 
+/**
+ * Obtained from a call to API.Asset.GetRBX()
+ * @category DataModel
+ */
 export declare class RBX {
     classCount: number;
     instanceCount: number;
@@ -2187,9 +2602,18 @@ export declare class RBX {
     fromXML(xml: Document): void;
     fromBuffer(buffer: ArrayBuffer): void;
     fromInstance(root: Instance): ArrayBuffer;
+    /**
+     * Generates if needed hierarchy and returns root instance
+     * @returns Root instance
+     */
     generateTree(): Instance;
 }
 
+/**
+ * A singleton, intialized by calling RBXRenderer.fullSetup()
+ *
+ * @category Renderer
+ */
 export declare class RBXRenderer {
     static orbitControlsTarget: Vec3;
     static scenes: RBXRendererScene[];
@@ -2289,6 +2713,10 @@ export declare class RBXRenderer {
     static exportScene(renderScene?: RBXRendererScene): void;
 }
 
+/**
+ * Created by calling RBXRenderer.addScene()
+ * @category Renderer
+ */
 export declare class RBXRendererScene {
     scene: THREE.Scene;
     camera: THREE.PerspectiveCamera;
@@ -2313,7 +2741,9 @@ export declare class RBXRendererScene {
     ambientLight?: THREE.AmbientLight;
     directionalLight?: THREE.DirectionalLight;
     directionalLight2?: THREE.DirectionalLight;
+    /** Forces viewport to be within bounds */
     setRect(bounds: DOMRect): void;
+    /** Makes viewport size 0x0, invisible */
     noRect(): void;
     destroy(): void;
     exportGLTF(name?: string, autoDownload?: boolean): Promise<ArrayBuffer | {
@@ -2358,6 +2788,7 @@ declare class RBXSimpleView {
 
 export declare function RegisterWrappers(): void;
 
+/** @category Outfit */
 export declare const RegularBodyColors: string[];
 
 /**
@@ -2371,6 +2802,8 @@ declare class RenderDesc extends DisposableDesc {
     isSame(_other: RenderDesc): boolean;
     needsRegeneration(_other: RenderDesc): boolean;
     fromRenderDesc(other: RenderDesc): void;
+    transferFrom(other: RenderDesc): void;
+    virtualTransferFrom(_other: RenderDesc): void;
     virtualFromRenderDesc(_other: RenderDesc): void;
     fromInstance(_child: Instance): void;
     compileResults(_renderer: THREE.WebGLRenderer, _scene: THREE.Scene): Promise<THREE.Mesh[] | Response | undefined>;
@@ -2442,6 +2875,9 @@ export declare type SaleLocationType = "ShopOnly" | "ShopAndAllExperiences" | "E
 
 export declare function saveByteArray(data: BlobPart[] | undefined, name: string): void;
 
+/**
+ * @category Outfit
+ */
 export declare class Scale {
     height: number;
     width: number;
@@ -2478,10 +2914,19 @@ declare type ScaleJson = {
     bodyType?: number;
 };
 
+/**
+ * @category Mesh
+ */
 export declare function scaleMesh(mesh: FileMesh, scale: Vector3): void;
 
+/**
+ * @category Outfit
+ */
 export declare type ScaleName = "height" | "width" | "head" | "depth" | "proportion" | "bodyType";
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class ScriptWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -2548,6 +2993,12 @@ export declare interface Search_Result {
     }[];
 }
 
+/**
+ * Gives a scene the default appearance for thumbnails
+ * @param renderScene RBXRenderScene to setup
+ *
+ * @category ThumbnailGenerator
+ */
 export declare function setupThumbnailScene(renderScene: RBXRendererScene): void;
 
 declare class SimpleView {
@@ -2609,6 +3060,9 @@ export declare const SortTypes: {
     [K in string]: number | undefined;
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class SoundWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -2635,6 +3089,7 @@ export declare class SpecialInfo {
     constructor(type: string);
 }
 
+/** @category Outfit */
 export declare const SpecialLayeredAssetTypes: string[];
 
 export declare const StringBufferProperties: string[];
@@ -2669,6 +3124,9 @@ export declare interface ThumbnailsCustomization_Payload {
 
 export declare type ThumbnailType = "png" | "webp" | "gltf";
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class ToolWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -2677,6 +3135,7 @@ export declare class ToolWrapper extends InstanceWrapper {
     createWeld(): void;
 }
 
+/** @category Outfit */
 export declare const ToRemoveBeforeBundleType: {
     DynamicHead: string[];
     Shoes: string[];
@@ -2685,18 +3144,28 @@ export declare const ToRemoveBeforeBundleType: {
     MakeupLook: string[];
 };
 
+/**
+ * @category Mesh
+ */
 export declare function transferSkeleton(to: FileMesh, from: FileMesh): void;
 
 export declare function traverseRigCFrame(instance: Instance, includeTransform?: boolean, applyRoot?: boolean): CFrame;
 
 export declare function traverseRigInstance(instance: Instance): Instance[];
 
+/** @category Mesh */
 export declare type Triangle = [Vec3, Vec3, Vec3];
 
+/**
+ * @category Mesh
+ */
 export declare function triangleNormal(triangle: Triangle): Vec3;
 
 declare type TwoPoseCorrective = Vec2;
 
+/**
+ * @category DataModelProperty
+ */
 export declare class UDim {
     Scale: number;
     Offset: number;
@@ -2704,6 +3173,9 @@ export declare class UDim {
     clone(): UDim;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class UDim2 {
     X: UDim;
     Y: UDim;
@@ -2765,12 +3237,18 @@ declare type ValidationIssue = {
 
 declare type ValidationIssueType = "AccessoryLimit" | "LayeredLimit" | "OneOfTypeLimit" | "DuplicateId" | "NotWearable" | "MissingLayeredMeta" | "InvalidAsset" | "MakeupLimit";
 
+/** @category Mesh */
 export declare type Vec2 = [number, number];
 
+/** @category Mesh */
 export declare type Vec3 = [number, number, number];
 
+/** @category Mesh */
 export declare type Vec4 = [number, number, number, number];
 
+/**
+ * @category DataModelProperty
+ */
 export declare class Vector2 {
     X: number;
     Y: number;
@@ -2779,6 +3257,9 @@ export declare class Vector2 {
     isSame(other: Vector2): boolean;
 }
 
+/**
+ * @category DataModelProperty
+ */
 export declare class Vector3 {
     X: number;
     Y: number;
@@ -2811,21 +3292,34 @@ declare type Vecxyz = {
 
 export declare function versionToNumber(version: string): number;
 
+/**
+ * @category Mesh
+ */
 export declare function vertPosToChunkPos(pos: Vec3, meshSize: Vec3, widthSplit: number, heightSplit: number, depthSplit: number): Vec3;
 
 export declare function Wait(time: number): Promise<unknown>;
 
+/** @category Outfit */
 export declare const WearableAssetTypes: string[];
 
+/**
+ * @category Mesh
+ */
 export declare type WeightChunk = {
     meshChunk: MeshChunk;
     weights: number[];
 };
 
+/**
+ * @category Mesh
+ */
 export declare type WeightChunk3 = WeightChunk & {
     weights: Vec3[];
 };
 
+/**
+ * @category InstanceWrapper
+ */
 export declare class WeldWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];