From ee47857f2bc236d9da51aecdfc789546b91338df Mon Sep 17 00:00:00 2001 From: dgflash Date: Sun, 13 Oct 2024 12:55:33 +0800 Subject: [PATCH] =?UTF-8?q?1.=20=E6=95=B4=E7=90=86=E6=A1=86=E6=9E=B6?= =?UTF-8?q?=E4=B8=AD=E6=89=80=E6=9C=89=E7=BB=84=E4=BB=B6=E5=9C=A8=E5=B1=9E?= =?UTF-8?q?=E6=80=A7=E6=A3=80=E6=9F=A5=E5=99=A8=E4=B8=AD=E6=98=BE=E7=A4=BA?= =?UTF-8?q?=E8=B7=AF=E5=BE=84=202.=20=E6=A1=86=E6=9E=B6=E9=83=A8=E5=88=86?= =?UTF-8?q?=E6=BA=90=E7=A0=81=E5=85=B3=E8=81=94=E5=9C=A8=E7=BA=BF=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/core/common/audio/AudioManager.ts | 1 + assets/core/common/event/MessageManager.ts | 1 + assets/core/common/loader/ResLoader.ts | 2 ++ assets/core/common/log/Logger.ts | 1 + assets/core/common/random/RandomManager.ts | 5 ++++- assets/core/common/storage/StorageManager.ts | 5 ++++- assets/core/common/timer/Timer.ts | 1 + assets/core/gui/layer/LayerManager.ts | 1 + assets/libs/animator/AnimatorAnimation.ts | 5 +++-- assets/libs/animator/AnimatorCustomization.ts | 7 ++++--- assets/libs/animator/AnimatorDragonBones.ts | 6 ++++-- assets/libs/animator/AnimatorSkeletal.ts | 5 +++-- assets/libs/animator/AnimatorSpine.ts | 6 ++++-- assets/libs/animator/AnimatorSpineSecondary.ts | 6 ++++-- assets/libs/camera/FreeFlightCamera.ts | 2 +- assets/libs/camera/OrbitCamera.ts | 5 +++-- assets/libs/ecs/ECS.ts | 7 +++++-- assets/libs/gui/button/ButtonEffect.ts | 4 ++-- assets/libs/gui/button/ButtonSimple.ts | 4 ++-- assets/libs/gui/button/ButtonTouchLong.ts | 2 +- assets/libs/gui/button/UIButton.ts | 2 +- assets/libs/gui/label/LabelChange.ts | 2 +- assets/libs/gui/label/LabelNumber.ts | 2 +- assets/libs/gui/label/LabelTime.ts | 3 ++- assets/libs/gui/language/LanguageLabel.ts | 3 ++- assets/libs/gui/language/LanguageSpine.ts | 3 ++- assets/libs/gui/language/LanguageSprite.ts | 3 ++- assets/libs/model-view/StringFormat.ts | 2 +- assets/libs/model-view/VMBase.ts | 2 +- assets/libs/model-view/VMCompsEdit.ts | 4 ++-- assets/libs/model-view/VMCustom.ts | 4 ++-- assets/libs/model-view/VMEvent.ts | 4 ++-- assets/libs/model-view/VMLabel.ts | 6 +++--- assets/libs/model-view/VMModify.ts | 4 ++-- assets/libs/model-view/VMParent.ts | 2 +- assets/libs/model-view/VMProgress.ts | 4 ++-- assets/libs/model-view/VMState.ts | 4 ++-- assets/libs/model-view/ui/BhvButtonGroup.ts | 2 +- assets/libs/model-view/ui/BhvFrameIndex.ts | 3 ++- assets/libs/model-view/ui/BhvRollNumber.ts | 4 ++-- assets/libs/model-view/ui/BhvSwitchPage.ts | 3 ++- 41 files changed, 87 insertions(+), 55 deletions(-) diff --git a/assets/core/common/audio/AudioManager.ts b/assets/core/common/audio/AudioManager.ts index c5d1467..670fa3c 100644 --- a/assets/core/common/audio/AudioManager.ts +++ b/assets/core/common/audio/AudioManager.ts @@ -7,6 +7,7 @@ const LOCAL_STORE_KEY = "game_audio"; /** * 音频管理 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037893&doc_id=2873565 * @example // 模块功能通过 oops.audio 调用 oops.audio.playMusic("audios/nocturne"); diff --git a/assets/core/common/event/MessageManager.ts b/assets/core/common/event/MessageManager.ts index b6b4f1d..3bad667 100644 --- a/assets/core/common/event/MessageManager.ts +++ b/assets/core/common/event/MessageManager.ts @@ -66,6 +66,7 @@ export class MessageEventData { /** * 全局消息管理 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037894&doc_id=2873565 * @example // 注册持续监听的全局事件 export class RoleViewComp extends Component{ diff --git a/assets/core/common/loader/ResLoader.ts b/assets/core/common/loader/ResLoader.ts index 0ce681c..ce18c3e 100644 --- a/assets/core/common/loader/ResLoader.ts +++ b/assets/core/common/loader/ResLoader.ts @@ -28,6 +28,8 @@ interface ILoadResArgs { * 1、加载默认resources文件夹中资源 * 2、加载默认bundle远程资源 * 3、主动传递bundle名时，优先加载传递bundle名资源包中的资源 + * + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037901&doc_id=2873565 */ export class ResLoader { //#region 资源配置数据 diff --git a/assets/core/common/log/Logger.ts b/assets/core/common/log/Logger.ts index 2043b6e..fe61966 100644 --- a/assets/core/common/log/Logger.ts +++ b/assets/core/common/log/Logger.ts @@ -27,6 +27,7 @@ var names = { /** * 日志管理 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037904&doc_id=2873565 * @example oops.log.trace("默认标准日志"); oops.log.logConfig("灰色配置日志"); diff --git a/assets/core/common/random/RandomManager.ts b/assets/core/common/random/RandomManager.ts index e24c687..d477b60 100644 --- a/assets/core/common/random/RandomManager.ts +++ b/assets/core/common/random/RandomManager.ts @@ -1,6 +1,9 @@ /** 引擎 utils.ts 中有一些基础数学方法 */ -/** 随机管理 */ +/** + * 随机管理 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037911&doc_id=2873565 + */ export class RandomManager { private static _instance: RandomManager; private random: any = null!; diff --git a/assets/core/common/storage/StorageManager.ts b/assets/core/common/storage/StorageManager.ts index 97bf937..1bd652d 100644 --- a/assets/core/common/storage/StorageManager.ts +++ b/assets/core/common/storage/StorageManager.ts @@ -7,7 +7,10 @@ export interface IStorageSecurity { encryptKey(str: string): string; } -/** 本地存储 */ +/** + * 本地存储 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037957&doc_id=2873565 + */ export class StorageManager { private id: string = null!; private iss: IStorageSecurity = null!; diff --git a/assets/core/common/timer/Timer.ts b/assets/core/common/timer/Timer.ts index 281cd9e..9b162da 100644 --- a/assets/core/common/timer/Timer.ts +++ b/assets/core/common/timer/Timer.ts @@ -7,6 +7,7 @@ /** * 定时触发组件 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037964&doc_id=2873565 * @example export class Test extends Component { // 创建一个定时跳动组件 diff --git a/assets/core/gui/layer/LayerManager.ts b/assets/core/gui/layer/LayerManager.ts index ffff711..eb4c67b 100644 --- a/assets/core/gui/layer/LayerManager.ts +++ b/assets/core/gui/layer/LayerManager.ts @@ -37,6 +37,7 @@ export enum LayerType { /** * 界面配置结构体 + * @help https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037986&doc_id=2873565 * @example // 界面唯一标识 export enum UIID { diff --git a/assets/libs/animator/AnimatorAnimation.ts b/assets/libs/animator/AnimatorAnimation.ts index e0032ad..78185cc 100644 --- a/assets/libs/animator/AnimatorAnimation.ts +++ b/assets/libs/animator/AnimatorAnimation.ts @@ -2,7 +2,7 @@ import { Animation, AnimationState, _decorator } from "cc"; import AnimatorBase, { AnimationPlayer } from "./core/AnimatorBase"; import { AnimatorStateLogic } from "./core/AnimatorStateLogic"; -const { ccclass, property, requireComponent, disallowMultiple, menu } = _decorator; +const { ccclass, property, requireComponent, disallowMultiple, menu, help } = _decorator; /** * Cocos Animation状态机组件 @@ -10,7 +10,8 @@ const { ccclass, property, requireComponent, disallowMultiple, menu } = _decorat @ccclass @disallowMultiple @requireComponent(Animation) -@menu('animator/AnimatorAnimation') +@menu('OopsFramework/Animator/AnimatorAnimation （动画状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export default class AnimatorAnimation extends AnimatorBase { /** Animation组件 */ protected _animation: Animation = null!; diff --git a/assets/libs/animator/AnimatorCustomization.ts b/assets/libs/animator/AnimatorCustomization.ts index 61df6a7..274c13d 100644 --- a/assets/libs/animator/AnimatorCustomization.ts +++ b/assets/libs/animator/AnimatorCustomization.ts @@ -2,18 +2,19 @@ import { _decorator } from "cc"; import AnimatorBase, { AnimationPlayer } from "./core/AnimatorBase"; import { AnimatorStateLogic } from "./core/AnimatorStateLogic"; -const { ccclass, property, menu, disallowMultiple } = _decorator; +const { ccclass, property, disallowMultiple, menu, help } = _decorator; /** * 自定义动画控制的状态机组件 */ @ccclass @disallowMultiple -@menu('animator/AnimatorCustomization') +@menu('OopsFramework/Animator/AnimatorCustomization （自定义状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export default class AnimatorCustomization extends AnimatorBase { /** 此组件必须主动调用onInit初始化 */ @property({ override: true, visible: false }) - protected PlayOnStart: boolean = false; + PlayOnStart: boolean = false; /** * 手动初始化状态机，可传入0-3个参数，类型如下 diff --git a/assets/libs/animator/AnimatorDragonBones.ts b/assets/libs/animator/AnimatorDragonBones.ts index 39fc9a5..8c30222 100644 --- a/assets/libs/animator/AnimatorDragonBones.ts +++ b/assets/libs/animator/AnimatorDragonBones.ts @@ -1,8 +1,8 @@ -import { dragonBones, _decorator } from "cc"; +import { _decorator, dragonBones } from "cc"; import AnimatorBase, { AnimationPlayer } from "./core/AnimatorBase"; import { AnimatorStateLogic } from "./core/AnimatorStateLogic"; -const { ccclass, property, requireComponent, disallowMultiple } = _decorator; +const { ccclass, property, requireComponent, disallowMultiple, menu, help } = _decorator; /** * DragonBones状态机组件 @@ -10,6 +10,8 @@ const { ccclass, property, requireComponent, disallowMultiple } = _decorator; @ccclass @disallowMultiple @requireComponent(dragonBones.ArmatureDisplay) +@menu('OopsFramework/Animator/AnimatorDragonBones （龙骨状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export default class AnimatorDragonBones extends AnimatorBase { /** DragonBones组件 */ private _dragonBones: dragonBones.ArmatureDisplay = null!; diff --git a/assets/libs/animator/AnimatorSkeletal.ts b/assets/libs/animator/AnimatorSkeletal.ts index 96b84e1..6466b95 100644 --- a/assets/libs/animator/AnimatorSkeletal.ts +++ b/assets/libs/animator/AnimatorSkeletal.ts @@ -8,12 +8,13 @@ import { CCFloat, game, SkeletalAnimation, _decorator } from 'cc'; import AnimatorAnimation from './AnimatorAnimation'; -const { ccclass, property, requireComponent, disallowMultiple, menu } = _decorator; +const { ccclass, property, requireComponent, disallowMultiple, menu, help } = _decorator; @ccclass @disallowMultiple @requireComponent(SkeletalAnimation) -@menu('animator/AnimatorSkeletal') +@menu('OopsFramework/Animator/AnimatorSkeletal （骨骼动画状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export class AnimatorSkeletal extends AnimatorAnimation { @property({ type: CCFloat, diff --git a/assets/libs/animator/AnimatorSpine.ts b/assets/libs/animator/AnimatorSpine.ts index 98664bd..0fd2fda 100644 --- a/assets/libs/animator/AnimatorSpine.ts +++ b/assets/libs/animator/AnimatorSpine.ts @@ -1,9 +1,9 @@ -import { sp, _decorator } from "cc"; +import { _decorator, sp } from "cc"; import AnimatorSpineSecondary from "./AnimatorSpineSecondary"; import AnimatorBase, { AnimationPlayer } from "./core/AnimatorBase"; import { AnimatorStateLogic } from "./core/AnimatorStateLogic"; -const { ccclass, property, requireComponent, disallowMultiple } = _decorator; +const { ccclass, property, requireComponent, disallowMultiple, menu, help } = _decorator; /** * Spine状态机组件（主状态机），trackIndex为0 @@ -11,6 +11,8 @@ const { ccclass, property, requireComponent, disallowMultiple } = _decorator; @ccclass @disallowMultiple @requireComponent(sp.Skeleton) +@menu('OopsFramework/Animator/AnimatorSpine（Spine 状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export default class AnimatorSpine extends AnimatorBase { /** spine组件 */ protected _spine: sp.Skeleton = null!; diff --git a/assets/libs/animator/AnimatorSpineSecondary.ts b/assets/libs/animator/AnimatorSpineSecondary.ts index 389fd53..60af756 100644 --- a/assets/libs/animator/AnimatorSpineSecondary.ts +++ b/assets/libs/animator/AnimatorSpineSecondary.ts @@ -1,15 +1,17 @@ -import { sp, _decorator } from "cc"; +import { _decorator, sp } from "cc"; import AnimatorSpine from "./AnimatorSpine"; import AnimatorBase, { AnimationPlayer } from "./core/AnimatorBase"; import { AnimatorStateLogic } from "./core/AnimatorStateLogic"; -const { ccclass, property, requireComponent } = _decorator; +const { ccclass, property, requireComponent, menu, help } = _decorator; /** * Spine状态机组件（次状态机），同一节点可添加多个，用于在不同track中播放动画，trackIndex必须大于0 */ @ccclass @requireComponent(sp.Skeleton) +@menu('OopsFramework/Animator/AnimatorSpine （Spine 次状态机）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12036279&doc_id=2873565') export default class AnimatorSpineSecondary extends AnimatorBase { @property({ tooltip: '动画播放的trackIndex，必须大于0' }) TrackIndex: number = 1; diff --git a/assets/libs/camera/FreeFlightCamera.ts b/assets/libs/camera/FreeFlightCamera.ts index 73c93a3..afa19be 100644 --- a/assets/libs/camera/FreeFlightCamera.ts +++ b/assets/libs/camera/FreeFlightCamera.ts @@ -29,7 +29,7 @@ const KEYCODE = { }; @ccclass("FreeFlightCamera") -@menu('oops/camera/FreeFlightCamera') +@menu('OopsFramework/Camera/FreeFlightCamera （自由飞行摄像机）') export class FreeFlightCamera extends Component { @property({ type: CCFloat, diff --git a/assets/libs/camera/OrbitCamera.ts b/assets/libs/camera/OrbitCamera.ts index 0b4b637..04bca15 100644 --- a/assets/libs/camera/OrbitCamera.ts +++ b/assets/libs/camera/OrbitCamera.ts @@ -1,6 +1,6 @@ -import { Component, EventMouse, EventTouch, input, Input, lerp, Node, Quat, Vec2, Vec3, _decorator } from 'cc'; +import { _decorator, Component, EventMouse, EventTouch, input, Input, lerp, Node, Quat, Vec2, Vec3 } from 'cc'; import { EDITOR } from 'cc/env'; -const { ccclass, property } = _decorator; +const { ccclass, property, menu } = _decorator; let tempVec3 = new Vec3; let tempVec3_2 = new Vec3; @@ -14,6 +14,7 @@ const DeltaFactor = 1 / 200; * 3、固定为第三人称摄像机 */ @ccclass('OrbitCamera') +@menu('OopsFramework/Camera/OrbitCamera （轨道摄影机）') export class OrbitCamera extends Component { @property({ tooltip: "是否启动触摸控制" diff --git a/assets/libs/ecs/ECS.ts b/assets/libs/ecs/ECS.ts index 0fb3f44..77fef16 100644 --- a/assets/libs/ecs/ECS.ts +++ b/assets/libs/ecs/ECS.ts @@ -9,8 +9,11 @@ import { ECSComblockSystem, ECSRootSystem, ECSSystem } from "./ECSSystem"; * ECSComp对象从ECSEntity.remove后，数据组件会回收到ECSModel.compPools组件对象池中 */ -/** Entity-Component-System（实体-组件-系统）框架 */ -export module ecs { +/** + * Entity-Component-System（实体-组件-系统）框架 + * 文档：https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12033388&doc_id=2873565 + */ +export namespace ecs { /** 实体 - 一个概念上的定义，指的是游戏世界中的一个独特物体，是一系列组件的集合 */ export type Entity = ECSEntity; /** 组件 - 一堆数据的集合，即不存在任何的行为，只用来存储状态 */ diff --git a/assets/libs/gui/button/ButtonEffect.ts b/assets/libs/gui/button/ButtonEffect.ts index e8aab13..710a5c3 100644 --- a/assets/libs/gui/button/ButtonEffect.ts +++ b/assets/libs/gui/button/ButtonEffect.ts @@ -10,9 +10,9 @@ import ButtonSimple from "./ButtonSimple"; const { ccclass, property, menu } = _decorator; -/** 有特效短按按钮 */ +/** 有特效按钮 */ @ccclass("ButtonEffect") -@menu('ui/button/ButtonEffect') +@menu('OopsFramework/Button/ButtonEffect （有特效按钮）') export default class ButtonEffect extends ButtonSimple { @property({ tooltip: "是否开启" diff --git a/assets/libs/gui/button/ButtonSimple.ts b/assets/libs/gui/button/ButtonSimple.ts index b1efa7d..9212110 100644 --- a/assets/libs/gui/button/ButtonSimple.ts +++ b/assets/libs/gui/button/ButtonSimple.ts @@ -4,9 +4,9 @@ import { resLoader } from "../../../core/common/loader/ResLoader"; const { ccclass, property, menu } = _decorator; -/** 短按按钮 */ +/** 节点按钮 */ @ccclass("ButtonSimple") -@menu('ui/button/ButtonSimple') +@menu('OopsFramework/Button/ButtonSimple （节点按钮）') export default class ButtonSimple extends Component { @property({ tooltip: "是否只触发一次" diff --git a/assets/libs/gui/button/ButtonTouchLong.ts b/assets/libs/gui/button/ButtonTouchLong.ts index 1a24121..9018d0f 100644 --- a/assets/libs/gui/button/ButtonTouchLong.ts +++ b/assets/libs/gui/button/ButtonTouchLong.ts @@ -11,7 +11,7 @@ const { ccclass, property, menu } = _decorator; /** 长按按钮 */ @ccclass("ButtonTouchLong") -@menu('ui/button/ButtonTouchLong') +@menu('OopsFramework/Button/ButtonTouchLong （长按按钮）') export class ButtonTouchLong extends ButtonEffect { @property({ tooltip: "长按时间（秒）" diff --git a/assets/libs/gui/button/UIButton.ts b/assets/libs/gui/button/UIButton.ts index 067b5f4..0e64258 100644 --- a/assets/libs/gui/button/UIButton.ts +++ b/assets/libs/gui/button/UIButton.ts @@ -10,7 +10,7 @@ const { ccclass, property, menu } = _decorator; * 2、按钮点击触发音效 */ @ccclass("UIButton") -@menu('ui/button/UIButton') +@menu('OopsFramework/Button/UIButton （通用按钮）') export default class UIButton extends Button { @property({ tooltip: "每次触发间隔" diff --git a/assets/libs/gui/label/LabelChange.ts b/assets/libs/gui/label/LabelChange.ts index 608761f..d785dd5 100644 --- a/assets/libs/gui/label/LabelChange.ts +++ b/assets/libs/gui/label/LabelChange.ts @@ -11,7 +11,7 @@ const { ccclass, property, menu } = _decorator; /** 数值变化动画标签组件 */ @ccclass("LabelChange") -@menu('ui/label/LabelChange') +@menu('OopsFramework/Label/LabelChange （数值变化动画标签）') export class LabelChange extends LabelNumber { @property isInteger: boolean = false; diff --git a/assets/libs/gui/label/LabelNumber.ts b/assets/libs/gui/label/LabelNumber.ts index 863d3de..117116b 100644 --- a/assets/libs/gui/label/LabelNumber.ts +++ b/assets/libs/gui/label/LabelNumber.ts @@ -10,7 +10,7 @@ const {ccclass, property, menu} = _decorator; /** 只能显示数字的标签组件 */ @ccclass("LabelNumber") -@menu('ui/label/LabelNumber') +@menu('OopsFramework/Label/LabelNumber （只显示数字的标签）') export default class LabelNumber extends Label { @property({tooltip: "数字"}) _num: number = 0; diff --git a/assets/libs/gui/label/LabelTime.ts b/assets/libs/gui/label/LabelTime.ts index a5b0030..02cccc5 100644 --- a/assets/libs/gui/label/LabelTime.ts +++ b/assets/libs/gui/label/LabelTime.ts @@ -5,8 +5,9 @@ import { TimeUtil } from "../../../core/utils/TimeUtils"; const { ccclass, property, menu } = _decorator; +/** 倒计时标签 */ @ccclass("LabelTime") -@menu('ui/label/LabelTime') +@menu('OopsFramework/Label/LabelTime （倒计时标签）') export default class LabelTime extends Label { @property({ tooltip: "到计时间总时间（单位秒）" diff --git a/assets/libs/gui/language/LanguageLabel.ts b/assets/libs/gui/language/LanguageLabel.ts index 8e2426b..4d7f085 100644 --- a/assets/libs/gui/language/LanguageLabel.ts +++ b/assets/libs/gui/language/LanguageLabel.ts @@ -12,8 +12,9 @@ export class LangLabelParamsItem { value: string = ""; } +/** 文本多语言 */ @ccclass("LanguageLabel") -@menu('ui/language/LanguageLabel') +@menu('OopsFramework/Language/LanguageLabel （文本多语言）') export class LanguageLabel extends Component { @property({ type: LangLabelParamsItem, diff --git a/assets/libs/gui/language/LanguageSpine.ts b/assets/libs/gui/language/LanguageSpine.ts index b9fd84e..10f6c19 100644 --- a/assets/libs/gui/language/LanguageSpine.ts +++ b/assets/libs/gui/language/LanguageSpine.ts @@ -11,8 +11,9 @@ import { LanguageData } from "./LanguageData"; const { ccclass, property, menu } = _decorator; +/** Spine 动画多语言 */ @ccclass("LanguageSpine") -@menu('ui/language/LanguageSpine') +@menu('OopsFramework/Language/LanguageSpine （Spine 动画多语言）') export class LanguageSpine extends Component { @property({ serializable: true }) private _dataID: string = ""; diff --git a/assets/libs/gui/language/LanguageSprite.ts b/assets/libs/gui/language/LanguageSprite.ts index e5464d2..50ce34d 100644 --- a/assets/libs/gui/language/LanguageSprite.ts +++ b/assets/libs/gui/language/LanguageSprite.ts @@ -11,8 +11,9 @@ import { LanguageData } from "./LanguageData"; const { ccclass, property, menu } = _decorator; +/** 图片多语言 */ @ccclass("LanguageSprite") -@menu('ui/language/LanguageSprite') +@menu('OopsFramework/Language/LanguageSprite （图片多语言）') export class LanguageSprite extends Component { @property({ serializable: true }) private _dataID: string = ""; diff --git a/assets/libs/model-view/StringFormat.ts b/assets/libs/model-view/StringFormat.ts index 3cda059..aa31c5a 100644 --- a/assets/libs/model-view/StringFormat.ts +++ b/assets/libs/model-view/StringFormat.ts @@ -9,7 +9,7 @@ class StringFormat { format = format.toLowerCase().trim(); // 不区分大小 let match_func = format.match(/^[a-z|A-Z]+/gi); // 匹配到 format 中的 函数名 - let match_num = format.match(/\d+$/gi); //匹配到 format 中的参数 + let match_num = format.match(/\d+$/gi); // 匹配到 format 中的参数 let func: string = ''; let num: number = 0; let res: number | string = ''; diff --git a/assets/libs/model-view/VMBase.ts b/assets/libs/model-view/VMBase.ts index 4838728..da623a3 100644 --- a/assets/libs/model-view/VMBase.ts +++ b/assets/libs/model-view/VMBase.ts @@ -16,7 +16,7 @@ const { ccclass, help } = _decorator; * watchPath 的基础，只提供绑定功能 和 对应的数据更新函数 */ @ccclass -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMBase.md') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037631&doc_id=2873565') export class VMBase extends Component { /**VM管理 */ VM = VM; diff --git a/assets/libs/model-view/VMCompsEdit.ts b/assets/libs/model-view/VMCompsEdit.ts index 05a6cc6..fa7e786 100644 --- a/assets/libs/model-view/VMCompsEdit.ts +++ b/assets/libs/model-view/VMCompsEdit.ts @@ -16,8 +16,8 @@ enum ACTION_MODE { */ @ccclass @executeInEditMode -@menu('ModelViewer/Edit-Comps (快速组件操作)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMCompsEdit.md') +@menu('OopsFramework/Mvvm/Edit-Comps （快速组件操作）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037632&doc_id=2873565') export default class MVCompsEdit extends Component { @property({ type: [CCString] diff --git a/assets/libs/model-view/VMCustom.ts b/assets/libs/model-view/VMCustom.ts index b3c1582..47ba4bf 100644 --- a/assets/libs/model-view/VMCustom.ts +++ b/assets/libs/model-view/VMCustom.ts @@ -25,8 +25,8 @@ const COMP_ARRAY_CHECK = [ */ @ccclass @executeInEditMode -@menu('ModelViewer/VM-Custom (自定义VM)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMCustom.md') +@menu('OopsFramework/Mvvm/VM-Custom （自定义）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037634&doc_id=2873565') export class VMCustom extends VMBase { @property({ tooltip: '激活controller,以开启双向绑定，否则只能接收消息', diff --git a/assets/libs/model-view/VMEvent.ts b/assets/libs/model-view/VMEvent.ts index fa7c25f..dbdd1dd 100644 --- a/assets/libs/model-view/VMEvent.ts +++ b/assets/libs/model-view/VMEvent.ts @@ -29,8 +29,8 @@ enum FILTER_MODE { */ @ccclass @executeInEditMode -@menu('ModelViewer/VM-EventCall(调用函数)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMEvent.md') +@menu('OopsFramework/Mvvm/VM-EventCall （调用函数）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037640&doc_id=2873565') export default class VMEvent extends VMBase { @property({ tooltip: '使用模板模式，可以使用多路径监听' diff --git a/assets/libs/model-view/VMLabel.ts b/assets/libs/model-view/VMLabel.ts index 74f1101..6ad0aac 100644 --- a/assets/libs/model-view/VMLabel.ts +++ b/assets/libs/model-view/VMLabel.ts @@ -1,4 +1,4 @@ -import { CCString, error, _decorator } from 'cc'; +import { _decorator, CCString, error } from 'cc'; import { StringFormatFunction } from './StringFormat'; import { VMBase } from './VMBase'; import { VMEnv } from './VMEnv'; @@ -19,8 +19,8 @@ const LABEL_TYPE = { */ @ccclass @executeInEditMode -@menu('ModelViewer/VM-Label(文本VM)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMLabel.md') +@menu('OopsFramework/Mvvm/VM-Label （标签）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037641&doc_id=2873565') export default class VMLabel extends VMBase { @property({ tooltip: '是否启用模板代码,只能在运行时之前设置,\n将会动态解析模板语法 {{0}},并且自动设置监听的路径' diff --git a/assets/libs/model-view/VMModify.ts b/assets/libs/model-view/VMModify.ts index 00d7b13..44305ac 100644 --- a/assets/libs/model-view/VMModify.ts +++ b/assets/libs/model-view/VMModify.ts @@ -16,8 +16,8 @@ enum CLAMP_MODE { * 修改 Model 的值 */ @ccclass -@menu('ModelViewer/VM-Modify(修改Model)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMModify.md') +@menu('OopsFramework/Mvvm/VM-Modify （修改数据）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037642&doc_id=2873565') export default class VMModify extends VMBase { @property({ tooltip: "监视对象路径" diff --git a/assets/libs/model-view/VMParent.ts b/assets/libs/model-view/VMParent.ts index d8e48b0..a120605 100644 --- a/assets/libs/model-view/VMParent.ts +++ b/assets/libs/model-view/VMParent.ts @@ -13,7 +13,7 @@ const { ccclass, help, executionOrder } = _decorator; */ @ccclass @executionOrder(-1) -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMParent.md') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037729&doc_id=2873565') export default class VMParent extends GameComponent { /** 绑定的标签，可以通过这个tag 获取 当前的 vm 实例 */ protected tag: string = '_temp'; diff --git a/assets/libs/model-view/VMProgress.ts b/assets/libs/model-view/VMProgress.ts index b57970f..abfe514 100644 --- a/assets/libs/model-view/VMProgress.ts +++ b/assets/libs/model-view/VMProgress.ts @@ -12,8 +12,8 @@ import { VMEnv } from "./VMEnv"; const { ccclass, property, menu, help } = _decorator; @ccclass -@menu('ModelViewer/VM-Progress (VM-进度条)') -@help('https://gitee.com/dgflash/oops-framework/blob/master/doc/mvvm/VMProgress.md') +@menu('OopsFramework/Mvvm/VM-Progress （进度条）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037843&doc_id=2873565') export default class VMProgress extends VMCustom { @property({ visible: false, diff --git a/assets/libs/model-view/VMState.ts b/assets/libs/model-view/VMState.ts index 785be8f..76bcf04 100644 --- a/assets/libs/model-view/VMState.ts +++ b/assets/libs/model-view/VMState.ts @@ -35,8 +35,8 @@ enum CHILD_MODE_TYPE { * 监听数值状态,根据数值条件设置节点是否激活 */ @ccclass -@menu('ModelViewer/VM-State (VM状态控制)') -@help('https://github.com/wsssheep/cocos_creator_mvvm_tools/blob/master/docs/VMState.md') +@menu('OopsFramework/Mvvm/VM-State （状态控制）') +@help('https://gitee.com/dgflash/oops-framework/wikis/pages?sort_id=12037846&doc_id=2873565') export default class VMState extends VMBase { @property watchPath: string = ""; diff --git a/assets/libs/model-view/ui/BhvButtonGroup.ts b/assets/libs/model-view/ui/BhvButtonGroup.ts index ee8b9d5..6136750 100644 --- a/assets/libs/model-view/ui/BhvButtonGroup.ts +++ b/assets/libs/model-view/ui/BhvButtonGroup.ts @@ -12,7 +12,7 @@ enum PARAM_TYPE { * 将该组件的所处节点的所有子节点，绑定相同的回调对象，并将组件名设置到customEventData属性中 */ @ccclass -@menu("添加特殊行为/UI/Button Group(一组按钮控制)") +@menu("OopsFramework/UI/Button Group （按钮组控制）") export class BhvButtonGroup extends Component { @property({ type: Enum(Button.Transition) diff --git a/assets/libs/model-view/ui/BhvFrameIndex.ts b/assets/libs/model-view/ui/BhvFrameIndex.ts index 168b6db..749dc47 100644 --- a/assets/libs/model-view/ui/BhvFrameIndex.ts +++ b/assets/libs/model-view/ui/BhvFrameIndex.ts @@ -2,10 +2,11 @@ import { CCInteger, Component, error, Sprite, SpriteFrame, _decorator } from "cc const { ccclass, property, executeInEditMode, requireComponent, menu } = _decorator; +/** 图片切换 */ @ccclass @executeInEditMode @requireComponent(Sprite) -@menu("添加特殊行为/UI/Frame Index(帧图改变)") +@menu("OopsFramework/UI/Frame Index （图片切换）") export class BhvFrameIndex extends Component { @property({ type: [SpriteFrame], diff --git a/assets/libs/model-view/ui/BhvRollNumber.ts b/assets/libs/model-view/ui/BhvRollNumber.ts index 0c42541..9b33aeb 100644 --- a/assets/libs/model-view/ui/BhvRollNumber.ts +++ b/assets/libs/model-view/ui/BhvRollNumber.ts @@ -20,11 +20,11 @@ enum VALUE_TYPE { type CustomCallback = (curValue: number, targetValue: number) => string; /** - * [滚动数字] ver 0.5.0 + * 滚动数字 * 将会使用 lerp 自动滚动数字到目标数值 */ @ccclass -@menu("添加特殊行为/UI/Roll Number (滚动数字)") +@menu("OopsFramework/UI/Roll Number （滚动数字）") export class BhvRollNumber extends Component { @property({ type: Label, diff --git a/assets/libs/model-view/ui/BhvSwitchPage.ts b/assets/libs/model-view/ui/BhvSwitchPage.ts index e13bdda..ae58d21 100644 --- a/assets/libs/model-view/ui/BhvSwitchPage.ts +++ b/assets/libs/model-view/ui/BhvSwitchPage.ts @@ -3,9 +3,10 @@ import { VMEnv } from "../VMEnv"; const { ccclass, property, executeInEditMode, menu } = _decorator; +/** 页面切换 */ @ccclass @executeInEditMode -@menu("添加特殊行为/UI/Switch Page (切换页面)") +@menu("OopsFramework/UI/Switch Page （页面切换）") export class BhvSwitchPage extends Component { @property isLoopPage: boolean = false;