earthsdk3 3.0.7-beta.9 → 3.0.7

package/dist/types/ESObjects/general/ESSeparateFoliage/CallFunc.d.ts

@@ -1,67 +1,218 @@
 import { ESTreeParam, ToCutDownScaleType, ToScaleType } from "./index";
+/**
+ * 定义树木操作函数的类型集合
+ */
 export type TreesFuncsType = {
+    /**
+     * 添加树木的函数参数和结果类型
+     */
     AddTrees: {
+        /**
+         * 添加树木的参数
+         */
         params: {
+            /**
+             * 唯一标识符
+             */
             id: string;
+            /**
+             * 树木参数数组
+             */
             TreeParams: ESTreeParam[];
         };
+        /**
+         * 添加树木的结果
+         */
         result: {
+            /**
+             * 错误信息，如果操作成功则为 undefined
+             */
             error: string | undefined;
         };
     };
+    /**
+     * 移除所有树木的函数参数和结果类型
+     */
     RemoveAllTrees: {
+        /**
+         * 移除所有树木的参数
+         */
         params: {
+            /**
+             * 唯一标识符
+             */
             id: string;
         };
+        /**
+         * 移除所有树木的结果
+         */
         result: {
+            /**
+             * 错误信息，如果操作成功则为 undefined
+             */
             error: string | undefined;
         };
     };
+    /**
+     * 更新树木参数的函数参数和结果类型
+     */
     UpdateTreeParams: {
+        /**
+         * 更新树木参数的参数
+         */
         params: {
+            /**
+             * 唯一标识符
+             */
             id: string;
+            /**
+             * 树木参数数组
+             */
             TreeParams: ESTreeParam[];
         };
+        /**
+         * 更新树木参数的结果
+         */
         result: {
+            /**
+             * 错误信息，如果操作成功则为 undefined
+             */
             error: string | undefined;
         };
     };
+    /**
+     * 砍伐树木的函数参数和结果类型
+     */
     CutDownTrees: {
+        /**
+         * 砍伐树木的参数
+         */
         params: {
+            /**
+             * 唯一标识符
+             */
             id: string;
+            /**
+             * 要砍伐的树木 ID 数组
+             */
             TreeIds: ToCutDownScaleType[];
+            /**
+             * 砍伐所需的时间长度
+             */
             TimeLength: number;
         };
+        /**
+         * 砍伐树木的结果
+         */
         result: {
+            /**
+             * 错误信息，如果操作成功则为 undefined
+             */
             error: string | undefined;
         };
     };
+    /**
+     * 树木生长模拟的函数参数和结果类型
+     */
     GrowthSimulation: {
+        /**
+         * 树木生长模拟的参数
+         */
         params: {
+            /**
+             * 唯一标识符
+             */
             id: string;
+            /**
+             * 目标参数数组
+             */
             ToParams: ToScaleType[];
+            /**
+             * 模拟的时间长度
+             */
             TimeLength: number;
+            /**
+             * 切换时间
+             */
             SwitchTime: number;
         };
+        /**
+         * 树木生长模拟的结果
+         */
         result: {
+            /**
+             * 错误信息，如果操作成功则为 undefined
+             */
             error: string | undefined;
         };
     };
 };
+/**
+ * 异步调用添加树木的函数
+ * @param ueViewer - UE 视口对象，包含 viewer 属性
+ * @param id - 唯一标识符
+ * @param trees - 要添加的树木参数数组
+ * @returns 添加树木操作的结果，如果 ueViewer.viewer 为 undefined 则返回 undefined
+ */
 declare const addTreesCallFunc: (ueViewer: any, id: string, trees: ESTreeParam[]) => Promise<{
+    /**
+     * 错误信息，如果操作成功则为 undefined
+     */
     error: string | undefined;
 } | undefined>;
+/**
+ * 异步调用移除所有树木的函数
+ * @param ueViewer - UE 视口对象，包含 viewer 属性
+ * @param id - 唯一标识符
+ * @returns 移除所有树木操作的结果，如果 ueViewer.viewer 为 undefined 则返回 undefined
+ */
 declare const removeAllTreesCallFunc: (ueViewer: any, id: string) => Promise<{
+    /**
+     * 错误信息，如果操作成功则为 undefined
+     */
     error: string | undefined;
 } | undefined>;
