目录— 个文件
⌕
目录加载中…
…/UtilityAction/contents/baseAction.ts
1import { CCObject, Node, Tween } from 'cc';
2export type CommonAniType = "show" | 'change' | "hide";
3
4const defaultCommonAniConfig = {
5 duration: 0.3,//持续时间
6 useData: undefined as any,//显示时数据
7 onChange: undefined as Function | undefined,//动画改变回调
8 onFinish: undefined as Function | undefined,//动画完成回调
9}
10
11export type BaseAniConfigType = Partial<typeof defaultCommonAniConfig>;
12export default abstract class BaseAction {
13
14 private static allTweens: { [key: string]: Tween<any> } = {};
15
16 private onChangeCallback?: Function;
17 private resolveCallback?: Function;
18 private finishCallback?: Function;
19
20 private currentType: CommonAniType = "show";
21
22 protected currentConfig: BaseAniConfigType = {};
23
24 /**
25 * 播放动画
26 * @param node 组件名
27 * @param type 动画类型
28 * @param finish 完成回调
29 * @param onChange 改变回调(change 用到)
30 * @returns
31 */
32 async play(node: Node, type: CommonAniType, finish?: Function, onChange?: Function) {
33 this.currentType = type;
34 this.start(node, type);
35 this.onChangeCallback = onChange;
36 return new Promise<void>(rs => {
37 this.resolveCallback = rs;
38 this.finishCallback = finish;
39 })
40 }
41 /**
42 * 设置配置信息
43 * @param config
44 * @param defaultConfig
45 */
46 setConfig(config?: BaseAniConfigType, defaultConfig?: BaseAniConfigType) {
47 for (const key in defaultCommonAniConfig) {
48 const configKey = key as keyof BaseAniConfigType;
49 if (config && key in config) {
50 this.currentConfig[configKey] = config[configKey];
51 }
52 else if (defaultConfig && key in defaultConfig) {
53 this.currentConfig[configKey] = defaultConfig[configKey];
54 }
55 else {
56 this.currentConfig[configKey] = defaultCommonAniConfig[configKey];
57 }
58 }
59
60 }
61 /**
62 * 动画开始
63 */
64 private start(node: Node, type: CommonAniType) {
65 const addTween = (tweenInstance?: Tween<any>) => {
66 if (!tweenInstance) {
67 return;
68 }
69 if (node.uuid in BaseAction.allTweens) {
70 try {
71 BaseAction.allTweens[node.uuid].stop();
72 } catch (error) {
73 console.error("停止动画出错", error);
74 }
75 }
76
77 BaseAction.allTweens[node.uuid] = tweenInstance;
78 }
79 const removeTween = () => {
80 if (!(node.uuid in BaseAction.allTweens)) {
81 return;
82 }
83 delete BaseAction.allTweens[node.uuid];
84 }
85 let tweenInstance: Tween<any> | undefined;
86 switch (type) {
87 case "show":
88 tweenInstance = this.show(node, () => {
89 removeTween();
90 this.end();
91 });
92 addTween(tweenInstance)
93 break;
94 case "change":
95 if (this.currentConfig.duration) {
96 this.currentConfig.duration = this.currentConfig.duration / 2;
97 }
98 tweenInstance = this.hide(node, () => {
99 removeTween();
100 this.change();
101 tweenInstance = this.show(node, () => {
102 removeTween();
103 this.end();
104 });
105 addTween(tweenInstance)
106 });
107 addTween(tweenInstance)
108 break;
109 case "hide":
110 tweenInstance = this.hide(node, () => {
111 removeTween();
112 this.end();
113 });
114 addTween(tweenInstance)
115 break;
116
117 default:
118 break;
119 }
120 };
121 protected abstract show(node: CCObject, onComplete?: (target?: object | undefined) => void): Tween<any> | undefined
122 protected abstract hide(node: CCObject, onComplete?: (target?: object | undefined) => void): Tween<any> | undefined
123 /**
124 * 动画更改时
125 */
126 protected change() {
127 if (this.currentType != "change") {
128 return;
129 }
130 this.onChangeCallback && this.onChangeCallback();
131 }
132 /**
133 * 动画结束
134 */
135 protected end() {
136 this.endCallBack();
137 }
138 private endCallBack() {
139 this.finishCallback && this.finishCallback();
140 this.resolveCallback && this.resolveCallback();
141
142 }
143}
讲解144 行
动画动作基类人工通读
baseAction.ts
定义 show、change、hide 三种动画的统一执行骨架:合并配置、启动子类 tween、维护按节点 uuid 索引的 tween 表,并在结束时回调完成函数和 resolve Promise。change 会把时长减半并串联隐藏与显示两段。
先读 setConfig 的优先级,再读 start 的三种分支与 tween 表增删,最后看 end 如何同时回调 finish 与 resolve。
特殊处理与易错点
- 设计同一节点 uuid 已有 tween 时先 stop 旧的再登记新的,保证一个节点同时只有一段动画。L69
- 易错点change 分支直接把 currentConfig.duration 除以二写回,同一实例再次 change 会继续减半。L95
- 易错点allTweens 是静态表,只有动画正常结束的回调里才删除条目,被 stop 的动画不会自行清理。L14
- 设计play 返回的 Promise 只在 end 时 resolve,动画被外部 stop 时 Promise 会一直挂起。L36
- 边界setConfig 只遍历内置默认配置里的键,配置对象中的额外字段不会进入 currentConfig。L46
12注释BaseAction:BaseAction 是「动作内容」目录下的实现/辅助。辅助实现文件,配合同目录的入口类使用
20属性本次播放的动画类型,默认 show。
22属性合并后的配置,含时长、useData 与两个回调。
32方法记录类型与回调后启动动画,返回一个在动画结束时才 resolve 的 Promise。
46方法按调用方配置、调用方默认配置、内置默认配置的优先级逐键填充 currentConfig。
64方法按类型分支播放 tween,并在开始时登记、结束时删除 uuid 表;change 分支串联隐藏与显示。
121方法抽象方法,由子类返回从隐藏态进入显示态的 tween。
122方法抽象方法,由子类返回进入隐藏态的 tween。
126方法仅在本次类型为 change 时触发 onChangeCallback。
135方法动画结束时转调内部结束分发方法。
138方法先调用完成回调,再 resolve play 返回的 Promise。