roavatar-renderer 1.2.15 → 1.3.0

package/README.md

@@ -44,7 +44,7 @@ Basic example on how to load an avatar using OutfitRenderer (to make it simpler)
     document.body.appendChild(RBXRenderer.getRendererElement())
 
 //get avatar data for the user with id 1
-const outfit = API.Avatar.GetAvatarDetails(1)
+const outfit = await API.Avatar.GetAvatarDetails(1)
 if (!(outfit instanceof Outfit)) throw new Error("Failed to get outfit")
 
 //create renderer for outfit

package/dist/index.d.ts

@@ -55,6 +55,14 @@ export declare const AccessoryType: {
     Eyelash: number;
 };
 
+export declare class AccessoryWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+    created(): void;
+    AccessoryBuildWeld(): void;
+}
+
 export declare const ActualBundleTypes: string[];
 
 export declare function add(v0: Vec3, v1: Vec3): Vec3;
@@ -83,6 +91,12 @@ export declare const AlphaMode: {
     TintMask: number;
 };
 
+export declare class AnimationConstraintWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 export declare type AnimationProp = "ClimbAnimation" | "FallAnimation" | "IdleAnimation" | "JumpAnimation" | "MoodAnimation" | "RunAnimation" | "SwimAnimation" | "WalkAnimation" | "dance1" | "dance2" | "dance3" | "toolnone";
 
 export declare const AnimationPropToName: {
@@ -295,6 +309,10 @@ export declare const API: {
     PremiumFeatures: {
         GetSubscription: (userId: number) => Promise<Response | GetSubscription_Result>;
     };
+    RBLXGet: typeof RBLXGet;
+    RBLXPost: typeof RBLXPost;
+    RBLXDelete: typeof RBLXDelete;
+    RBLXPatch: typeof RBLXPatch;
 };
 
 export declare function arrayBufferToBase64(buffer: ArrayBuffer): string;
@@ -548,6 +566,14 @@ declare type BodyColorsJson = {
     leftLegColorId?: number;
 };
 
+export declare class BodyColorsWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+    created(): void;
+    update(): void;
+}
+
 export declare const BodyPart: {
     Head: number;
     Torso: number;
@@ -822,6 +848,12 @@ export declare const DataType: {
     NonSerializable: number;
 };
 
+export declare class DecalWrapper extends InstanceWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 /**
  * @deprecated
  */
@@ -978,6 +1010,8 @@ export declare class FileMeshSubset {
     clone(): FileMeshSubset;
 }
 
+export declare function fileMeshToTHREEGeometry(mesh: FileMesh, canIncludeSkinning?: boolean, forceVertexColor?: Vector3): THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>;
+
 export declare const FLAGS: {
     HAIR_IS_BODYPART: boolean;
     AVATAR_JOINT_UPGRADE: boolean;
@@ -1057,6 +1091,11 @@ export declare function getCameraCFrameForHeadshotCustomized(rig: Instance, fov:
 
 export declare function getDistIndexArray(ref: FileMesh, dist: FileMesh): (number | undefined)[];
 
+export declare function getExtents(cframe: CFrame, parts: Instance[]): [Vector3, Vector3];
+
+/**@deprecated this is SO broken */
+export declare function getExtentsForParts(parts: Instance[], includeTransform?: boolean): [Vector3, Vector3];
+
 export declare function getHeadExtents(rig: Instance): [Vector3, Vector3] | undefined;
 
 export declare interface GetInfoForId_Result {
@@ -1545,6 +1584,8 @@ export declare const magic = "<roblox!";
 
 export declare function magnitude(v: Vec3): number;
 
+export declare const MakeupAssetTypes: string[];
+
 export declare class MakeupDescriptionWrapper extends InstanceWrapper {
     static className: string;
     static requiredProperties: string[];
@@ -1557,6 +1598,10 @@ export declare const MakeupType: {
     Eye: number;
 };
 
+export declare class ManualWeldWrapper extends WeldWrapper {
+    static className: string;
+}
+
 export declare function mapNum(x: number, in_min: number, in_max: number, out_min: number, out_max: number): number;
 
 export declare interface MarketplaceWidget {
@@ -1639,6 +1684,12 @@ export declare class ModelWrapper extends InstanceWrapper {
     GetModelCFrame(): CFrame;
 }
 
+export declare class Motor6DWrapper extends WeldWrapper {
+    static className: string;
+    static requiredProperties: string[];
+    setup(): void;
+}
+
 /**
  * @deprecated Use mountElement instead
  * @param container
@@ -1878,7 +1929,6 @@ export declare class OutfitRenderer {
     outfit: Outfit;
     currentRig?: Instance; /**Instance for the Model of the current outfit */
     currentRigType: AvatarType;
-    rigPath: string;
     doCameraUpdateOnLoad: boolean; /**Makes camera update when new avatar has loaded */
     doCameraUpdate: boolean; /**Does camera update every frame */
     currentlyChangingRig: boolean;
@@ -1888,13 +1938,14 @@ export declare class OutfitRenderer {
     animationInterval?: NodeJS.Timeout;
     animationFPS: number;
     deltaTimeMultiplier: number;
+    renderScene: RBXRendererScene;
     /**
      * 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, should always be "roavatar://" as rig path is now controlled by FLAGS
+     * @param renderScene The scene the outfit should be rendered in
      */
-    constructor(auth: Authentication, outfit: Outfit, rigPath?: string);
+    constructor(auth: Authentication, outfit: Outfit, renderScene?: RBXRendererScene);
     /**
      * Updates the current rig, called internally by _updateOutfit()
      */
@@ -2060,6 +2111,14 @@ export declare class RBFDeformerPatch {
     deformMesh(): void;
 }
 
+declare function RBLXDelete(url: string, auth: Authentication, body: any, attempt?: number): Promise<Response>;
+
+declare function RBLXGet(url: string, headers?: any, includeCredentials?: boolean): Promise<Response>;
+
+declare function RBLXPatch(url: string, auth: Authentication, body: any, attempt?: number): Promise<Response>;
+
+declare function RBLXPost(url: string, auth: Authentication | undefined, body: any, attempt?: number, method?: string): Promise<Response>;
+
 export declare class RBX {
     classCount: number;
     instanceCount: number;
@@ -2091,42 +2150,47 @@ export declare class RBX {
 }
 
 export declare class RBXRenderer {
-    static isRenderingMesh: Map<Instance, boolean>;
-    static renderDescs: Map<Instance, RenderDesc>;
-    static destroyConnections: Map<Instance, Connection>;
-    static lookAwayVector: Vec3;
-    static lookAwayDistance: number;
     static orbitControlsTarget: Vec3;
-    static scene: THREE.Scene;
-    static camera: THREE.PerspectiveCamera;
-    static controls: OrbitControls | undefined;
+    static scenes: RBXRendererScene[];
+    static get firstScene(): RBXRendererScene;
+    /**@deprecated This can only get the first renderScene's scene */
+    static get scene(): THREE.Scene;
+    /**@deprecated This can only get the first renderScene's camera */
+    static get camera(): THREE.PerspectiveCamera;
+    /**@deprecated This can only get the first renderScene's controls */
+    static get controls(): OrbitControls | undefined;
     static renderer?: THREE.WebGLRenderer;
-    static effectComposer: EffectComposer | undefined;
-    static shadowEnabled: boolean;
-    static shadowResolution: [number, number];
     static resolution: [number, number];
     static backgroundColorHex: number;
     static backgroundTransparent: boolean;
-    static _wellLitDirectionalLightIntensity: number;
-    static set wellLitDirectionalLightIntensity(v: number);
-    static get wellLitDirectionalLightIntensity(): number;
     static createLoadingIcon: boolean;
     static canvasContainer: HTMLDivElement;
     static loadingIcon?: HTMLSpanElement;
     static loadingIconStyle?: HTMLStyleElement;
-    static plane?: THREE.Mesh;
-    static shadowPlane?: THREE.Mesh;
-    static ambientLight?: THREE.AmbientLight;
-    static directionalLight?: THREE.DirectionalLight;
-    static directionalLight2?: THREE.DirectionalLight;
+    /**@deprecated This can only get the first renderScene's plane */
+    static get plane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material | THREE.Material[], THREE.Object3DEventMap> | undefined;
+    /**@deprecated This can only get the first renderScene's shadowPlane */
+    static get shadowPlane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material | THREE.Material[], THREE.Object3DEventMap> | undefined;
+    /**@deprecated This can only get the first renderScene's ambientLight */
+    static get ambientLight(): THREE.AmbientLight | undefined;
+    /**@deprecated This can only get the first renderScene's directionalLight */
+    static get directionalLight(): THREE.DirectionalLight | undefined;
+    /**@deprecated This can only get the first renderScene's directionalLight2 */
+    static get directionalLight2(): THREE.DirectionalLight | undefined;
+    /**@deprecated This can only set the first renderScene's wellLitDirectionalLightIntensity*/
+    static set wellLitDirectionalLightIntensity(v: number);
+    /**@deprecated This can only gey the first renderScene's wellLitDirectionalLightIntensity*/
+    static get wellLitDirectionalLightIntensity(): number;
     static failedToCreate: boolean;
     static error?: unknown;
     static boilerplateSetup(): Promise<void>;
     static showErrorHTML(): Promise<void>;
+    static createLoadingIconHTML(): void;
+    static addScene(): RBXRendererScene;
     /**Fully sets up renderer with scene, camera and frame rendering
      * @returns success
      */
-    static fullSetup(includeScene?: boolean, includeControls?: boolean): Promise<boolean>;
+    static fullSetup(includeSceneAppearance?: boolean, includeControls?: boolean, includeAnimate?: boolean): Promise<boolean>;
     /**Creates canvasContainer */
     static createContainer(): void;
     /**Sets up the THREE.js renderer */
@@ -2135,9 +2199,9 @@ export declare class RBXRenderer {
      * @param lightingType "WellLit" is the default lighting for RoAvatar, "Thumbnail" tries to match the Roblox thumbnail lighting
      * @param backgroundColorHex is the hex code for the background color, for example 0x2b2d33
      */
-    static setupScene(lightingType?: "WellLit" | "Thumbnail", backgroundColorHex?: number): void;
+    static setupScene(lightingType?: "WellLit" | "Thumbnail", backgroundColorHex?: number, renderScene?: RBXRendererScene): void;
     /**Sets up orbit controls */
-    static setupControls(): void;
+    static setupControls(renderScene?: RBXRendererScene): void;
     /**
      * @param colorHex example: 0x2b2d33 which is the default
      */
@@ -2148,13 +2212,15 @@ export declare class RBXRenderer {
      */
     static setBackgroundTransparent(transparent: boolean): void;
     /**Makes the renderer render a new frame on every animationFrame */
-    static animate(): void;
-    static _createEffectComposer(): void;
+    static animate(shouldRequestAnimationFrame?: boolean): void;
+    static animateAll(shouldRequestAnimationFrame?: boolean): void;
+    static renderScene(renderScene: RBXRendererScene, autoClear?: boolean): void;
+    static _createEffectComposer(renderScene?: RBXRendererScene): void;
     /**Removes an instance from the renderer */
-    static removeInstance(instance: Instance): void;
-    static _addRenderDesc(instance: Instance, auth: Authentication, DescClass: typeof RenderDesc): void;
+    static removeInstance(instance: Instance, renderScene?: RBXRendererScene): void;
+    static _addRenderDesc(instance: Instance, auth: Authentication, DescClass: typeof RenderDesc, renderScene: RBXRendererScene): void;
     /**Adds an instance to the renderer or updates it */
-    static addInstance(instance: Instance, auth: Authentication): void;
+    static addInstance(instance: Instance, auth: Authentication, renderScene?: RBXRendererScene): void;
     static setRendererSize(width: number, height: number): void;
     /**
      * @deprecated Use getRendererElement instead which includes the loading icon
@@ -2165,17 +2231,46 @@ export declare class RBXRenderer {
      * @returns An element containing the renderer canvas
      */
     static getRendererElement(): HTMLDivElement;
+    /**@deprecated This can only get the first renderScene's camera */
     static getRendererCamera(): THREE.PerspectiveCamera;
-    static getCameraCFrame(): CFrame;
-    static setCameraCFrame(cameraCF: CFrame): void;
-    static setCameraFov(fov: number): void;
+    static getCameraCFrame(renderScene?: RBXRendererScene): CFrame;
+    static setCameraCFrame(cameraCF: CFrame, renderScene?: RBXRendererScene): void;
+    static setCameraFov(fov: number, renderScene?: RBXRendererScene): void;
+    /**@deprecated This can only get the first renderScene's controls */
     static getRendererControls(): OrbitControls | undefined;
     static getRenderer(): THREE.WebGLRenderer | undefined;
-    static getScene(): THREE.Scene;
+    /**@deprecated This can only get the first renderScene's scene */
+    static getScene(): RBXRendererScene;
     /**@deprecated
      * This function is unstable and can throw errors, but might work
      */
-    static exportScene(): void;
+    static exportScene(renderScene?: RBXRendererScene): void;
+}
+
+export declare class RBXRendererScene {
+    scene: THREE.Scene;
+    camera: THREE.PerspectiveCamera;
+    controls: OrbitControls | undefined;
+    effectComposer: EffectComposer | undefined;
+    scissor?: [number, number, number, number];
+    viewport?: [number, number, number, number];
+    isRenderingMesh: Map<Instance, boolean>;
+    renderDescs: Map<Instance, RenderDesc>;
+    destroyConnections: Map<Instance, Connection>;
+    lookAwayVector: Vec3;
+    lookAwayDistance: number;
+    shadowEnabled: boolean;
+    shadowResolution: [number, number];
+    _wellLitDirectionalLightIntensity: number;
+    set wellLitDirectionalLightIntensity(v: number);
+    get wellLitDirectionalLightIntensity(): number;
+    plane?: THREE.Mesh;
+    shadowPlane?: THREE.Mesh;
+    ambientLight?: THREE.AmbientLight;
+    directionalLight?: THREE.DirectionalLight;
+    directionalLight2?: THREE.DirectionalLight;
+    setRect(bounds: DOMRect): void;
+    noRect(): void;
 }
 
 declare class RBXSimpleView {
@@ -2221,8 +2316,10 @@ export declare const RegularBodyColors: string[];
  * Abstract class used to describe all rendered instances
  */
 declare class RenderDesc extends DisposableDesc {
+    renderScene: RBXRendererScene;
     results?: THREE.Mesh[];
     instance?: Instance;
+    constructor(renderScene: RBXRendererScene);
     isSame(_other: RenderDesc): boolean;
     needsRegeneration(_other: RenderDesc): boolean;
     fromRenderDesc(other: RenderDesc): void;
@@ -2610,7 +2707,7 @@ declare type ValidationIssue = {
     assetIndex?: number;
 };
 
-declare type ValidationIssueType = "AccessoryLimit" | "LayeredLimit" | "OneOfTypeLimit" | "DuplicateId" | "NotWearable" | "MissingLayeredMeta" | "InvalidAsset";
+declare type ValidationIssueType = "AccessoryLimit" | "LayeredLimit" | "OneOfTypeLimit" | "DuplicateId" | "NotWearable" | "MissingLayeredMeta" | "InvalidAsset" | "MakeupLimit";
 
 export declare type Vec2 = [number, number];
 
@@ -2673,6 +2770,22 @@ export declare type WeightChunk3 = WeightChunk & {
     weights: Vec3[];
 };
 
+export declare class WeldWrapper extends InstanceWrapper {
+    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: {
     [K in string]: Function;
 };
@@ -2685,4 +2798,6 @@ export declare const WrapLayerAutoSkin: {
 
 export declare const xmlMagic = "<roblox ";
 
+export declare function zoomExtents(cameraCFrame: CFrame, modelCFrame: CFrame, modelSize: Vector3, targetFOV: number, distanceScale: number): void;
+
 export { }