+/**
+ * 异步调用更新树木参数的函数
+ * @param ueViewer - UE 视口对象，包含 viewer 属性
+ * @param id - 唯一标识符
+ * @param trees - 要更新的树木参数数组
+ * @returns 更新树木参数操作的结果，如果 ueViewer.viewer 为 undefined 则返回 undefined
+ */
 declare const updateTreeParamsCallFunc: (ueViewer: any, id: string, trees: ESTreeParam[]) => Promise<{
+    /**
+     * 错误信息，如果操作成功则为 undefined
+     */
     error: string | undefined;
 } | undefined>;
+/**
+ * 异步调用砍伐树木的函数
+ * @param ueViewer - UE 视口对象，包含 viewer 属性
+ * @param id - 唯一标识符
+ * @param TreeIds - 要砍伐的树木 ID 数组
+ * @param TimeLength - 砍伐所需的时间长度
+ * @returns 砍伐树木操作的结果，如果 ueViewer.viewer 为 undefined 则返回 undefined
+ */
 declare const cutDownTreesCallFunc: (ueViewer: any, id: string, TreeIds: ToCutDownScaleType[], TimeLength: number) => Promise<{
+    /**
+     * 错误信息，如果操作成功则为 undefined
+     */
     error: string | undefined;
 } | undefined>;
+/**
+ * 异步调用树木生长模拟的函数
+ * @param ueViewer - UE 视口对象，包含 viewer 属性
+ * @param id - 唯一标识符
+ * @param ToParams - 目标参数数组
+ * @param TimeLength - 模拟的时间长度
+ * @param SwitchTime - 切换时间
+ * @returns 树木生长模拟操作的结果，如果 ueViewer.viewer 为 undefined 则返回 undefined
+ */
 declare const growthSimulationCallFunc: (ueViewer: any, id: string, ToParams: ToScaleType[], TimeLength: number, SwitchTime: number) => Promise<{
+    /**
+     * 错误信息，如果操作成功则为 undefined
+     */
     error: string | undefined;
 } | undefined>;
-export { addTreesCallFunc, removeAllTreesCallFunc, updateTreeParamsCallFunc, cutDownTreesCallFunc, growthSimulationCallFunc };
+export { addTreesCallFunc, removeAllTreesCallFunc, updateTreeParamsCallFunc, cutDownTreesCallFunc, growthSimulationCallFunc, };
 //# sourceMappingURL=CallFunc.d.ts.map

