knight-web 2.0.2 → 2.0.4

package/frame/utility/ObjectUtility.d.ts

@@ -1,308 +1,308 @@
-/*********************************************************************************
-  * FileName     : ObjectPool
-  * FileBasename : ObjectPool.ts
-  * Author       : Seven_9t
-  * Date         : Sat Mar 25 2023 15:05:05 GMT+0800 (中国标准时间)
-  * Description  : db://assets/frame/script/base/ObjectPool.ts
-  * Version      : v3.6
-  * Others       : 修改默认TS脚本模板路径 D:\Cocos\CocosDashboard\resources\.editors\Creator\<Version>\resources\resources\3d\engine\editor\assets\default_file_content\ts
-  * ManualUrl    : <指南手册>    https://docs.cocos.com/creator/3.6/manual/zh/
-  *              : <脚本手册>    https://docs.cocos.com/creator/3.6/manual/zh/scripting/
-  *              : <接口手册>    https://docs.cocos.com/creator/api/zh/#/docs/3.6/zh/README
-  *              : <生命周期手册>https://docs.cocos.com/creator/3.6/manual/zh/scripting/life-cycle-callbacks.html
-
-**********************************************************************************/
-import { InterfaceUtility } from "./InterfaceUtility";
-/** 对象工具 */
-export declare namespace ObjectUtility {
-    /** 空对象类 */
-    export class EmptyObject {
-    }
-    /** 获取对象所有属性 */
-    export function GetPropertys<T>(_object: T): Array<string>;
-    /** 检测对象属性是否存在 */
-    export function HasProperty(_object: object, _propertyKey: string): boolean;
-    /** 是否是对象 */
-    export function IsObject(_target: any): boolean;
-    /** 是否是数组 */
-    export function IsArray(_target: any): boolean;
-    /** 是否是函数 */
-    export function IsFunction(_target: any): boolean;
-    /**
-     * 判断是否继承自基类
-     * @param _target 目标对象实例
-     * @param _className 基类类名
-     * @returns 匹配结果
-     */
-    export function InstanceOf(_target: object, _className: string): boolean;
-    /** 克隆对象 */
-    export function Clone<T>(_target: T, ...params: any[]): T;
-    /** 克隆并赋值 */
-    export function CloneAssign<T>(_target: T, ...params: any[]): T;
-    /** 数据赋值 */
-    export function Assign<T extends object>(_target: T, _source: Partial<object>): T;
-    /**
-     * 将对象序列化为Json字符串
-     * @param _object 一个JavaScript值，通常是要转换的对象或数组。
-     * @param _replacer 转换结果的函数。
-     * @param _space 在返回值JSON文本中添加缩进、空白和换行字符，使其更易于阅读。
-     * @returns 序列化后对象(需要自行转JSON.stringify)
-     */
-    export function Encode(_object: object, _replacer?: (this: any, key: string, value: any) => any, _space?: string | number): Record<string, any>;
-    /** 将Json字符串反序列化为对象(对象带有函数则无效,需要执行浅拷贝或深拷贝) */
-    export function Decode<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
-    /** 浅拷贝 */
-    export function ShallowCopy<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
-    /** 深拷贝 */
-    export function DeepCopy<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
-    /** 深拷贝 TODO */
-    export function Deep(_target: any, _bitmask: boolean): any;
-    /** 深拷贝数组 */
-    export function DeepCopyArray(_target: any): any;
-    /** 对象操作泛型接口 */
-    interface IObjectOperation<T> {
-        /** 获取数量 */
-        get Count(): number;
-        /** 获取对象 */
-        Get(_key: number | string): T;
-        /** 获取对象组 */
-        Gets(_keys: Array<number | string>): Array<T>;
-        /** 获取所有对象 */
-        GetAll(): Array<T> | Map<string, T>;
-        /** 添加对象实例 */
-        Add(..._param: any[]): boolean;
-        /** 移除对象实例 */
-        Remove(_t: number | string | T): boolean;
-        /** 移除所有对象实例 */
-        RemoveAll(): void;
-        /** 对象实例是否存在 */
-        Exist(_t: number | string | T): boolean;
-    }
-    /** 对象池<数组> */
-    export class ArrayPool<T extends object | any> implements IObjectOperation<T> {
-        /** 对象池 */
-        private _tPools;
-        /** 构造函数 */
-        constructor();
-        /** 获取数量 */
-        get Count(): number;
-        /** 获取对象 */
-        Get<K extends T>(_index: number): K;
-        /** 获取对象组 */
-        Gets<K extends T>(_indexs: Array<number>): Array<K>;
-        /** 获取所有对象 */
-        GetAll(): Array<T>;
-        /** 添加对象实例 */
-        Add(_t: T): boolean;
-        /** 移除对象实例 */
-        Remove(_t: T | number): boolean;
-        /** 移除所有对象实例 */
-        RemoveAll(): void;
-        /** 对象实例是否存在 */
-        Exist(_t: T | number): boolean;
-    }
-    /** 对象池<字典> */
-    export class MapPool<T extends object> implements IObjectOperation<T> {
-        /** 对象池 */
-        private _tPools;
-        /** 构造函数 */
-        constructor(_map?: Map<string, T>);
-        /** 获取数量 */
-        get Count(): number;
-        /** 获取对象 */
-        Get<K extends T>(_key: string): K;
-        /** 获取对象组 */
-        Gets<K extends T>(_keys: Array<string>): Array<K>;
-        /** 获取所有对象 */
-        GetAll(): Map<string, T>;
-        /** 添加对象实例 */
-        Add(_key: string, _t: T): boolean;
-        /** 设置对象 */
-        Set<K extends T>(_key: string, _t: T): K;
-        /** 移除对象实例 */
-        Remove(_key: string): boolean;
-        /** 移除所有对象实例 */
-        RemoveAll(): void;
-        /** 对象实例是否存在 */
-        Exist(_t: string): boolean;
-        /** 所有键转数组 */
-        KeysToArray(): Array<string>;
-        /** 所有值转数组 */
-        ValuesToArray(): Array<T>;
-    }
-    /** 队列池<队列> */
-    export class QueuePool<T extends object> {
-        /** 队列数组 */
-        private _tPools;
-        constructor();
-        /** 入队 */
-        Enqueue(_t: T): void;
-        /** 出队 */
-        Dequeue(): T | undefined;
-        /** 查看队首元素 */
-        Peek(): T | undefined;
-        /** 判断队列是否为空 */
-        IsEmpty(): boolean;
-        /** 获取队列大小 */
-        Size(): number;
-        /** 清空队列 */
-        Clear(): void;
-        /** 克隆 */
-        Clone(): Array<T>;
-    }
-    /** 管线 */
-    export class PipeLine<T extends object> {
-        /** 事件管线 */
-        private _tPools;
-        /** 管线是否已启动 */
-        private _isStarted;
-        /** 管线是否已启动 */
-        private _isEnded;
-        /** 开关 */
-        private _switch;
-        constructor();
-        /** 获取数量 */
-        get Count(): number;
-        /** 注册事件 */
-        Register(_pipeline: ((_params: T) => Promise<T>) | PipeLine<T>): boolean;
-        /** 注销事件 */
-        Degister(_pipeline: ((_params: T) => Promise<T>) | PipeLine<T>): boolean;
-        /** 启动事件 */
-        Start(_params: T): Promise<T>;
-        /** 停止事件 */
-        Stop(): void;
-    }
-    /** 委托接口 */
-    export interface IDelegate {
-        /** 注册 */
-        Register(_key: string, _callback: InterfaceUtility.IEvent, _target: any, _times: number): boolean;
-        /** 注销 */
-        Degister(_key: string, _callback: InterfaceUtility.IEvent, _target: any): boolean;
-        /** 通知 */
-        Invoke(_key: string, ...params: Array<any>): Promise<void>;
-        /** 清除 */
-        Clear(): void;
-    }
-    /** 委托池(多绑定) */
-    export class DelegateMultiplePool implements IDelegate {
-        /** 对象池 */
-        private _tPools;
-        /** 构造函数 */
-        constructor();
-        /**
-         * 注册监听事件
-         * @param _key 事件名称
-         * @param _event 回调函数
-         * @param _target 绑定对象
-         * @param _times 执行次数
-         */
-        Register(_key: string, _event: InterfaceUtility.IEvent, _times?: number): boolean;
-        /**
-        * 移除监听事件
-        * @param _key 事件名称
-        * @param _event 回调函数
-        * @param _target 绑定对象
-        */
-        Degister(_key: string, _event: InterfaceUtility.IEvent): boolean;
-        /**
-        * 派发监听事件
-        * @param _key 事件名称
-        * @param _params 回调参数
-        */
-        Invoke<T>(_key: string, ..._params: Array<any>): Promise<void>;
-        /** 清空所有事件 */
-        Clear(): void;
-    }
-    /** 委托池(单绑定) */
-    export class DelegateSinglePool implements IDelegate {
-        /** 对象池 */
-        private _tPools;
-        /** 构造函数 */
-        constructor();
-        /**
-        * 注册监听事件
-        * @param _key 事件名称
-        * @param _event 回调函数
-        * @param _target 绑定对象
-        * @param _times 执行次数
-        */
-        Register(_key: string, _event: InterfaceUtility.IEvent, _target: any, _times?: number): boolean;
-        /**
-        * 移除监听事件
-        * @param _key 事件名称
-        * @param _target 绑定对象
-        * @param _event 回调函数
-        */
-        Degister(_key: string, _event: InterfaceUtility.IEvent, _target: any): boolean;
-        /**
-        * 派发监听事件
-        * @param _key 事件名称
-        * @param _params 回调函数参数
-        */
-        Invoke<T>(_key: string, ..._params: Array<any>): Promise<void>;
-        /** 清空所有事件 */
-        Clear(): void;
-    }
-    /** 反射池<字典> */
-    export class ReflectionPool<T> {
-        /** 反射池 */
-        private _reflectionPool;
-        /** 构造函数 */
-        constructor();
-        /** 获取数量 */
-        get Count(): number;
-        /** 获取反射类型 */
-        GetObject(_key: string): InterfaceUtility.IType<T>;
-        /** 获取类型 */
-        GetType(_key: string): InterfaceUtility.IType<T>;
-        /** 获取所有反射类型 */
-        GetObjects(): Map<string, InterfaceUtility.IType<T>>;
-        /** 创建反射实例 */
-        CreatInstance<K extends T>(_key: string, ...params: any[]): K;
-        /** 添加反射类型 */
-        Add(_key: string, _t: InterfaceUtility.IType<T>): boolean;
-        /** 移除反射类型 */
-        Remove(_key: string): boolean;
-        /** 移除所有反射类型 */
-        RemoveAll(): void;
-        /** 反射类型是否存在 */
-        Exist(_key: string): boolean;
-    }
-    /** 事件系统 */
-    export class EventSystem {
-        /** 目标对象管理池 */
-        private _objects;
-        constructor(_objects: ObjectUtility.MapPool<object>);
-        /** 事务映射池 */
-        private static _delegateMappingPool;
-        /**
-         * 添加事件装饰器
-         * @param _key 触发主键
-         * @param _times 触发次数
-         * @params 提示：绑定的函数回参:OnName(sender:object,...params[])
-         */
-        static Decorator(_key: string, _times?: number): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
-        /**
-         * 派发(广播)事件
-         * @param _sender 派发者
-         * @param _key 事件Key
-         * @param params 透传参数
-         * @returns 触发结果
-         */
-        Invoke(_sender: object, _key: string, ...params: Array<any>): void;
-        /** 获取所有事件 */
-        GetAll(): ObjectUtility.ArrayPool<IDelegateEvent>;
-    }
-    /** 委托事件接口 */
-    export interface IDelegateEvent {
-        /** 派发键 */
-        key: string;
-        /** 派发类名 */
-        className: string;
-        /** 派发事件名 */
-        eventName: string;
-        /** 派发次数 */
-        times: number;
-    }
-    export {};
-}
+/*********************************************************************************
+  * FileName     : ObjectPool
+  * FileBasename : ObjectPool.ts
+  * Author       : Seven_9t
+  * Date         : Sat Mar 25 2023 15:05:05 GMT+0800 (中国标准时间)
+  * Description  : db://assets/frame/script/base/ObjectPool.ts
+  * Version      : v3.6
+  * Others       : 修改默认TS脚本模板路径 D:\Cocos\CocosDashboard\resources\.editors\Creator\<Version>\resources\resources\3d\engine\editor\assets\default_file_content\ts
+  * ManualUrl    : <指南手册>    https://docs.cocos.com/creator/3.6/manual/zh/
+  *              : <脚本手册>    https://docs.cocos.com/creator/3.6/manual/zh/scripting/
+  *              : <接口手册>    https://docs.cocos.com/creator/api/zh/#/docs/3.6/zh/README
+  *              : <生命周期手册>https://docs.cocos.com/creator/3.6/manual/zh/scripting/life-cycle-callbacks.html
+
+**********************************************************************************/
+import { InterfaceUtility } from "./InterfaceUtility";
+/** 对象工具 */
+export declare namespace ObjectUtility {
+    /** 空对象类 */
+    export class EmptyObject {
+    }
+    /** 获取对象所有属性 */
+    export function GetPropertys<T>(_object: T): Array<string>;
+    /** 检测对象属性是否存在 */
+    export function HasProperty(_object: object, _propertyKey: string): boolean;
+    /** 是否是对象 */
+    export function IsObject(_target: any): boolean;
+    /** 是否是数组 */
+    export function IsArray(_target: any): boolean;
+    /** 是否是函数 */
+    export function IsFunction(_target: any): boolean;
+    /**
+     * 判断是否继承自基类
+     * @param _target 目标对象实例
+     * @param _className 基类类名
+     * @returns 匹配结果
+     */
+    export function InstanceOf(_target: object, _className: string): boolean;
+    /** 克隆对象 */
+    export function Clone<T>(_target: T, ...params: any[]): T;
+    /** 克隆并赋值 */
+    export function CloneAssign<T>(_target: T, ...params: any[]): T;
+    /** 数据赋值 */
+    export function Assign<T extends object>(_target: T, _source: Partial<object>): T;
+    /**
+     * 将对象序列化为Json字符串
+     * @param _object 一个JavaScript值，通常是要转换的对象或数组。
+     * @param _replacer 转换结果的函数。
+     * @param _space 在返回值JSON文本中添加缩进、空白和换行字符，使其更易于阅读。
+     * @returns 序列化后对象(需要自行转JSON.stringify)
+     */
+    export function Encode(_object: object, _replacer?: (this: any, key: string, value: any) => any, _space?: string | number): Record<string, any>;
+    /** 将Json字符串反序列化为对象(对象带有函数则无效,需要执行浅拷贝或深拷贝) */
+    export function Decode<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
+    /** 浅拷贝 */
+    export function ShallowCopy<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
+    /** 深拷贝 */
+    export function DeepCopy<T extends object>(_target: InterfaceUtility.IType<T>, _source: T, ...params: any[]): T;
+    /** 深拷贝 TODO */
+    export function Deep(_target: any, _bitmask: boolean): any;
+    /** 深拷贝数组 */
+    export function DeepCopyArray(_target: any): any;
+    /** 对象操作泛型接口 */
+    interface IObjectOperation<T> {
+        /** 获取数量 */
+        get Count(): number;
+        /** 获取对象 */
+        Get(_key: number | string): T;
+        /** 获取对象组 */
+        Gets(_keys: Array<number | string>): Array<T>;
+        /** 获取所有对象 */
+        GetAll(): Array<T> | Map<string, T>;
+        /** 添加对象实例 */
+        Add(..._param: any[]): boolean;
+        /** 移除对象实例 */
+        Remove(_t: number | string | T): boolean;
+        /** 移除所有对象实例 */
+        RemoveAll(): void;
+        /** 对象实例是否存在 */
+        Exist(_t: number | string | T): boolean;
+    }
+    /** 对象池<数组> */
+    export class ArrayPool<T extends object | any> implements IObjectOperation<T> {
+        /** 对象池 */
+        private _tPools;
+        /** 构造函数 */
+        constructor();
+        /** 获取数量 */
+        get Count(): number;
+        /** 获取对象 */
+        Get<K extends T>(_index: number): K;
+        /** 获取对象组 */
+        Gets<K extends T>(_indexs: Array<number>): Array<K>;
+        /** 获取所有对象 */
+        GetAll(): Array<T>;
+        /** 添加对象实例 */
+        Add(_t: T): boolean;
+        /** 移除对象实例 */
+        Remove(_t: T | number): boolean;
+        /** 移除所有对象实例 */
+        RemoveAll(): void;
+        /** 对象实例是否存在 */
+        Exist(_t: T | number): boolean;
+    }
+    /** 对象池<字典> */
+    export class MapPool<T extends object> implements IObjectOperation<T> {
+        /** 对象池 */
+        private _tPools;
+        /** 构造函数 */
+        constructor(_map?: Map<string, T>);
+        /** 获取数量 */
+        get Count(): number;
+        /** 获取对象 */
+        Get<K extends T>(_key: string): K;
+        /** 获取对象组 */
+        Gets<K extends T>(_keys: Array<string>): Array<K>;
+        /** 获取所有对象 */
+        GetAll(): Map<string, T>;
+        /** 添加对象实例 */
+        Add(_key: string, _t: T): boolean;
+        /** 设置对象 */
+        Set<K extends T>(_key: string, _t: T): K;
+        /** 移除对象实例 */
+        Remove(_key: string): boolean;
+        /** 移除所有对象实例 */
+        RemoveAll(): void;
+        /** 对象实例是否存在 */
+        Exist(_t: string): boolean;
+        /** 所有键转数组 */
+        KeysToArray(): Array<string>;
+        /** 所有值转数组 */
+        ValuesToArray(): Array<T>;
+    }
+    /** 队列池<队列> */
+    export class QueuePool<T extends object> {
+        /** 队列数组 */
+        private _tPools;
+        constructor();
+        /** 入队 */
+        Enqueue(_t: T): void;
+        /** 出队 */
+        Dequeue(): T | undefined;
+        /** 查看队首元素 */
+        Peek(): T | undefined;
+        /** 判断队列是否为空 */
+        IsEmpty(): boolean;
+        /** 获取队列大小 */
+        Size(): number;
+        /** 清空队列 */
+        Clear(): void;
+        /** 克隆 */
+        Clone(): Array<T>;
+    }
+    /** 管线 */
+    export class PipeLine<T extends object> {
+        /** 事件管线 */
+        private _tPools;
+        /** 管线是否已启动 */
+        private _isStarted;
+        /** 管线是否已启动 */
+        private _isEnded;
+        /** 开关 */
+        private _switch;
+        constructor();
+        /** 获取数量 */
+        get Count(): number;
+        /** 注册事件 */
+        Register(_pipeline: ((_params: T) => Promise<T>) | PipeLine<T>): boolean;
+        /** 注销事件 */
+        Degister(_pipeline: ((_params: T) => Promise<T>) | PipeLine<T>): boolean;
+        /** 启动事件 */
+        Start(_params: T): Promise<T>;
+        /** 停止事件 */
+        Stop(): void;
+    }
+    /** 委托接口 */
+    export interface IDelegate {
+        /** 注册 */
+        Register(_key: string, _callback: InterfaceUtility.IEvent, _target: any, _times: number): boolean;
+        /** 注销 */
+        Degister(_key: string, _callback: InterfaceUtility.IEvent, _target: any): boolean;
+        /** 通知 */
+        Invoke(_key: string, ...params: Array<any>): Promise<void>;
+        /** 清除 */
+        Clear(): void;
+    }
+    /** 委托池(多绑定) */
+    export class DelegateMultiplePool implements IDelegate {
+        /** 对象池 */
+        private _tPools;
+        /** 构造函数 */
+        constructor();
+        /**
+         * 注册监听事件
+         * @param _key 事件名称
+         * @param _event 回调函数
+         * @param _target 绑定对象
+         * @param _times 执行次数
+         */
+        Register(_key: string, _event: InterfaceUtility.IEvent, _times?: number): boolean;
+        /**
+        * 移除监听事件
+        * @param _key 事件名称
+        * @param _event 回调函数
+        * @param _target 绑定对象
+        */
+        Degister(_key: string, _event: InterfaceUtility.IEvent): boolean;
+        /**
+        * 派发监听事件
+        * @param _key 事件名称
+        * @param _params 回调参数
+        */
+        Invoke<T>(_key: string, ..._params: Array<any>): Promise<void>;
+        /** 清空所有事件 */
+        Clear(): void;
+    }
+    /** 委托池(单绑定) */
+    export class DelegateSinglePool implements IDelegate {
+        /** 对象池 */
+        private _tPools;
+        /** 构造函数 */
+        constructor();
+        /**
+        * 注册监听事件
+        * @param _key 事件名称
+        * @param _event 回调函数
+        * @param _target 绑定对象
+        * @param _times 执行次数
+        */
+        Register(_key: string, _event: InterfaceUtility.IEvent, _target: any, _times?: number): boolean;
+        /**
+        * 移除监听事件
+        * @param _key 事件名称
+        * @param _target 绑定对象
+        * @param _event 回调函数
+        */
+        Degister(_key: string, _event: InterfaceUtility.IEvent, _target: any): boolean;
+        /**
+        * 派发监听事件
+        * @param _key 事件名称
+        * @param _params 回调函数参数
+        */
+        Invoke<T>(_key: string, ..._params: Array<any>): Promise<void>;
+        /** 清空所有事件 */
+        Clear(): void;
+    }
+    /** 反射池<字典> */
+    export class ReflectionPool<T> {
+        /** 反射池 */
+        private _reflectionPool;
+        /** 构造函数 */
+        constructor();
+        /** 获取数量 */
+        get Count(): number;
+        /** 获取反射类型 */
+        GetObject(_key: string): InterfaceUtility.IType<T>;
+        /** 获取类型 */
+        GetType(_key: string): InterfaceUtility.IType<T>;
+        /** 获取所有反射类型 */
+        GetObjects(): Map<string, InterfaceUtility.IType<T>>;
+        /** 创建反射实例 */
+        CreatInstance<K extends T>(_key: string, ...params: any[]): K;
+        /** 添加反射类型 */
+        Add(_key: string, _t: InterfaceUtility.IType<T>): boolean;
+        /** 移除反射类型 */
+        Remove(_key: string): boolean;
+        /** 移除所有反射类型 */
+        RemoveAll(): void;
+        /** 反射类型是否存在 */
+        Exist(_key: string): boolean;
+    }
+    /** 事件系统 */
+    export class EventSystem {
+        /** 目标对象管理池 */
+        private _objects;
+        constructor(_objects: ObjectUtility.MapPool<object>);
+        /** 事务映射池 */
+        private static _delegateMappingPool;
+        /**
+         * 添加事件装饰器
+         * @param _key 触发主键
+         * @param _times 触发次数
+         * @params 提示：绑定的函数回参:OnName(sender:object,...params[])
+         */
+        static Decorator(_key: string, _times?: number): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+        /**
+         * 派发(广播)事件
+         * @param _sender 派发者
+         * @param _key 事件Key
+         * @param params 透传参数
+         * @returns 触发结果
+         */
+        Invoke(_sender: object, _key: string, ...params: Array<any>): void;
+        /** 获取所有事件 */
+        GetAll(): ObjectUtility.ArrayPool<IDelegateEvent>;
+    }
+    /** 委托事件接口 */
+    export interface IDelegateEvent {
+        /** 派发键 */
+        key: string;
+        /** 派发类名 */
+        className: string;
+        /** 派发事件名 */
+        eventName: string;
+        /** 派发次数 */
+        times: number;
+    }
+    export {};
+}