@zhongguo168a/yxeditor-common 0.0.15 → 0.0.16

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { HorizontalTextAlignment, VerticalTextAlignment, Scheduler, Prefab, Node, Component, ISchedulable, AssetManager, Asset, SpriteAtlas, Vec2, Vec3, Vec4 } from 'cc';
+import { HorizontalTextAlignment, VerticalTextAlignment, Scheduler, Prefab, Node, Component, ISchedulable, AssetManager, Asset, SpriteAtlas, Camera, Canvas, Vec2, Vec3, Vec4, Widget, UITransform, math } from 'cc';
 
 interface IError {
     isCancel(): boolean;
@@ -1536,6 +1536,63 @@ declare class SamplePoolSet {
     protected pools: {};
 }
 
+declare class ArrayUtil {
+    lastItem(array: any[]): any;
+    unique(array: any[]): any[];
+    removeSelf(arr: any[], item: any): void;
+    /**
+     *
+     * @param arr
+     * @param desc 降序
+     */
+    sortNumber(arr: any[], desc?: boolean): any[];
+    sortString(arr: any[], desc?: boolean): any[];
+    getByPath(target: any, key: string): any;
+    sortObject(arr: any[], desc: boolean, ...paths: string[]): any[];
+    sortBySeq(arr: any[], desc: boolean, seq: {
+        [key: string]: number;
+    }, key?: string): any[];
+    indexOfConf(arr: any[], caller: any, f: (item: any) => boolean): number;
+}
+declare const arrayutil: ArrayUtil;
+
+declare class BitUtil {
+    getState(state: number, key: number): boolean;
+    setState(state: number, key: number, value: boolean): number;
+    /**
+     * @param state
+     * @param key
+     */
+    getStateBig(state: bigint, key: bigint): boolean;
+    setStateBig(state: bigint, key: bigint, value: boolean): bigint;
+    /**
+     * key从0开始
+     * @param val
+     */
+    convertToState(val: {
+        [key: string]: boolean;
+    }): number;
+    /**
+     * 判断是否匹配
+     * @param target
+     * @param match 0-返回true
+     */
+    match(target: number, match: number): boolean;
+}
+declare const bitutil: BitUtil;
+
+declare class CameraUtil {
+    getUICamera(): Camera;
+}
+declare let camerautil: CameraUtil;
+
+declare class CanvasUtil {
+    getCanvas(): Canvas;
+    protected onSceneDestroyed(event: any): void;
+    _canvas: Canvas;
+}
+declare let canvasutil: CanvasUtil;
+
 declare class ConvertUtil {
     anyToBoolean(val: any, defaultValue?: boolean): boolean;
     anyToInt(val: any, defaultValue?: number): number;
@@ -1550,6 +1607,97 @@ declare class ConvertUtil {
 }
 declare const convertutil: ConvertUtil;
 
+declare class DocUtil {
+    copyToClip(value: string): boolean;
+    selectText(textbox: any, startIndex: any, stopIndex: any): void;
+}
+declare var docutil: DocUtil;
+
+declare class EventUtil {
+}
+/**
+ * 框架的事件
+ */
+declare const eventutil: EventUtil;
+
+declare class FloatUtil {
+    epsilon: number;
+    neq(a: number, b: number, threshold?: number): boolean;
+    eq(a: number, b: number, threshold?: number): boolean;
+    gt(a: number, b: number, threshold?: number): boolean;
+    lt(a: number, b: number, threshold?: number): boolean;
+    geq(a: number, b: number, threshold?: number): boolean;
+    leq(a: number, b: number, threshold?: number): boolean;
+}
+declare let floatutil: FloatUtil;
+
+declare namespace formatutil {
+    /**
+     * 格式化数字
+     * @param format 第nn天
+     * @param val
+     */
+    function toChinese(formatter: string, val: number): string;
+    /**
+     * 转换为 x亿x万
+     * @param val
+     */
+    function format数字使用万亿(val: number | string): string;
+    /**
+     * 格式化货币，每N位增加一个逗号识别
+     * @param val
+     * @param N
+     */
+    function format数字使用逗号(val: number | string, N?: number): string;
+}
+
+declare enum GeometryDirection {
+    East = 0,
+    SouthEast = 1,
+    South = 2,
+    SouthWest = 3,
+    West = 4,
+    NorthWest = 5,
+    North = 6,
+    NorthEast = 7
+}
+declare class GeometryUtil {
+    /**
+     *  mode，8表示八方向，2表示二方向(左右），4表示4方向
+     * @param dot
+     * @param mode
+     */
+    angleToDirection(dot: number, mode?: number): GeometryDirection;
+}
+declare let geoutil: GeometryUtil;
+
+declare class IdentUtil {
+    /**
+     * 设置时间的基线，通过减去已经过去的时间，可缩短id长度
+     * 注：同一个项目必须拥有同样的基线，否则有几率出现相同的id！
+     * 注2：基线必须与精度符合
+     * @param time
+     */
+    setTimeBaseline(time: number): void;
+    protected _baseline: number;
+    /**
+     * 设置时间的精度
+     * @param precision
+     */
+    setTimePrecision(precision: "ms" | "s"): void;
+    protected _precision: string;
+    /**
+     * 设置随机数的长度
+     * @param value
+     */
+    setRandLength(value?: number): void;
+    protected _randLength: number;
+    genOne(): string;
+    protected _count: number;
+    protected _lastTime: number;
+}
+declare const identutil: IdentUtil;
+
 declare class MapUtil {
     /**
      * 获取所欲的值
@@ -1665,32 +1813,16 @@ declare class MapUtil {
 }
 declare const maputil: MapUtil;
 
-declare class UIUtil {
-    /**
-     * 格式化节点的uuid，用于树结构
-     * 树结构的路径的反斜杠与uuid有冲突
-     * @param uuid
-     */
-    formatUUIDForTree(uuid: string): string;
-    /**
-     * x, y 使用 鼠标点击事件产生的 event.getLocation()坐标
-     * @param target
-     * @param x
-     * @param y
-     */
-    hitTest(target: Node, x: number, y: number): boolean;
-    findNode(node: Node, name: string): Node;
-    walk(node: Node, f: (target: Node) => boolean): void;
-    _walk(node: Node, f: (target: Node) => boolean): boolean;
-}
-declare const uiutil: UIUtil;
-
-declare class EventUtil {
+declare class MathUtil {
+    version: number;
+    TempVec2: Vec2;
+    TempVec3: Vec3;
+    TempVec4: Vec4;
+    convertVec2to3(vec2: Vec2, useTemp?: boolean): Vec3;
+    convertVec3to2(vec3: Vec3, useTemp?: boolean): Vec2;
+    isOdd(value: number): boolean;
 }
-/**
- * 框架的事件
- */
-declare const eventutil: EventUtil;
+declare const mathutil: MathUtil;
 
 declare class NetUtil {
     decodeLocationSearch(search: string): any;
@@ -1703,116 +1835,14 @@ declare class NetUtil {
 }
 declare const netutil: NetUtil;
 
-declare class ArrayUtil {
-    lastItem(array: any[]): any;
-    unique(array: any[]): any[];
-    removeSelf(arr: any[], item: any): void;
-    /**
-     *
-     * @param arr
-     * @param desc 降序
-     */
-    sortNumber(arr: any[], desc?: boolean): any[];
-    sortString(arr: any[], desc?: boolean): any[];
-    getByPath(target: any, key: string): any;
-    sortObject(arr: any[], desc: boolean, ...paths: string[]): any[];
-    sortBySeq(arr: any[], desc: boolean, seq: {
-        [key: string]: number;
-    }, key?: string): any[];
-    indexOfConf(arr: any[], caller: any, f: (item: any) => boolean): number;
-}
-declare const arrayutil: ArrayUtil;
-
-declare class ScaleUtil {
-    tenToAny: string[];
-    allstr: string;
-    randString(size: number, n: number): string;
-    decimalTo(num: number, n: number): string;
-    findkey(instr: string): number;
-    toDecimal(num: string, n: number): number;
-}
-declare const scaleutil: ScaleUtil;
-
-declare class BitUtil {
-    getState(state: number, key: number): boolean;
-    setState(state: number, key: number, value: boolean): number;
-    /**
-     * @param state
-     * @param key
-     */
-    getStateBig(state: bigint, key: bigint): boolean;
-    setStateBig(state: bigint, key: bigint, value: boolean): bigint;
-    /**
-     * key从0开始
-     * @param val
-     */
-    convertToState(val: {
-        [key: string]: boolean;
-    }): number;
-    /**
-     * 判断是否匹配
-     * @param target
-     * @param match 0-返回true
-     */
-    match(target: number, match: number): boolean;
-}
-declare const bitutil: BitUtil;
-
-declare class StringUtil {
-    lowerFirst(key: string): string;
-    upperFirst(key: string): string;
-    cjkEncode(text: any): string;
-    replaceFormat(format: string, source: any): string;
-    /**
-     *
-     * @param format
-     * @param source
-     */
-    evalFormat(format: string, source: any): string;
-    splitLast(val: string, separator: string): string;
-    /**
-     * 从最后一个分隔符截断字符串，返回截断的左右字符串
-     * @param val
-     * @param separator
-     */
-    splitLastArray(val: string, separator: string): [string, string];
-    /**
-     * 截断字符串
-     * @param val
-     * @param separator
-     * @return [最终的字符串, 被截断的字符串]
-     */
-    truncateLast(val: string, separator: string): [string, string];
-    fill(str: string, char: string, length: number): string;
-}
-declare const stringutil: StringUtil;
-
-declare class IdentUtil {
-    /**
-     * 设置时间的基线，通过减去已经过去的时间，可缩短id长度
-     * 注：同一个项目必须拥有同样的基线，否则有几率出现相同的id！
-     * 注2：基线必须与精度符合
-     * @param time
-     */
-    setTimeBaseline(time: number): void;
-    protected _baseline: number;
-    /**
-     * 设置时间的精度
-     * @param precision
-     */
-    setTimePrecision(precision: "ms" | "s"): void;
-    protected _precision: string;
-    /**
-     * 设置随机数的长度
-     * @param value
-     */
-    setRandLength(value?: number): void;
-    protected _randLength: number;
-    genOne(): string;
-    protected _count: number;
-    protected _lastTime: number;
+declare class PathUtil {
+    getDir(path: string): string;
+    getRelativePath(fromPath: string, toPath: string): string;
+    getSamePath(fromPath: string, toPath: string): string;
+    protected validatePath(path: string): void;
+    protected splitPath(path: string): string[];
 }
-declare const identutil: IdentUtil;
+declare const pathutil: PathUtil;
 
 declare class RandUtil {
     /**
@@ -1844,17 +1874,6 @@ declare class RandUtil {
 }
 declare const randutil: RandUtil;
 
-declare class MathUtil {
-    version: number;
-    TempVec2: Vec2;
-    TempVec3: Vec3;
-    TempVec4: Vec4;
-    convertVec2to3(vec2: Vec2, useTemp?: boolean): Vec3;
-    convertVec3to2(vec3: Vec3, useTemp?: boolean): Vec2;
-    isOdd(value: number): boolean;
-}
-declare const mathutil: MathUtil;
-
 declare class ResUtil {
     loadResource(path: string): Promise<[any, IError]>;
     preloadResource(path: string): Promise<[any, IError]>;
@@ -1867,6 +1886,48 @@ declare class ResUtil {
 }
 declare var resutil: ResUtil;
 
+declare function parsePlist(plist: any, texture: any): SpriteAtlas;
+declare function loadAtlas(url: any, callback: any): void;
+
+declare class ScaleUtil {
+    tenToAny: string[];
+    allstr: string;
+    randString(size: number, n: number): string;
+    decimalTo(num: number, n: number): string;
+    findkey(instr: string): number;
+    toDecimal(num: string, n: number): number;
+}
+declare const scaleutil: ScaleUtil;
+
+declare class StringUtil {
+    lowerFirst(key: string): string;
+    upperFirst(key: string): string;
+    cjkEncode(text: any): string;
+    replaceFormat(format: string, source: any): string;
+    /**
+     *
+     * @param format
+     * @param source
+     */
+    evalFormat(format: string, source: any): string;
+    splitLast(val: string, separator: string): string;
+    /**
+     * 从最后一个分隔符截断字符串，返回截断的左右字符串
+     * @param val
+     * @param separator
+     */
+    splitLastArray(val: string, separator: string): [string, string];
+    /**
+     * 截断字符串
+     * @param val
+     * @param separator
+     * @return [最终的字符串, 被截断的字符串]
+     */
+    truncateLast(val: string, separator: string): [string, string];
+    fill(str: string, char: string, length: number): string;
+}
+declare const stringutil: StringUtil;
+
 declare class TimeUtil {
     sleep(time: number): Promise<void>;
     /**
@@ -1883,68 +1944,104 @@ declare class TimeUtil {
 }
 declare const timeutil: TimeUtil;
 
-declare enum GeometryDirection {
-    East = 0,
-    SouthEast = 1,
-    South = 2,
-    SouthWest = 3,
-    West = 4,
-    NorthWest = 5,
-    North = 6,
-    NorthEast = 7
-}
-declare class GeometryUtil {
+declare class TreeUtil {
     /**
-     *  mode，8表示八方向，2表示二方向(左右），4表示4方向
-     * @param dot
-     * @param mode
+     * 保存指定标签[tag]的值等于[value]的节点
+     * @param root
+     * @param key 存储的键
+     * @param tag
+     * @param value
      */
-    angleToDirection(dot: number, mode?: number): GeometryDirection;
-}
-declare let geoutil: GeometryUtil;
-
-declare namespace formatutil {
+    saveTagToLocalStorage(root: TreeRoot, key: string, tag: string, value: any): void;
     /**
-     * 格式化数字
-     * @param format 第nn天
-     * @param val
+     * 从ls中加载指定标签[tag]的值还原到[root]。
+     * 返回localStorage是否存在键值
+     * @param root
+     * @param key
+     * @param tag
+     * @param value
      */
-    function toChinese(formatter: string, val: number): string;
+    loadTagFromLocalStorage(root: TreeRoot, key: string, tag: string, value: any): boolean;
+}
+declare var treeutil: TreeUtil;
+
+declare class UIUtil {
     /**
-     * 转换为 x亿x万
-     * @param val
+     * 格式化节点的uuid，用于树结构
+     * 树结构的路径的反斜杠与uuid有冲突
+     * @param uuid
      */
-    function format数字使用万亿(val: number | string): string;
+    formatUUIDForTree(uuid: string): string;
     /**
-     * 格式化货币，每N位增加一个逗号识别
-     * @param val
-     * @param N
+     * x, y 使用 鼠标点击事件产生的 event.getLocation()坐标
+     * @param target
+     * @param x
+     * @param y
      */
-    function format数字使用逗号(val: number | string, N?: number): string;
-}
-
-declare class FloatUtil {
-    epsilon: number;
-    neq(a: number, b: number, threshold?: number): boolean;
-    eq(a: number, b: number, threshold?: number): boolean;
-    gt(a: number, b: number, threshold?: number): boolean;
-    lt(a: number, b: number, threshold?: number): boolean;
-    geq(a: number, b: number, threshold?: number): boolean;
-    leq(a: number, b: number, threshold?: number): boolean;
+    hitTest(target: Node, x: number, y: number): boolean;
+    findNode(node: Node, name: string): Node;
+    walk(node: Node, f: (target: Node) => boolean): void;
+    _walk(node: Node, f: (target: Node) => boolean): boolean;
 }
-declare let floatutil: FloatUtil;
+declare const uiutil: UIUtil;
 
-declare class PathUtil {
-    getDir(path: string): string;
-    getRelativePath(fromPath: string, toPath: string): string;
-    getSamePath(fromPath: string, toPath: string): string;
-    protected validatePath(path: string): void;
-    protected splitPath(path: string): string[];
+declare class WidgetAlign {
+    node: Node;
+    targetNode: Node;
+    protected nodeWidget: Widget;
+    protected parentTransform: UITransform;
+    protected targetTransform: UITransform;
+    protected uipos: math.Vec3;
+    constructor(node: Node, targetNode: Node);
+    topTop(distance?: number): void;
+    topBottom(distance?: number): void;
+    leftleft(distance?: number): void;
+    leftRight(distance?: number): void;
+}
+declare class WidgetUtil {
+    /**
+     * 与目标顶对齐
+     * @param node 需要修改的节点
+     * @param parent 对齐的父节点
+     * @param distance
+     */
+    alignTop(node: Node, parent: Node, distance?: number): void;
+    /**
+     * 与目标顶对齐，node和target都必须在渲染树中
+     * @param node 需要修改的节点
+     * @param target 对齐目标
+     * @param distance
+     */
+    alignTopWorld(node: Node, target: Node, distance?: number): void;
+    /**
+     * 与目标顶对齐，node和target都必须在渲染树中
+     * @param node 需要修改的节点
+     * @param target 对齐目标
+     * @param distance
+     */
+    alignBottomWorld(node: Node, target: Node, distance?: number): void;
+    /**
+     * 调整【node】的widget，对齐【targetNode】
+     * @param node
+     * @param targetNode
+     */
+    align(node: Node, targetNode: Node): WidgetAlign;
+    /**
+     * 与目标右对齐
+     * @param node 需要修改的节点
+     * @param parent 对齐的父节点
+     * @param distance
+     */
+    alignLeft(node: Node, parent: Node, distance?: number): void;
+    /**
+     * 与目标右对齐
+     * @param node 需要修改的节点
+     * @param target 对齐目标
+     * @param distance
+     */
+    alignLeftWorld(node: Node, target: Node, distance?: number): void;
 }
-declare const pathutil: PathUtil;
-
-declare function parsePlist(plist: any, texture: any): SpriteAtlas;
-declare function loadAtlas(url: any, callback: any): void;
+declare var widgetutil: WidgetUtil;
 
-export { ArrayUtil, AssetLoader, AssetURI, BitUtil, CallbackList, Controller, ControllerDict, ControllerSet, ConvertUtil, DictIterator, DictNode, DictSource, Dictionary, Dispatcher, ErrorUtil, EventItem, EventManager, EventUtil, Factory, FloatUtil, GeometryUtil, IdentUtil, LOGGER_EVENT, LinkError, List, ListIterator, ListNode, ListSource, Listener, LogLevel, LogManager, Logger, MapUtil, MathUtil, Model, Module, NetUtil, Page, PageController, PageEvent, PageLayer, PageList, PageRepo, PageState, PathUtil, Pool, RandUtil, Route, SampleCallbackList, SamplePool, SamplePoolSet, ScaleUtil, SimpleModel, StringUtil, TimeUtil, Timer, TreeIterator, TreeNode, TreeNodePlugin, TreeRoot, TreeRootPlugin, UIManager, UIObjectDict, UIPoolConfig, UISingleConfig, UIUtil, ViewController, XAssetManager, XEvent, arrayutil, assetx, bitutil, convertutil, ctrlrepo, errorutil, eventmgr, eventutil, floatutil, formatutil, geoutil, identutil, loadAtlas, logmgr, maputil, mathutil, netutil, pagerepo, parseAtlas, parsePlist, pathutil, randutil, resutil, scaleutil, stringutil, timer, timeutil, uidict, uimgr, uiutil };
+export { ArrayUtil, AssetLoader, AssetURI, BitUtil, CallbackList, CameraUtil, CanvasUtil, Controller, ControllerDict, ControllerSet, ConvertUtil, DictIterator, DictNode, DictSource, Dictionary, Dispatcher, DocUtil, ErrorUtil, EventItem, EventManager, EventUtil, Factory, FloatUtil, GeometryUtil, IdentUtil, LOGGER_EVENT, LinkError, List, ListIterator, ListNode, ListSource, Listener, LogLevel, LogManager, Logger, MapUtil, MathUtil, Model, Module, NetUtil, Page, PageController, PageEvent, PageLayer, PageList, PageRepo, PageState, PathUtil, Pool, RandUtil, Route, SampleCallbackList, SamplePool, SamplePoolSet, ScaleUtil, SimpleModel, StringUtil, TimeUtil, Timer, TreeIterator, TreeNode, TreeNodePlugin, TreeRoot, TreeRootPlugin, TreeUtil, UIManager, UIObjectDict, UIPoolConfig, UISingleConfig, UIUtil, ViewController, WidgetAlign, WidgetUtil, XAssetManager, XEvent, arrayutil, assetx, bitutil, camerautil, canvasutil, convertutil, ctrlrepo, docutil, errorutil, eventmgr, eventutil, floatutil, formatutil, geoutil, identutil, loadAtlas, logmgr, maputil, mathutil, netutil, pagerepo, parseAtlas, parsePlist, pathutil, randutil, resutil, scaleutil, stringutil, timer, timeutil, treeutil, uidict, uimgr, uiutil, widgetutil };
 export type { CreatorFunction, DisposeFunction, IController, IError, IEventManager, IExtend, IListItem, IModel, IModule, IModuleSample, ITreeListItem, RecycleFunction };