package/dist/types/ESObjects/general/ESSeparateFoliage/CallFunc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CallFunc.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSeparateFoliage/CallFunc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEvE,MAAM,MAAM,cAAc,GAAG;IACzB,QAAQ,EAAE;QACN,MAAM,EAAE;YACJ,EAAE,EAAE,MAAM,CAAC;YACX,UAAU,EAAE,WAAW,EAAE,CAAA;SAC5B,CAAC;QACF,MAAM,EAAE;YACJ,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAA;KACJ,CAAC;IAEF,cAAc,EAAE;QACZ,MAAM,EAAE;YACJ,EAAE,EAAE,MAAM,CAAC;SACd,CAAC;QACF,MAAM,EAAE;YACJ,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAA;KACJ,CAAC;IACF,gBAAgB,EAAE;QACd,MAAM,EAAE;YACJ,EAAE,EAAE,MAAM,CAAC;YACX,UAAU,EAAE,WAAW,EAAE,CAAA;SAC5B,CAAC;QACF,MAAM,EAAE;YACJ,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAA;KACJ,CAAC;IACF,YAAY,EAAE;QACV,MAAM,EAAE;YACJ,EAAE,EAAE,MAAM,CAAC;YACX,OAAO,EAAE,kBAAkB,EAAE,CAAC;YAC9B,UAAU,EAAE,MAAM,CAAA;SACrB,CAAC;QACF,MAAM,EAAE;YACJ,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAA;KACJ,CAAC;IACF,gBAAgB,EAAE;QACd,MAAM,EAAE;YACJ,EAAE,EAAE,MAAM,CAAC;YACX,QAAQ,EAAE,WAAW,EAAE,CAAC;YACxB,UAAU,EAAE,MAAM,CAAC;YACnB,UAAU,EAAE,MAAM,CAAA;SACrB,CAAC;QACF,MAAM,EAAE;YACJ,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAA;KACJ,CAAA;CAEJ,CAAA;AAED,QAAA,MAAM,gBAAgB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,OAAO,WAAW,EAAE;WA7C5D,MAAM,GAAG,SAAS;cAyDpC,CAAA;AACD,QAAA,MAAM,sBAAsB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM;WAjD5C,MAAM,GAAG,SAAS;cA6DpC,CAAA;AACD,QAAA,MAAM,wBAAwB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,OAAO,WAAW,EAAE;WArDpE,MAAM,GAAG,SAAS;cAiEpC,CAAA;AACD,QAAA,MAAM,oBAAoB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,SAAS,kBAAkB,EAAE,EAAE,YAAY,MAAM;WAxD7F,MAAM,GAAG,SAAS;cAoEpC,CAAA;AACD,QAAA,MAAM,wBAAwB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,UAAU,WAAW,EAAE,EAAE,YAAY,MAAM,EAAE,YAAY,MAAM;WA1D/G,MAAM,GAAG,SAAS;cAsEpC,CAAA;AAED,OAAO,EACH,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,wBAAwB,EAC3B,CAAA"}
+{"version":3,"file":"CallFunc.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSeparateFoliage/CallFunc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB;;OAEG;IACH,QAAQ,EAAE;QACN;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,UAAU,EAAE,WAAW,EAAE,CAAC;SAC7B,CAAC;QACF;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAC;KACL,CAAC;IAEF;;OAEG;IACH,cAAc,EAAE;QACZ;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACd,CAAC;QACF;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAC;KACL,CAAC;IAEF;;OAEG;IACH,gBAAgB,EAAE;QACd;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,UAAU,EAAE,WAAW,EAAE,CAAC;SAC7B,CAAC;QACF;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAC;KACL,CAAC;IAEF;;OAEG;IACH,YAAY,EAAE;QACV;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;YAC9B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACtB,CAAC;QACF;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAC;KACL,CAAC;IAEF;;OAEG;IACH,gBAAgB,EAAE;QACd;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YACX;;eAEG;YACH,QAAQ,EAAE,WAAW,EAAE,CAAC;YACxB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACtB,CAAC;QACF;;WAEG;QACH,MAAM,EAAE;YACJ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;SAC7B,CAAC;KACL,CAAC;CACL,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,gBAAgB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,OAAO,WAAW,EAAE;IAvInE;;OAEG;WACI,MAAM,GAAG,SAAS;cAgJpC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM;IAnInD;;OAEG;WACI,MAAM,GAAG,SAAS;cA4IpC,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,wBAAwB,GAAU,UAAU,GAAG,EAAE,IAAI,MAAM,EAAE,OAAO,WAAW,EAAE;IA5H3E;;OAEG;WACI,MAAM,GAAG,SAAS;cAqIpC,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,oBAAoB,GACtB,UAAU,GAAG,EACb,IAAI,MAAM,EACV,SAAS,kBAAkB,EAAE,EAC7B,YAAY,MAAM;IAtHV;;OAEG;WACI,MAAM,GAAG,SAAS;cAgIpC,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,wBAAwB,GAC1B,UAAU,GAAG,EACb,IAAI,MAAM,EACV,UAAU,WAAW,EAAE,EACvB,YAAY,MAAM,EAClB,YAAY,MAAM;IA/GV;;OAEG;WACI,MAAM,GAAG,SAAS;cAyHpC,CAAC;AAEF,OAAO,EACH,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,wBAAwB,GAC3B,CAAC"}

package/dist/types/ESObjects/general/ESSeparateFoliage/index.d.ts

