@cc-component/cc-pathfinding 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,6 +4,7 @@ import { AttackDistance } from "./base/Common";
4
4
  import { MapBoxView } from "./base/MapBoxView";
5
5
  import { Component } from "cc";
6
6
  import { Node } from "cc";
7
+ import { GridTweenFactory } from "./base/GridMovementController";
7
8
 
8
9
  declare module "cc" {
9
10
 
@@ -56,7 +57,12 @@ declare global {
56
57
 
57
58
  //#region 移动控制
58
59
  /** 内部创建并绑定移动控制器 */
59
- export function InitMovementController(scheduler: Component, options?: { retryDelay?: number; moveDuration?: number }): void
60
+ export function InitMovementController(scheduler: Component, options?: { retryDelay?: number; moveDuration?: number; tweenFactory?: GridTweenFactory }): void
61
+ /**
62
+ * 注入自定义 tween 实现(比如换成项目自己的动画系统)
63
+ * @param factory 传 null 或从未调用时,自动使用 cc 自带 tween
64
+ */
65
+ export function SetTweenFactory(factory: GridTweenFactory | null): void
60
66
  /**
61
67
  * 设置单位位置
62
68
  * @param useBottomPosition false(默认)用格子中心 GetMapPosition,
@@ -4,11 +4,31 @@ import { Cell } from './GridMap';
4
4
  import { PathGridStateManager } from './PathGridStateManager';
5
5
  import { PathfindingModule } from './PathfindingModule';
6
6
 
7
+ /** 外部 tween 对象需要满足的最小接口(与 cc.Tween 用法一致) */
8
+ export interface GridTween {
9
+ to(duration: number, props: object): GridTween;
10
+ call(callback: () => void): GridTween;
11
+ start(): GridTween;
12
+ }
13
+
14
+ /**
15
+ * tween 工厂:外部注入后,移动控制器用它创建/停止 tween。
16
+ * 未注入(null)时自动使用 cc 自带的 tween。
17
+ */
18
+ export interface GridTweenFactory {
19
+ /** 创建一个绑定在 target 上的 tween */
20
+ tween(target: Node): GridTween;
21
+ /** 停止 target 上的所有 tween */
22
+ stopAllByTarget(target: Node): void;
23
+ }
24
+
7
25
  export interface GridMovementOptions {
8
26
  /** 每次重试前的等待时间,单位秒 */
9
27
  retryDelay?: number;
10
28
  /** 单格移动动画时长,单位秒 */
11
29
  moveDuration?: number;
30
+ /** 自定义 tween 实现,不传则用 cc 自带 tween */
31
+ tweenFactory?: GridTweenFactory;
12
32
  }
13
33
 
14
34
  /**
@@ -23,14 +43,22 @@ export class GridMovementController {
23
43
  private readonly movementOwners = new Map<Node, symbol>();
24
44
  private readonly movementRetryCallbacks = new Map<Node, () => void>();
25
45
  private readonly positions = new Map<Node, Cell>();
46
+ /** 未注入外部实现时使用的系统 tween */
47
+ private static readonly SYSTEM_TWEEN_FACTORY: GridTweenFactory = {
48
+ tween: (target: Node) => tween(target),
49
+ stopAllByTarget: (target: Node) => Tween.stopAllByTarget(target),
50
+ };
51
+
26
52
  private readonly retryDelay: number;
27
53
  private readonly moveDuration: number;
28
54
  private readonly pathState: PathGridStateManager;
55
+ private customTweenFactory: GridTweenFactory | null;
29
56
 
30
57
  constructor(private readonly scheduler: Component, options: GridMovementOptions = {}) {
31
58
  // 允许外部按场景调整重试间隔和动画时长,默认值保持兼容。
32
59
  this.retryDelay = options.retryDelay ?? 1;
33
60
  this.moveDuration = options.moveDuration ?? 0.5;
61
+ this.customTweenFactory = options.tweenFactory ?? null;
34
62
  this.pathState = new PathGridStateManager({
35
63
  isOccupied: (row, col) => PathfindingModule.IsOccupied(row, col),
36
64
  occupy: (row, col) => PathfindingModule.OccupyNode(row, col, true),
@@ -38,6 +66,16 @@ export class GridMovementController {
38
66
  });
39
67
  }
40
68
 
69
+ /** 注入自定义 tween 实现,传 null 恢复使用 cc 自带 tween */
70
+ setTweenFactory(factory: GridTweenFactory | null): void {
71
+ this.customTweenFactory = factory ?? null;
72
+ }
73
+
74
+ /** 外部注入优先,取不到就回退到 cc 自带 tween */
75
+ private get tweenFactory(): GridTweenFactory {
76
+ return this.customTweenFactory ?? GridMovementController.SYSTEM_TWEEN_FACTORY;
77
+ }
78
+
41
79
  /**
42
80
  * 设定单位当前格子,并同步到节点世界坐标。
43
81
  * useBottomPosition:false(默认)对齐格子中心,true 对齐格子底部。
@@ -84,7 +122,7 @@ export class GridMovementController {
84
122
 
85
123
  /** 强制中止当前移动,可选择保留当前格子的临时占用。 */
86
124
  cancel(playerNode: Node, preserveCurrent = false): void {
87
- Tween.stopAllByTarget(playerNode);
125
+ this.tweenFactory.stopAllByTarget(playerNode);
88
126
  this.clearPathfindingRetry(playerNode);
89
127
  this.clearMovementRetry(playerNode);
90
128
 
@@ -110,7 +148,7 @@ export class GridMovementController {
110
148
  this.movementVersions.clear();
111
149
  this.movementOwners.forEach((owner, playerNode) => {
112
150
  this.pathState.release(owner);
113
- Tween.stopAllByTarget(playerNode);
151
+ this.tweenFactory.stopAllByTarget(playerNode);
114
152
  });
115
153
  this.movementOwners.clear();
116
154
 
@@ -200,7 +238,7 @@ export class GridMovementController {
200
238
  return;
201
239
  }
202
240
 
203
- tween(playerNode)
241
+ this.tweenFactory.tween(playerNode)
204
242
  .to(duration, { worldPosition: this.resolveCellPosition(next, useBottomPosition) })
205
243
  .call(() => {
206
244
  this.pathState.completeMove(previous, next, owner, shareToken);
@@ -4,7 +4,7 @@ import { Vec3 } from 'cc';
4
4
  import { MapViewModel } from './MapViewModel';
5
5
  import { Color } from 'cc';
6
6
  import { AttackDistance } from './Common';
7
- import { GridMovementController } from './GridMovementController';
7
+ import { GridMovementController, GridTweenFactory } from './GridMovementController';
8
8
  const { ccclass, property } = _decorator;
9
9
 
10
10
  @ccclass('PathfindingModule')
@@ -27,12 +27,20 @@ export class PathfindingModule {
27
27
  this.movementController = controller;
28
28
  }
29
29
 
30
- static InitMovementController(scheduler: Component, options?: { retryDelay?: number; moveDuration?: number }): void {
30
+ static InitMovementController(scheduler: Component, options?: { retryDelay?: number; moveDuration?: number; tweenFactory?: GridTweenFactory }): void {
31
31
  if (!this.movementController) {
32
32
  this.movementController = new GridMovementController(scheduler, options);
33
33
  }
34
34
  }
35
35
 
36
+ /**
37
+ * 注入自定义 tween 实现(比如换成项目自己的动画系统)。
38
+ * 传 null 或从未调用时,自动使用 cc 自带 tween。
39
+ */
40
+ static SetTweenFactory(factory: GridTweenFactory | null): void {
41
+ this.movementController?.setTweenFactory(factory);
42
+ }
43
+
36
44
  /**
37
45
  * 设置单位所在格子,并同步节点世界坐标。
38
46
  * useBottomPosition:false(默认)用格子中心 GetMapPosition,true 用格子底部 bottom_positon。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cc-component/cc-pathfinding",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "engine": ">=3.8.6",
5
5
  "description": "系统组件添加常用扩展方法",
6
6
  "main": "index.ts",