@galacean/engine-spine 0.0.0-experimental-2024071801 → 0.0.0-experimental-2024071901

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.0-experimental-2024071801",
+  "version": "0.0.0-experimental-2024071901",
   "description": "galacean spine runtime",
   "name": "@galacean/engine-spine",
   "main": "dist/main.js",

package/types/src/SpineAnimationRenderer.d.ts

@@ -1,6 +1,9 @@
 import { Skeleton, SkeletonData, AnimationState, AnimationStateData } from "@esotericsoftware/spine-core";
 import { Buffer, Renderer, Entity, Material, Engine, BoundingBox, Primitive, SubPrimitive } from "@galacean/engine";
 import { SkeletonDataResource } from "./loader/SkeletonDataResource";
+/**
+ * Spine animation renderer, capable of rendering spine animations and providing functions for animation and skeleton manipulation.
+ */
 export declare class SpineAnimationRenderer extends Renderer {
     private static _defaultMaterial;
     private static _spineGenerator;
@@ -42,9 +45,9 @@ export declare class SpineAnimationRenderer extends Renderer {
     private _skeleton;
     private _state;
     /**
-     * Setting `skeletonData` initializes a new Spine animation with the provided data.
-     * This property allows you to switch between different animations at runtime.
+     * Spine resource of current spine animation.This property allows you to switch between different animations at runtime.
      */
+    get resource(): SkeletonDataResource;
     set resource(value: SkeletonDataResource);
     /**
      * Provides access to `AnimationState` which controls animation playback on a skeleton.
@@ -57,6 +60,9 @@ export declare class SpineAnimationRenderer extends Renderer {
      * and change spine attachment to customize character appearances dynamically during runtime.
      */
     get skeleton(): Skeleton;
+    /**
+     * @internal
+     */
     constructor(entity: Entity);
     /**
      * Separate slot by slot name. This will add a new sub primitive, and new materials.
@@ -142,25 +148,23 @@ export declare enum RendererUpdateFlags {
  */
 export declare class SpineRenderSetting {
     /**
-     * The spacing between z layers.
+     * The spacing between z layers @defaultValue `0.01`
      */
     zSpacing: number;
     /**
-     * Whether to use clipping.
+     * Whether to use clipping @defaultValue `true`
      */
     useClipping: boolean;
     /**
      * Creates an instance of SpineRenderSetting.
-     * @param {number} [zSpacing=0.01] - The spacing between z layers.
-     * @param {boolean} [useClipping=true] - Whether to use clipping.
      */
     constructor(
     /**
-     * The spacing between z layers.
+     * The spacing between z layers @defaultValue `0.01`
      */
     zSpacing?: number, 
     /**
-     * Whether to use clipping.
+     * Whether to use clipping @defaultValue `true`
      */
     useClipping?: boolean);
 }
@@ -171,43 +175,39 @@ export declare class SpineRenderSetting {
  */
 export declare class DefaultState {
     /**
-     * The default scale of the animation.
+     * The default scale of the animation @defaultValue `1`
      */
     scale: number;
     /**
-     * Whether the default animation should loop.
+     * Whether the default animation should loop @defaultValue `true. The default animation should loop`
      */
     loop: boolean;
     /**
-     * The name of the default animation.
+     * The name of the default animation @defaultValue `null. Do not play any animation by default`
      */
     animationName: string | null;
     /**
-     * The name of the default skin.
+     * The name of the default skin @defaultValue `default`
      */
     skinName: string;
     /**
-     * Creates an instance of DefaultState.
-     * @param {number} [scale=1] - The default scale of the animation.
-     * @param {boolean} [loop=false] - Whether the default animation should loop.
-     * @param {string | null} [animationName=null] - The name of the default animation.
-     * @param {string} [skinName="default"] - The name of the default skin.
+     * Creates an instance of DefaultState
      */
     constructor(
     /**
-     * The default scale of the animation.
+     * The default scale of the animation @defaultValue `1`
      */
     scale?: number, 
     /**
-     * Whether the default animation should loop.
+     * Whether the default animation should loop @defaultValue `true. The default animation should loop`
      */
     loop?: boolean, 
     /**
-     * The name of the default animation.
+     * The name of the default animation @defaultValue `null. Do not play any animation by default`
      */
     animationName?: string | null, 
     /**
-     * The name of the default skin.
+     * The name of the default skin @defaultValue `default`
      */
     skinName?: string);
 }