@@ -2,30 +2,94 @@ import { Event, UniteChanged } from "xbsj-base";
 import { ESJVector3D } from "../../../ESJTypes";
 import { ESVisualObject } from "../../base";
 import { addTreesCallFunc, cutDownTreesCallFunc, growthSimulationCallFunc, removeAllTreesCallFunc, updateTreeParamsCallFunc } from "./CallFunc";
+/**
+ * 表示单个树类型的分离信息。
+ * @typedef {Object} ESTreeTypeSep
+ * @property {string} name - 树类型的名称。
+ * @property {string} meshPath - 树类型的网格路径。
+ */
 export type ESTreeTypeSep = {
     name: string;
     meshPath: string;
 };
+/**
+ * 表示树的参数信息。
+ * @typedef {Object} ESTreeParam
+ * @property {string} id - 树的唯一标识符。
+ * @property {number} treeTypeId - 树类型的ID。
+ * @property {ESJVector3D} location - 树的位置。
+ * @property {ESJVector3D} scale - 树的缩放比例。
+ */
 export type ESTreeParam = {
     id: string;
     treeTypeId: number;
     location: ESJVector3D;
     scale: ESJVector3D;
 };
+/**
+ * 表示缩放类型的映射。
+ * @typedef {Object.<string, [ESJVector3D, ESJVector3D, ESJVector3D, number]>} ToScaleType
+ */
 export type ToScaleType = {
     [key: string]: [ESJVector3D, ESJVector3D, ESJVector3D, number];
 };
+/**
+ * 表示砍伐缩放类型的映射。
+ * @typedef {Object.<string, [ESJVector3D, number]>} ToCutDownScaleType
+ */
 export type ToCutDownScaleType = {
     [key: string]: [ESJVector3D, number];
 };
+/**
+ * 导出用于添加树、移除所有树、更新树参数、砍伐树和生长模拟的调用函数。
+ */
 export { addTreesCallFunc, removeAllTreesCallFunc, updateTreeParamsCallFunc, cutDownTreesCallFunc, growthSimulationCallFunc };
+/**
+ * ESSeparateFoliage 类用于管理和控制森林中的单体树木，提供了一系列方法来添加、更新、移除树木以及模拟树木的生长和砍伐。
+ * 该类继承自 ESVisualObject 类，并扩展了与树木相关的特定功能。
+ *
+ * 核心功能包括：
+ * - 添加树木（addTreesCallFunc）
+ * - 更新树参数（updateTreeParamsCallFunc）
+ * - 砍伐树木（cutDownTreesCallFunc）
+ * - 移除所有树木（removeAllTreesCallFunc）
+ * - 树木生长模拟（growthSimulationCallFunc）
+ * - 通过组件名称和命中项获取ID（getIdByComponentNameAndHitItem）
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 对象的可选ID，用于唯一标识该实例。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 该类依赖于 UE 查看器对象，确保在使用相关方法前 UE 查看器已正确初始化。
+ * - 在进行树木操作时，需要注意参数的正确性和合理性，避免出现异常情况。
+ */
 export declare class ESSeparateFoliage extends ESVisualObject {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     *
+     * @type {*}
+     */
     static readonly type: string;
+    /**
+     * 获取对象的类型名称。
+     * @returns {string} 对象的类型名称。
+     */
     get typeName(): string;
+    /**
+     * 获取对象的默认属性。
+     * @override
+     * @returns {*} 对象的默认属性。
+     */
     get defaultProps(): {
+        /** 树类型数组 */
         treeTypes: import("xbsj-base").ReactiveVariable<ESTreeTypeSep[] | undefined>;
+        /** 树桩id */
         stumpId: number;
+        /** 动画间隔时间 */
         intervalTime: number;
+        /** 切换间隔时间 */
         switchIntervalTime: number;
         show: boolean;
         collision: boolean;
@@ -40,37 +104,157 @@ export declare class ESSeparateFoliage extends ESVisualObject {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 调用添加树的函数。
+     * @param {any} ueViewer - UE查看器对象。
+     * @param {ESTreeParam[]} trees - 要添加的树的参数数组。
+     * @returns {Promise<any>} 一个Promise，解析为添加树操作的结果。
+     */
     addTreesCallFunc(ueViewer: any, trees: ESTreeParam[]): Promise<{
         error: string | undefined;
     } | undefined>;
+    /**
+     * 调用更新树参数的函数。
+     *
+     * @param {any} ueViewer - UE查看器对象。
+     * @param {ESTreeParam[]} trees - 要更新的树的参数数组。
+     * @returns {Promise<any>} 一个Promise，解析为更新树参数操作的结果。
+     */
     updateTreeParamsCallFunc(ueViewer: any, trees: ESTreeParam[]): Promise<{
         error: string | undefined;
     } | undefined>;
+    /**
+     * 调用砍伐树的函数。
+     *
+     * @param {any} ueViewer - UE查看器对象。
+     * @param {ToCutDownScaleType[]} TreeIds - 要砍伐的树的ID数组。
+     * @param {number} TimeLength - 砍伐操作的时间长度。
+     * @returns {Promise<any>} 一个Promise，解析为砍伐树操作的结果。
+     */
     cutDownTreesCallFunc(ueViewer: any, TreeIds: ToCutDownScaleType[], TimeLength: number): Promise<{
         error: string | undefined;
     } | undefined>;
+    /**
+     * 调用移除所有树的函数。
+     *
+     * @param {any} ueViewer - UE查看器对象。
+     * @returns {Promise<any>} 一个Promise，解析为移除所有树操作的结果。
+     */
     removeAllTreesCallFunc(ueViewer: any): Promise<{
         error: string | undefined;
     } | undefined>;
+    /**
+     * 调用树木生长模拟的函数。
+     *
+     * @param {any} ueViewer - UE查看器对象。
+     * @param {ToScaleType[]} ToParams - 生长模拟的参数数组。
+     * @param {number} TimeLength - 生长模拟的时间长度。
+     * @param {number} SwitchTime - 切换时间。
+     * @returns {Promise<any>} 一个Promise，解析为生长模拟操作的结果。
+     */
     growthSimulationCallFunc(ueViewer: any, ToParams: ToScaleType[], TimeLength: number, SwitchTime: number): Promise<{
         error: string | undefined;
     } | undefined>;
+    /**
+     * 通过组件名称和命中项获取ID。
+     *
+     * @param {any} viewer - 查看器对象。
+     * @param {string} ComponentName - 组件名称。
+     * @param {number} HitItem - 命中项。
+     * @returns {Promise<any>} 一个Promise，解析为获取ID操作的结果。
+     */
     getIdByComponentNameAndHitItem(viewer: any, ComponentName: string, HitItem: number): Promise<any>;
+    /**
+     * 私有属性，用于添加树的事件。
+     * @private
+     * @type {Event<[TreeParams: ESTreeParam[]]>}
+     */
     private _addTreesEvent;
+    /**
+     * 获取添加树的事件。
+     * @returns {Event<[TreeParams: ESTreeParam[]]>} 添加树的事件。
+     */
     get addTreesEvent(): Event<[TreeParams: ESTreeParam[]]>;
+    /**
+     * 触发添加树的事件。
+     * @param {ESTreeParam[]} TreeParams - 要添加的树的参数数组。
+     */
     addTrees(TreeParams: ESTreeParam[]): void;
+    /**
+     * 私有属性，用于移除所有树的事件。
+     * @private
+     * @type {Event}
+     */
     private _removeAllTreesEvent;
+    /**
+     * 获取移除所有树的事件。
+     * @returns {Event} 移除所有树的事件。
+     */
     get removeAllTreesEvent(): Event<[]>;
+    /**
+     * 触发移除所有树的事件。
+     */
     removeAllTrees(): void;
+    /**
+     * 私有属性，用于更新树参数的事件。
+     * @private
+     * @type {Event<[TreeParams: ESTreeParam[]]>}
+     */
     private _updateTreeParamsEvent;
+    /**
+     * 获取更新树参数的事件。
+     * @returns {Event<[TreeParams: ESTreeParam[]]>} 更新树参数的事件。
+     */
     get updateTreeParamsEvent(): Event<[TreeParams: ESTreeParam[]]>;
+    /**
+     * 触发更新树参数的事件。
+     * @param {ESTreeParam[]} TreeParams - 要更新的树的参数数组。
+     */
     updateTreeParams(TreeParams: ESTreeParam[]): void;
+    /**
+     * 私有属性，用于砍伐树的事件。
+     * @private
+     * @type {Event<[TreeId: ToCutDownScaleType[], TimeLength: number]>}
+     */
     private _cutDownTreesEvent;
+    /**
+     * 获取砍伐树的事件。
+     * @returns {Event<[TreeId: ToCutDownScaleType[], TimeLength: number]>} 砍伐树的事件。
+     */
     get cutDownTreesEvent(): Event<[TreeId: ToCutDownScaleType[], TimeLength: number]>;
+    /**
+     * 触发砍伐树的事件。
+     * @param {ToCutDownScaleType[]} TreeId - 要砍伐的树的ID数组。
+     * @param {number} TimeLength - 砍伐操作的时间长度。
+     */
     cutDownTrees(TreeId: ToCutDownScaleType[], TimeLength: number): void;
+    /**
+     * 私有属性，用于树木生长模拟的事件。
+     * @private
+     * @type {Event<[ToParams: ToScaleType[], TimeLength: number, SwitchTime: number]>}
+     */
     private _growthSimulationEvent;
+    /**
+     * 获取树木生长模拟的事件。
+     * @returns {Event<[ToParams: ToScaleType[], TimeLength: number, SwitchTime: number]>} 树木生长模拟的事件。
+     */
     get growthSimulationEvent(): Event<[ToParams: ToScaleType[], TimeLength: number, SwitchTime: number]>;
+    /**
+     * 触发树木生长模拟的事件。
+     * @param {ToScaleType[]} ToParams - 生长模拟的参数数组。
+     * @param {number} TimeLength - 生长模拟的时间长度。
+     * @param {number} SwitchTime - 切换时间。
+     */
     growthSimulation(ToParams: ToScaleType[], TimeLength: number, SwitchTime: number): void;
+    /**
+     * 静态属性，定义类的默认值。
+     * @override
+     * @type {Object}
+     * @property {ESTreeTypeSep[]} treeTypes - 树类型的数组。
+     * @property {number} stumpId - 树桩的ID。
+     * @property {number} intervalTime - 动画间隔时间。
+     * @property {number} switchIntervalTime - 切换间隔时间。
+     */
     static defaults: {
         treeTypes: ESTreeTypeSep[];
         stumpId: number;
@@ -82,14 +266,35 @@ export declare class ESSeparateFoliage extends ESVisualObject {
         flyToParam: import("../../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，创建一个 ESSeparateFoliage 实例。
+     * @param {string} [id] - 对象的可选ID。
+     */
     constructor(id?: string);
+    /**
+     * 获取对象的属性列表。
+     * @override
+     * @param {string} [language] - 语言代码。
+     * @returns {GroupProperty[]} 对象的属性列表。
+     */
     getProperties(language?: string): import("../../../ESJTypes").Property[];
 }
+/**
+ * ESSeparateFoliage 命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESSeparateFoliage {
+    /**
+     * 创建默认属性对象。
+     * @returns {Object} 默认属性对象。
+     */
     const createDefaultProps: () => {
+        /** 树类型数组 */
         treeTypes: import("xbsj-base").ReactiveVariable<ESTreeTypeSep[] | undefined>;
+        /** 树桩id */
         stumpId: number;
+        /** 动画间隔时间 */
         intervalTime: number;
+        /** 切换间隔时间 */
         switchIntervalTime: number;
         show: boolean;
         collision: boolean;
@@ -105,6 +310,9 @@ export declare namespace ESSeparateFoliage {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESSeparateFoliage 接口，继承自 UniteChanged。
+ */
 export interface ESSeparateFoliage extends UniteChanged<ReturnType<typeof ESSeparateFoliage.createDefaultProps>> {
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/types/ESObjects/general/ESSeparateFoliage/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSeparateFoliage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,WAAW,EAA+C,MAAM,mBAAmB,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAChJ,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAC9D,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAA;AACvG,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;CAAE,CAAA;AAC5F,MAAM,MAAM,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;CAAE,CAAA;AACzE,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,CAAA;AAE7H,qBAAa,iBAAkB,SAAQ,cAAc;IACjD,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAC7J,IAAI,QAAQ,WAAkC;IAC9C,IAAa,YAAY;;;;;;;;;;;;;;;;;MAAqD;IAExE,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE;;;IAGpD,wBAAwB,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE;;;IAG5D,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,MAAM;;;IAGrF,sBAAsB,CAAC,QAAQ,EAAE,GAAG;;;IAGpC,wBAAwB,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;;;IAGvG,8BAA8B,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIxF,OAAO,CAAC,cAAc,CAAqD;IAC3E,IAAI,aAAa,uCAAkC;IACnD,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE;IAElC,OAAO,CAAC,oBAAoB,CAAwB;IACpD,IAAI,mBAAmB,cAAwC;IAC/D,cAAc;IAEd,OAAO,CAAC,sBAAsB,CAAqD;IACnF,IAAI,qBAAqB,uCAA0C;IACnE,gBAAgB,CAAC,UAAU,EAAE,WAAW,EAAE;IAE1C,OAAO,CAAC,kBAAkB,CAA4E;IACtG,IAAI,iBAAiB,8DAAsC;IAC3D,YAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,MAAM;IAE7D,OAAO,CAAC,sBAAsB,CAA2F;IACzH,IAAI,qBAAqB,6EAA0C;IACnE,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAEhF,OAAgB,QAAQ;mBAEH,aAAa,EAAE;;;;;;;;;MAInC;gBACW,EAAE,CAAC,EAAE,MAAM;IAGd,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAW3C;AAED,yBAAiB,iBAAiB,CAAC;IACxB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;KAM7B,CAAC;CACN;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESSeparateFoliage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,WAAW,EAA+C,MAAM,mBAAmB,CAAC;AAC7F,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAEhJ;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC;AAExG;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC;AAE7F;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC;AAE1E;;GAEG;AACH,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,CAAC;AAE9H;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACjD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAE7J;;;OAGG;IACH,IAAI,QAAQ,WAAkC;IAE9C;;;;OAIG;IACH,IAAa,YAAY;QA6NrB,YAAY;;QAEZ,WAAW;;QAEX,aAAa;;QAEb,aAAa;;;;;;;;;;;;;;MAnO6D;IAE9E;;;;;OAKG;IACG,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE;;;IAI1D;;;;;;OAMG;IACG,wBAAwB,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE;;;IAIlE;;;;;;;OAOG;IACG,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,MAAM;;;IAI3F;;;;;OAKG;IACG,sBAAsB,CAAC,QAAQ,EAAE,GAAG;;;IAI1C;;;;;;;;OAQG;IACG,wBAAwB,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;;;IAI7G;;;;;;;OAOG;IACG,8BAA8B,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIxF;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAAqD;IAE3E;;;OAGG;IACH,IAAI,aAAa,uCAAkC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE;IAElC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB,CAAwB;IAEpD;;;OAGG;IACH,IAAI,mBAAmB,cAAwC;IAE/D;;OAEG;IACH,cAAc;IAEd;;;;OAIG;IACH,OAAO,CAAC,sBAAsB,CAAqD;IAEnF;;;OAGG;IACH,IAAI,qBAAqB,uCAA0C;IAEnE;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,WAAW,EAAE;IAE1C;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAA4E;IAEtG;;;OAGG;IACH,IAAI,iBAAiB,8DAAsC;IAE3D;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,MAAM;IAE7D;;;;OAIG;IACH,OAAO,CAAC,sBAAsB,CAA2F;IAEzH;;;OAGG;IACH,IAAI,qBAAqB,6EAA0C;IAEnE;;;;;OAKG;IACH,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAEhF;;;;;;;;OAQG;IACH,OAAgB,QAAQ;mBAEH,aAAa,EAAE;;;;;;;;;MAIlC;IAEF;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAIvB;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAW3C;AAED;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IAC/B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,YAAY;;QAEZ,WAAW;;QAEX,aAAa;;QAEb,aAAa;;;;;;;;;;;;;;KAEf,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}