From ec59a44efc2fdaf84794f7bc9fde95095a0e0aff Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Tue, 21 Apr 2026 21:01:53 +0800 Subject: [PATCH 01/26] =?UTF-8?q?refactor:=20CoreState=20=E4=B8=80?= =?UTF-8?q?=E9=83=A8=E5=88=86=E7=B1=BB=E5=9E=8B=E5=A3=B0=E6=98=8E=E6=8C=AA?= =?UTF-8?q?=E5=88=B0=20data-base?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/common/face.ts | 0 packages-user/data-base/src/common/index.ts | 1 + packages-user/data-base/src/common/types.ts | 36 ++++++++++++ packages-user/data-base/src/index.ts | 2 + .../src/map/index.ts | 0 .../src/map/layerState.ts | 0 .../src/map/mapLayer.ts | 0 .../src/map/types.ts | 0 packages-user/data-base/src/types.ts | 50 +++++++++++++++++ packages-user/data-state/src/common/index.ts | 3 - packages-user/data-state/src/common/types.ts | 40 -------------- packages-user/data-state/src/common/utils.ts | 6 -- packages-user/data-state/src/core.ts | 9 ++- packages-user/data-state/src/index.ts | 5 +- packages-user/data-state/src/types.ts | 55 +------------------ 15 files changed, 98 insertions(+), 109 deletions(-) rename packages-user/{data-state => data-base}/src/common/face.ts (100%) rename packages-user/{data-state => data-base}/src/map/index.ts (100%) rename packages-user/{data-state => data-base}/src/map/layerState.ts (100%) rename packages-user/{data-state => data-base}/src/map/mapLayer.ts (100%) rename packages-user/{data-state => data-base}/src/map/types.ts (100%) create mode 100644 packages-user/data-base/src/types.ts delete mode 100644 packages-user/data-state/src/common/index.ts delete mode 100644 packages-user/data-state/src/common/types.ts delete mode 100644 packages-user/data-state/src/common/utils.ts diff --git a/packages-user/data-state/src/common/face.ts b/packages-user/data-base/src/common/face.ts similarity index 100% rename from packages-user/data-state/src/common/face.ts rename to packages-user/data-base/src/common/face.ts diff --git a/packages-user/data-base/src/common/index.ts b/packages-user/data-base/src/common/index.ts index 6d5a6ef..5fcbbcb 100644 --- a/packages-user/data-base/src/common/index.ts +++ b/packages-user/data-base/src/common/index.ts @@ -1,2 +1,3 @@ +export * from './face'; export * from './types'; export * from './utils'; diff --git a/packages-user/data-base/src/common/types.ts b/packages-user/data-base/src/common/types.ts index 196a18f..ef726bb 100644 --- a/packages-user/data-base/src/common/types.ts +++ b/packages-user/data-base/src/common/types.ts @@ -16,3 +16,39 @@ export interface IFaceData { /** 图块朝向 */ readonly face: FaceDirection; } + +export interface IRoleFaceBinder { + /** + * 给指定的图块分配朝向绑定 + * @param identifier 图块数字 + * @param main 主图块朝向,一般是朝下 + */ + malloc(identifier: number, main: FaceDirection): void; + + /** + * 将一个图块与另一个图块绑定朝向,需要注意要先调用 {@link malloc} 分配朝向信息 + * @param identifier 当前图块数字 + * @param main 主图块数字,即当前图块与目标图块属于主图块的另一个朝向 + * @param face 当前图块的朝向方向 + */ + bind(identifier: number, main: number, face: FaceDirection): void; + + /** + * 获取一个图块指定朝向的图块数字 + * @param identifier 图块数字,可以是任意朝向的图块数字 + * @param face 要获取的朝向 + */ + getFaceOf(identifier: number, face: FaceDirection): IFaceData | null; + + /** + * 获取指定图块数字是哪个朝向 + * @param identifier 图块数字 + */ + getFaceDirection(identifier: number): FaceDirection | undefined; + + /** + * 获取指定图块数字绑定至的主朝向 + * @param identifier 图块数字,可以是任意朝向的图块数字 + */ + getMainFace(identifier: number): IFaceData | null; +} diff --git a/packages-user/data-base/src/index.ts b/packages-user/data-base/src/index.ts index 09b3249..0be7276 100644 --- a/packages-user/data-base/src/index.ts +++ b/packages-user/data-base/src/index.ts @@ -3,5 +3,7 @@ export * from './enemy'; export * from './flag'; export * from './hero'; export * from './load'; +export * from './map'; export * from './game'; +export * from './types'; diff --git a/packages-user/data-state/src/map/index.ts b/packages-user/data-base/src/map/index.ts similarity index 100% rename from packages-user/data-state/src/map/index.ts rename to packages-user/data-base/src/map/index.ts diff --git a/packages-user/data-state/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts similarity index 100% rename from packages-user/data-state/src/map/layerState.ts rename to packages-user/data-base/src/map/layerState.ts diff --git a/packages-user/data-state/src/map/mapLayer.ts b/packages-user/data-base/src/map/mapLayer.ts similarity index 100% rename from packages-user/data-state/src/map/mapLayer.ts rename to packages-user/data-base/src/map/mapLayer.ts diff --git a/packages-user/data-state/src/map/types.ts b/packages-user/data-base/src/map/types.ts similarity index 100% rename from packages-user/data-state/src/map/types.ts rename to packages-user/data-base/src/map/types.ts diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts new file mode 100644 index 0000000..c4d18de --- /dev/null +++ b/packages-user/data-base/src/types.ts @@ -0,0 +1,50 @@ +import { IMotaDataLoader } from './load'; +import { ILoadProgressTotal } from '@motajs/loader'; +import { IHeroFollower, IHeroState } from './hero'; +import { IEnemyContext, IEnemyManager } from './enemy'; +import { IFlagSystem } from './flag'; +import { IRoleFaceBinder } from './common'; +import { ILayerState } from './map'; + +export interface IStateSaveData { + /** 跟随者列表 */ + readonly followers: readonly IHeroFollower[]; +} + +export interface IStateBase { + /** 朝向绑定 */ + readonly roleFace: IRoleFaceBinder; + /** id 到图块数字的映射 */ + readonly idNumberMap: Map; + /** 图块数字到 id 的映射 */ + readonly numberIdMap: Map; + + /** 加载进度对象 */ + readonly loadProgress: ILoadProgressTotal; + /** 数据端加载对象 */ + readonly dataLoader: IMotaDataLoader; + + /** 地图状态 */ + readonly layer: ILayerState; + /** 勇士状态 */ + readonly hero: IHeroState; + + /** 怪物管理器 */ + readonly enemyManager: IEnemyManager; + /** 怪物上下文 */ + readonly enemyContext: IEnemyContext; + + /** Flag 系统 */ + readonly flags: IFlagSystem; + + /** + * 保存当前状态 + */ + saveState(): IStateSaveData; + + /** + * 加载状态 + * @param state 状态对象 + */ + loadState(state: IStateSaveData): void; +} diff --git a/packages-user/data-state/src/common/index.ts b/packages-user/data-state/src/common/index.ts deleted file mode 100644 index 5fcbbcb..0000000 --- a/packages-user/data-state/src/common/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export * from './face'; -export * from './types'; -export * from './utils'; diff --git a/packages-user/data-state/src/common/types.ts b/packages-user/data-state/src/common/types.ts deleted file mode 100644 index b256db0..0000000 --- a/packages-user/data-state/src/common/types.ts +++ /dev/null @@ -1,40 +0,0 @@ -import { FaceDirection, type IFaceData } from '@user/data-base'; - -export { FaceDirection }; -export type { IFaceData } from '@user/data-base'; - -export interface IRoleFaceBinder { - /** - * 给指定的图块分配朝向绑定 - * @param identifier 图块数字 - * @param main 主图块朝向,一般是朝下 - */ - malloc(identifier: number, main: FaceDirection): void; - - /** - * 将一个图块与另一个图块绑定朝向,需要注意要先调用 {@link malloc} 分配朝向信息 - * @param identifier 当前图块数字 - * @param main 主图块数字,即当前图块与目标图块属于主图块的另一个朝向 - * @param face 当前图块的朝向方向 - */ - bind(identifier: number, main: number, face: FaceDirection): void; - - /** - * 获取一个图块指定朝向的图块数字 - * @param identifier 图块数字,可以是任意朝向的图块数字 - * @param face 要获取的朝向 - */ - getFaceOf(identifier: number, face: FaceDirection): IFaceData | null; - - /** - * 获取指定图块数字是哪个朝向 - * @param identifier 图块数字 - */ - getFaceDirection(identifier: number): FaceDirection | undefined; - - /** - * 获取指定图块数字绑定至的主朝向 - * @param identifier 图块数字,可以是任意朝向的图块数字 - */ - getMainFace(identifier: number): IFaceData | null; -} diff --git a/packages-user/data-state/src/common/utils.ts b/packages-user/data-state/src/common/utils.ts deleted file mode 100644 index 2e7a185..0000000 --- a/packages-user/data-state/src/common/utils.ts +++ /dev/null @@ -1,6 +0,0 @@ -export { - degradeFace, - fromDirectionString, - getFaceMovement, - nextFaceDirection -} from '@user/data-base'; diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 4f1b491..3466e78 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -1,6 +1,4 @@ import { ICoreState, IStateSaveData } from './types'; -import { ILayerState, LayerState } from './map'; -import { FaceDirection, IRoleFaceBinder, RoleFaceBinder } from './common'; import { DamageSystem, EnemyContext, @@ -16,7 +14,12 @@ import { FlagSystem, IMotaDataLoader, MotaDataLoader, - loading + loading, + IRoleFaceBinder, + ILayerState, + LayerState, + RoleFaceBinder, + FaceDirection } from '@user/data-base'; import { IEnemyAttr } from './enemy/types'; import { diff --git a/packages-user/data-state/src/index.ts b/packages-user/data-state/src/index.ts index aa2296a..bc01750 100644 --- a/packages-user/data-state/src/index.ts +++ b/packages-user/data-state/src/index.ts @@ -1,6 +1,5 @@ -import { loading } from '@user/data-base'; +import { FaceDirection, loading } from '@user/data-base'; import { isNil } from 'lodash-es'; -import { FaceDirection } from './common'; import { ICoreState } from './types'; import { TILE_HEIGHT, TILE_WIDTH } from './shared'; import { state } from './ins'; @@ -62,11 +61,9 @@ export function create() { }); } -export * from './common'; export * from './enemy'; export * from './hero'; export * from './legacy'; -export * from './map'; export * from './core'; export * from './ins'; diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index 754ca9d..41365d7 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -1,61 +1,10 @@ -import { ILayerState } from './map'; -import { IRoleFaceBinder } from './common'; -import { - IEnemyContext, - IEnemyManager, - IHeroFollower, - IHeroState, - IMotaDataLoader -} from '@user/data-base'; +import { IHeroFollower, IStateBase } from '@user/data-base'; import { IEnemyAttr } from './enemy/types'; import { IHeroAttr } from './hero'; -import { IFlagSystem } from '../../data-base/src/flag/types'; -import { ILoadProgressTotal } from '@motajs/loader'; - -export interface IGameDataState { - /** 怪物管理器 */ - readonly enemyManager: IEnemyManager; -} export interface IStateSaveData { /** 跟随者列表 */ readonly followers: readonly IHeroFollower[]; } -export interface ICoreState { - /** 朝向绑定 */ - readonly roleFace: IRoleFaceBinder; - /** id 到图块数字的映射 */ - readonly idNumberMap: Map; - /** 图块数字到 id 的映射 */ - readonly numberIdMap: Map; - - /** 加载进度对象 */ - readonly loadProgress: ILoadProgressTotal; - /** 数据端加载对象 */ - readonly dataLoader: IMotaDataLoader; - - /** 地图状态 */ - readonly layer: ILayerState; - /** 勇士状态 */ - readonly hero: IHeroState; - - /** 怪物管理器 */ - readonly enemyManager: IEnemyManager; - /** 怪物上下文 */ - readonly enemyContext: IEnemyContext; - - /** Flag 系统 */ - readonly flags: IFlagSystem; - - /** - * 保存状态 - */ - saveState(): IStateSaveData; - - /** - * 加载状态 - * @param data 状态对象 - */ - loadState(data: IStateSaveData): void; -} +export interface ICoreState extends IStateBase {} From 8c1becc9f12c539e61a11a91f517d4c91be4ab0d Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Fri, 24 Apr 2026 17:29:13 +0800 Subject: [PATCH 02/26] =?UTF-8?q?refactor:=20=E5=AD=98=E6=A1=A3=E7=B3=BB?= =?UTF-8?q?=E7=BB=9F=20&=20=E5=8B=87=E5=A3=AB=E5=B1=9E=E6=80=A7=E5=AD=98?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot --- dev.md | 22 +- docs/dev/hero-modifier-save.md | 110 +++++++++ docs/dev/save-system.md | 215 +++++++++++++++++ packages-user/data-base/src/common/types.ts | 28 +++ packages-user/data-base/src/flag/system.ts | 2 +- packages-user/data-base/src/flag/types.ts | 15 +- packages-user/data-base/src/hero/attribute.ts | 22 +- packages-user/data-base/src/hero/state.ts | 79 +++++++ packages-user/data-base/src/hero/types.ts | 69 +++++- packages-user/data-base/src/types.ts | 25 +- packages-user/data-state/src/core.ts | 87 ++++++- packages-user/data-state/src/enemy/index.ts | 1 + packages-user/data-state/src/save/index.ts | 1 + packages-user/data-state/src/save/system.ts | 222 ++++++++++++++++++ packages-user/data-state/src/save/types.ts | 142 +++++++++++ packages-user/data-state/src/types.ts | 43 +++- packages/common/src/logger.json | 5 + packages/common/src/utils/types.ts | 7 + prompt.md | 71 +++++- 19 files changed, 1112 insertions(+), 54 deletions(-) create mode 100644 docs/dev/hero-modifier-save.md create mode 100644 docs/dev/save-system.md create mode 100644 packages-user/data-state/src/save/index.ts create mode 100644 packages-user/data-state/src/save/system.ts create mode 100644 packages-user/data-state/src/save/types.ts diff --git a/dev.md b/dev.md index d739fd1..50b1504 100644 --- a/dev.md +++ b/dev.md @@ -28,12 +28,16 @@ - `pnpm build:packages`: 构建所有 `packages` 文件夹下的内容,使用库模式。 - `pnpm build:game`: 构建为可以直接部署的构建包。 - `pnpm build:lib`: 构建所有 `packages` `packages-user` 文件夹下的内容,使用库模式。 +- `pnpm type`: 对仓库执行类型检查 +- `pnpm check:circular`: 对仓库执行循环引用检查 ## 开发原则 -- 模块无副作用原则: - - 所有模块不包含副作用内容,全部由函数、类、常量的声明组成,不出现导出的变量声明、代码执行内容,允许但不建议编写类的静态块。 +- 模块原则: + - 无副作用原则:所有模块不包含副作用内容,全部由函数、类、常量的声明组成,不出现导出的变量声明、代码执行内容,允许但不建议编写类的静态块。 - 如果需要模块初始化,编写一个 `createXxx` 函数,然后在 `index.ts` 中整合,再逐级向上传递,直至遇到包含 `create` 函数的 `index.ts`,所有初始化将会统一在顶层模块中执行。 + - 不允许一个文件导出不属于当前 `monorepo` 或当前文件夹的内容。 + - 不允许出现循环引用,如果不得不进行循环引用,应当首先考虑接口设计是否有问题。 - 命名规则: - 变量、成员、一般常量、方法、函数使用小驼峰。 - 类、接口、类型别名、命名空间、泛型、枚举、组件使用大驼峰。 @@ -47,7 +51,7 @@ - 长文件可使用 `#region` 分段,可以写上 `#endretion` 允许折叠。 - TODO 使用 `// TODO:` 或 `// todo:` 格式。 - 单行注释的双斜杠与注释内容之间添加一个空格,多行注释只允许出现 `jsDoc` 注释,如果需要多行非 `jsDoc` 注释,使用多个单行注释。 - - 注释进行合理换行,考虑到中文字符较宽,建议 40-60 个字符进行换行。不允许在句中换行,必须在标点符号后换行。 + - 注释进行合理换行,考虑到中文字符较宽,建议 40-60 个字符进行换行。不允许在句中换行,必须在标点符号后换行。参数注释换行后保持对齐。 - 单行注释结尾不添加句号,对于多行长注释,可以在结尾添加句号。 - 类型: - 不允许出现非必要的 `any` 类型。 @@ -62,3 +66,15 @@ - 尽量不使用 `?.` 运算符,一般建议仅在副作用函数调用(如 `this.obj?.func()`,`this.obj.func?.()`),或对象 `Required` 化(如 `{ value: obj?.value ?? 0 }`)中使用 `?.` 运算符。 - 只进行必要的非空判断,不必要的非空判断直接使用非空断言 `!` 实现。 - 除非参数要求传入函数等情况,不建议在函数内写任何局部函数。 + - 语句尽量不换行,除非必要,尤其注意三元运算符与 `private readonly` 类成员。 + +## 双端分离 + +样板将渲染端与数据端彻底分离,数据端可以单独在 `node` 环境运行,可以直接用于录像验证。渲染端仅负责向数据端发送消息,不负责任何逻辑运算。 + +- `@user/data-base`: 数据端的系统层,负责核心系统。 +- `@user/data-state`: 数据端的实现层,依靠系统层实现完整的游戏实例。 +- `@user/client-base`: 渲染端的系统层,负责渲染端的核心系统。 +- `@user/client-modules`: 渲染端的实现层,依靠系统层实现客户端的渲染与用户交互。 + +数据端允许运行渲染端代码,但需要使用全局接口 `Mota.r(() => {})` 包裹。除非必要,否则不建议在数据端调用渲染端代码。 diff --git a/docs/dev/hero-modifier-save.md b/docs/dev/hero-modifier-save.md new file mode 100644 index 0000000..c060db7 --- /dev/null +++ b/docs/dev/hero-modifier-save.md @@ -0,0 +1,110 @@ +# 需求综述 + +当前勇士属性修饰器 `IHeroModifier` 是非注册式的,无法直接存档。 +目标是将其改为注册式,每种修饰器在使用前需先在属性对象上注册, +并实现 `ISaveableContent` 接口以支持存档读档。 + +注册接口签名:`registerModifier(identifier: string, cons: () => IHeroModifier): void` + +# 实现思路 + +## 1. 修改 `IHeroModifier` 接口 + +- 将 `identifier` 改为 `type`:一类修饰器可能被添加多次, + `type` 比 `identifier` 更准确地表达"修饰器类型"的含义。 +- 新增泛型参数 `S = unknown` 作为存档类型,让接口继承 `ISaveableContent`: + `IHeroModifier` +- 大多数修饰器的可变状态只有 `value`,因此 `BaseHeroModifier` 将 `S` 默认为 `V`。 + 若修饰器需要特殊存储结构,可以不继承 `BaseHeroModifier`,自行编写实现类。 + +## 2. 新增 `IModifierStateSave` 类型 + +`IModifierStateSave` 记录单条修饰器的存档信息: + +```ts +interface IModifierStateSave { + readonly name: PropertyKey; // 属性名,如 'atk' + readonly type: string; // 修饰器类型(与注册时的 key 对应) + readonly state: unknown; // 修饰器 saveState 结果 +} +``` + +## 3. 修改 `IHeroStateSave`,新增 `modifiers` 字段 + +`attribute` 字段维持原来的 `THero` 只保存基础属性值, +修饰器列表单独作为顶层字段: + +```ts +readonly modifiers: readonly IModifierStateSave[]; +``` + +## 4. 修改 `IHeroAttribute`,新增 `iterateModifiers` 方法 + +`HeroAttribute` 不再继承 `ISaveableContent`,也不负责存读档, +保留现有的 `toStructured(): THero`。 +新增 `iterateModifiers` 方法,供 `HeroState` 在存档时遍历所有已挂载的修饰器: + +```ts +iterateModifiers(): Iterable<[keyof THero, IHeroModifier]>; +``` + +## 5. 修改 `BaseHeroModifier`,新增 `S` 泛型并实现 `ISaveableContent` + +- 改为 `BaseHeroModifier` 隐式以 `S = V` 实现 `ISaveableContent` +- 将 `abstract readonly identifier: string` 改为 `abstract readonly type: string` +- `saveState()` 直接返回 `this.currentValue` +- `loadState(state)` 调用 `this.setValue(state)` 恢复值 + +## 6. 修改 `HeroState` + +修饰器注册表移至 `HeroState`: + +- 新增 `private readonly registry: Map IHeroModifier>` 存储工厂函数 +- 实现 `registerModifier(type, cons)`:向 `registry` 写入工厂, + 并同步注册到接口签名中 +- 实现 `createModifier(type)`:从 `registry` 取出对应工厂, + 调用工厂函数创建并返回修饰器实例,类型为 `IHeroModifier` +- 实现 `createAndInsertModifier(type, name)`: + 调用 `createModifier` 创建实例后,自动调用 `this.attribute.addModifier(name, modifier)` 插入属性对象, + 返回该修饰器实例,类型与 `createModifier` 一致 +- 修改 `saveState()`: + 1. `attribute` 字段调用 `this.attribute.toStructured()` 获取基础属性值(与现在一致) + 2. 遍历 `this.attribute.iterateModifiers()`,对每个修饰器调用 + `modifier.saveState(compression)` 并拼装 `IModifierStateSave[]`, + 写入 `modifiers` 字段 +- 修改 `loadState()`: + 1. 创建新的 `HeroAttribute` 实例(使用 `state.attribute` 还原基础属性值,与现在一致) + 2. 遍历 `state.modifiers`,通过 `registry.get(type)` 创建修饰器实例, + 调用 `modifier.loadState(state)` 恢复值,再 `addModifier(name, modifier)` 挂载 + +# 涉及文件 + +## 需要修改的文件 + +### `@user/data-base/hero/types.ts` + +- [ ] 修改 `IHeroModifier` 接口: + 改为 `IHeroModifier`,`identifier` 改名为 `type`, + 继承 `ISaveableContent` +- [ ] 新增 `IModifierStateSave` 接口:单条修饰器的存档格式 +- [ ] 修改 `IHeroStateSave`:新增 `readonly modifiers: readonly IModifierStateSave[]` 字段 +- [ ] 修改 `IReadonlyHeroAttribute`:新增 `iterateModifiers()` 方法签名 +- [ ] 修改 `IHeroState`:新增以下方法签名 - `registerModifier(type: string, cons: () => IHeroModifier): void` - `createModifier(type: string): IHeroModifier` - `createAndInsertModifier(type: string, name: K): IHeroModifier` + +### `@user/data-base/hero/attribute.ts` + +- [ ] 修改 `BaseHeroModifier`: + 将 `abstract readonly identifier` 改为 `abstract readonly type`; + 实现 `saveState` / `loadState` +- [ ] 修改 `HeroAttribute`:实现 `iterateModifiers()` + +### `@user/data-base/hero/state.ts` + +- [ ] 修改 `HeroState`:新增 `private readonly registry: Map IHeroModifier>` 成员 +- [ ] 实现 `HeroState.registerModifier`:将工厂函数写入 `registry` +- [ ] 实现 `HeroState.createModifier`:从 `registry` 取出工厂并调用,返回新实例; + 若 `type` 未注册则抛出错误 +- [ ] 实现 `HeroState.createAndInsertModifier`:调用 `createModifier` 后, + 再调用 `this.attribute.addModifier(name, modifier)`,返回同一实例 +- [ ] 修改 `HeroState.saveState`:遍历 `iterateModifiers()` 写入 `modifiers` 字段 +- [ ] 修改 `HeroState.loadState`:遍历 `state.modifiers` 重建修饰器并挂载 diff --git a/docs/dev/save-system.md b/docs/dev/save-system.md new file mode 100644 index 0000000..21e9e13 --- /dev/null +++ b/docs/dev/save-system.md @@ -0,0 +1,215 @@ +# 需求综述 + +实现游戏引擎存档系统(`SaveSystem`)及全局事务(`GlobalTransaction`)两个类的完整逻辑。 +存档系统分为两部分: + +- **存档内容**:按 slot id 保存/读取游戏当前状态(`Map>`), + 使用 Dexie 将数据存入 IndexedDB。 +- **全局存储**:跨存档的 key-value 存储,用于存放存档 meta data、全局设置等。 + 支持事务处理,事务中的写入操作在发生错误时全部回滚。 + +此外,系统提供基于内存的自动存档,并支持 undo/redo 操作。 +自动存档不主动写入 IndexedDB,只有显式调用 `saveAutosaveToDB` 时才将 undo +栈顶存档写入数据库。 +存档操作使用 `performance` 接口监控耗时,超过配置阈值时通过 logger 发出警告。 + +--- + +# 实现思路 + +## 1. Dexie 数据库 Schema 设计 + +`SaveSystem` 构造函数接收数据库名称 `name`,在其中创建如下两张表: + +| 表名 | 主键 | 说明 | +| -------- | --------------- | --------------------------------------------------------- | +| `saves` | `id`(number) | 按 slot id 存储存档数据;`id = -1` 固定用于持久化自动存档 | +| `global` | `key`(string) | 全局 key-value 存储 | + +- `saves` 表中每条记录结构为 `{ id: number, compression: SaveCompression, data: Map }`, + 与 `ISaveRead` 对应,直接利用 IndexedDB 的结构化克隆存储,不进行 JSON 序列化。 +- `global` 表中每条记录结构为 `{ key: string, value: unknown }`, + 同样直接存储,不进行 JSON 序列化。 + +## 2. 内部状态 + +`SaveSystem` 需要维护如下私有成员: + +- `private undoStack: ISaveRead[]`:undo 栈,存储 `ISaveRead` 快照 +- `private redoStack: ISaveRead[]`:redo 栈,存储 `ISaveRead` 快照 +- `private stackSize: number`:undo/redo 栈最大容量(默认 `20`) +- `private autosaveLevel: SaveCompression`:默认 `SaveCompression.LowCompression` +- `private commonSaveLevel: SaveCompression`:默认 `SaveCompression.HighCompressoin` +- `private saveTimeTolerance: number`:默认 `100`(ms) +- `private autosaveTimeTolerance: number`:默认 `50`(ms) + +## 3. ISaveRead 数据结构 + +栈与数据库读写均使用新接口 `ISaveRead`: + +```ts +interface ISaveRead { + readonly compression: SaveCompression; + readonly data: Map; +} +``` + +- `compression`:存档时使用的压缩等级,读档时传回给 `loadState`,使接收方能够正确解压。 +- `data`:key 到每个可存档对象序列化数据的 Map,key 与 `ISaveableContent` 注册时的 id 对应。 + +内存栈和数据库均直接存储 `ISaveRead`,不需要引入辅助包装层。 +存档系统本身不负责将数据写回游戏对象,调用方拿到 `ISaveRead` 后自行遍历并调用 +各可存档对象的 `loadState(data, compression)` 完成状态恢复。 + +## 4. 各方法实现 + +### `config(config)` + +将 config 各字段写入对应私有成员,使用传入的值覆盖默认值。 + +### `setAutosaveStackSize(size)` + +将 `stackSize` 更新为 `size`。如果当前 undo 栈超过新的 `size`, +从栈底移除多余条目(保留最新的);redo 栈同理。 + +### `autosave(state)` + +1. 遍历 `state`,对每个 `(key, content)` 调用 + `content.saveState(this.autosaveLevel)` 获取序列化数据, + 汇总为 `Map`,构建 `ISaveRead { compression: autosaveLevel, data }` 并压入 `undoStack`; +2. **清空 `redoStack`**(执行新的自动存档后无法再 redo); +3. 若 `undoStack.length > stackSize`,从栈底(`[0]`)移除多余条目。 + +> IndexedDB 支持结构化克隆,Map、Set、TypedArray 等均可直接存储,无需 JSON 序列化。 + +### `undoAutosave(current)` + +1. 若 `undoStack` 为空,返回 `null`; +2. 将 `current` 序列化为 `ISaveRead { compression: autosaveLevel, data: Map }`, + 压入 `redoStack`;检查 `redoStack.length > stackSize`,超长时从栈底移除多余条目; +3. 弹出 `undoStack` 栈顶(`pop()`),返回弹出的 `ISaveRead`; +4. 调用方拿到返回的 `ISaveRead` 后,自行遍历并对各游戏对象调用 `loadState` 完成恢复。 + +### `redoAutosave(current)` + +与 `undoAutosave` 逻辑对称:将 `current` 序列化压入 `undoStack`, +弹出 `redoStack` 栈顶并返回,调用方自行恢复状态。 + +### `getUndoStack()` / `getRedoStack()` + +使用 `slice()` 返回栈数组的浅拷贝快照,防止外部意外修改栈结构。 + +### `saveAutosaveToDB()` + +1. 若 `undoStack` 为空,直接返回(无需写入); +2. 记录 `t0 = performance.now()`; +3. 取 `undoStack` 栈顶(`ISaveRead`),将其连同 `id = -1` 一起写入 `saves` 表; +4. 记录 `t1 = performance.now()`;若 `t1 - t0 > autosaveTimeTolerance`, + 调用 `logger.warn(115, (t1 - t0).toFixed(0), this.autosaveTimeTolerance.toString())`。 + +### `save(id, state)` + +1. 记录 `t0 = performance.now()`; +2. 遍历 `state`,对每个 `(key, content)` 调用 + `content.saveState(this.commonSaveLevel)` 汇总为 `Map`, + 构建 `{ id, compression: commonSaveLevel, data }` 写入 `saves` 表; +3. 将 `id` 写入全局存储 `'lastSlot'` 键(用于 `getLastSlot()`); +4. 记录 `t1 = performance.now()`;若 `t1 - t0 > saveTimeTolerance`, + 调用 `logger.warn(114, (t1 - t0).toFixed(0), this.saveTimeTolerance.toString())`。 + +### `load(id)` + +1. 从 Dexie `saves` 表查询 `id`; +2. 若不存在返回 `null`; +3. 将读取到的记录中的 `compression` 和 `data` 字段组装成 `ISaveRead` 返回。 + 调用方自行遍历 `data` 并对各游戏对象调用 `loadState` 完成恢复。 + +> `load(-1)` 可用于读取持久化的自动存档。 + +### `deleteSave(id)` + +直接从 Dexie `saves` 表删除对应记录。 + +### `getLastSlot()` + +从全局存储读取 `'lastSlot'` 键对应的值并返回;若不存在则返回 `0`。 + +### `getGlobal(key)` / `setGlobal(key, value)` + +- `getGlobal`:从 Dexie `global` 表读取 `key` 对应的 `value` 字段并返回,类型断言为 `T`; +- `setGlobal`:将 `{ key, value }` 直接写入 Dexie `global` 表,无需 JSON 序列化。 + +### `startGlobalTransaction(handle)` + +使用 `Dexie.transaction('rw', this.db.table('global'), ...)` 包裹 `handle` 调用, +传入 `GlobalTransaction` 实例,出错时自动回滚。 + +### `GlobalTransaction.get(key)` / `GlobalTransaction.set(key, value)` + +在事务上下文中直接读写 `table`(即全局 `global` 表的引用),无需 JSON 序列化。 + +## 5. logger.json 新增 warn 代码 + +当前最大 warn 代码为 `113`,新增如下两条(写入 `packages/common/src/logger.json` +的 `warn` 对象,置于 `113` 之后): + +| 代码 | 消息 | +| ----- | ----------------------------------------------------------------------------------------------------- | +| `114` | `Save operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.` | +| `115` | `Autosave operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.` | + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `dexie`:Dexie / Table 类型,用于创建和操作 IndexedDB 数据库 +- `@motajs/common`:`logger`,用于输出存档耗时超限警告 +- `@user/data-base`:`ISaveableContent`、`SaveCompression`,存档接口与压缩枚举 +- `./types`:`ISaveRead`、`IGlobalTrasaction`、`ISaveSystem`、`ISaveSystemConfig` + +## 需要修改的文件 + +### `packages/common/src/logger.json` + +- [x] 在 `warn` 对象中新增代码 `114`:普通存档耗时超限警告 +- [x] 在 `warn` 对象中新增代码 `115`:自动存档耗时超限警告 + +### `packages-user/data-state/src/save/system.ts` + +- [x] 新增 `private undoStack: ISaveRead[]` 成员:存储 undo 历史快照 +- [x] 新增 `private redoStack: ISaveRead[]` 成员:存储 redo 历史快照 +- [x] 新增 `private stackSize: number` 成员:undo/redo 栈容量上限,默认 `20` +- [x] 新增 `private autosaveLevel: SaveCompression` 成员: + 默认 `SaveCompression.LowCompression` +- [x] 新增 `private commonSaveLevel: SaveCompression` 成员: + 默认 `SaveCompression.HighCompressoin` +- [x] 新增 `private saveTimeTolerance: number` 成员:普通存档耗时阈值,默认 `100` +- [x] 新增 `private autosaveTimeTolerance: number` 成员:自动存档耗时阈值,默认 `50` +- [x] 编写构造函数:初始化 Dexie 实例,定义 `saves`(主键 `id`)和 + `global`(主键 `key`)两张表的 schema +- [x] 编写 `config` 方法:将配置项写入私有成员 +- [x] 编写 `setAutosaveStackSize` 方法:更新 stackSize,修剪超长的 undo/redo 栈 +- [x] 编写 `autosave` 方法:遍历 state 序列化为 `ISaveRead` 压入 undoStack, + 清空 redoStack,超长时修剪栈底 +- [x] 编写 `undoAutosave` 方法:将 current 序列化为 `ISaveRead` 压入 redoStack, + 弹出 undoStack 栈顶返回 `ISaveRead`(或 null) +- [x] 编写 `redoAutosave` 方法:与 undoAutosave 对称 +- [x] 编写 `getUndoStack` / `getRedoStack` 方法:使用 `slice()` 返回栈的浅拷贝快照 +- [x] 编写 `saveAutosaveToDB` 方法:取 undoStack 栈顶以 `id = -1` 写入 `saves` 表, + performance 监控,超限时调用 `logger.warn(115, ...)` +- [x] 编写 `save` 方法:遍历 state 序列化为 `ISaveRead` 写入 `saves` 表, + 更新 `lastSlot`,performance 监控,超限时调用 `logger.warn(114, ...)` +- [x] 编写 `load` 方法:从 Dexie `saves` 表读取记录组装为 `ISaveRead` 返回 + (不存在返回 null);`load(-1)` 可读取持久化的自动存档 +- [x] 编写 `deleteSave` 方法:从 Dexie `saves` 表删除指定记录 +- [x] 编写 `getLastSlot` 方法:从全局存储读取 `'lastSlot'`,不存在时返回 `0` +- [x] 编写 `getGlobal` / `setGlobal` 方法:直接读写 Dexie `global` 表,不进行 JSON 序列化 +- [x] 编写 `startGlobalTransaction` 方法: + 使用 Dexie 事务包裹 handle,传入 GlobalTransaction 实例 + +### `packages-user/data-state/src/save/system.ts`(GlobalTransaction 部分) + +- [x] 编写 `GlobalTransaction.get` 方法:在事务上下文中直接读取 table 中 key 对应的 value +- [x] 编写 `GlobalTransaction.set` 方法:在事务上下文中直接写入 key-value,不进行 JSON 序列化 diff --git a/packages-user/data-base/src/common/types.ts b/packages-user/data-base/src/common/types.ts index ef726bb..fbe4822 100644 --- a/packages-user/data-base/src/common/types.ts +++ b/packages-user/data-base/src/common/types.ts @@ -52,3 +52,31 @@ export interface IRoleFaceBinder { */ getMainFace(identifier: number): IFaceData | null; } + +//#region 功能接口 + +export const enum SaveCompression { + /** 不进行压缩,仅提取必要数据 */ + NoCompression, + /** 进行小幅度压缩,以性能为主要考虑目标 */ + LowCompression, + /** 进行大幅度压缩,以体积为主要考虑目标 */ + HighCompression +} + +export interface ISaveableContent { + /** + * 保存对象状态,返回的对象应该经过深拷贝(即 `structuedClone`) + * @param compression 压缩级别 + */ + saveState(compression: SaveCompression): T; + + /** + * 读取对象状态 + * @param state 状态对象 + * @param compression 压缩级别 + */ + loadState(state: T, compression: SaveCompression): void; +} + +//#endregion diff --git a/packages-user/data-base/src/flag/system.ts b/packages-user/data-base/src/flag/system.ts index 7063691..ed98767 100644 --- a/packages-user/data-base/src/flag/system.ts +++ b/packages-user/data-base/src/flag/system.ts @@ -2,7 +2,7 @@ import { IFlagCommonField, IFlagSystem, IFlagSystemSave } from './types'; import { FlagCommonField } from './field'; export class FlagSystem implements IFlagSystem { - private readonly fieldMap: Map> = + private readonly fieldMap: Map> = new Map(); occupied(field: PropertyKey): boolean { diff --git a/packages-user/data-base/src/flag/types.ts b/packages-user/data-base/src/flag/types.ts index 7f77a28..a7cc428 100644 --- a/packages-user/data-base/src/flag/types.ts +++ b/packages-user/data-base/src/flag/types.ts @@ -1,5 +1,7 @@ //#region 字段 +import { ISaveableContent } from '../common'; + export interface IFlagCommonField { /** 此字段所处的 Flag 系统 */ readonly system: IFlagSystem; @@ -42,7 +44,7 @@ export interface IFlagSystemSave { readonly fields: Map; } -export interface IFlagSystem { +export interface IFlagSystem extends ISaveableContent { /** * 判断一个字段是否被占用,类似于旧样板的 `core.hasFlag` * @param field 字段名称 @@ -131,17 +133,6 @@ export interface IFlagSystem { * @param defaultValue 字段默认值 */ getFieldValueDefaults(field: PropertyKey, defaultValue: T): T; - - /** - * 对 Flag 系统进行结构化复制,形成存档对象 - */ - saveState(): IFlagSystemSave; - - /** - * 从指定存档对象读取信息 - * @param state 存档对象 - */ - loadState(state: IFlagSystemSave): void; } //#endregion diff --git a/packages-user/data-base/src/hero/attribute.ts b/packages-user/data-base/src/hero/attribute.ts index e58c2ad..6a1f6f0 100644 --- a/packages-user/data-base/src/hero/attribute.ts +++ b/packages-user/data-base/src/hero/attribute.ts @@ -1,7 +1,9 @@ import { logger } from '@motajs/common'; +import { SaveCompression } from '../common'; import { IHeroAttribute, IHeroModifier } from './types'; -export abstract class BaseHeroModifier implements IHeroModifier { +export abstract class BaseHeroModifier implements IHeroModifier { + abstract readonly type: string; abstract readonly priority: number; owner: IHeroAttribute | null = null; @@ -25,6 +27,14 @@ export abstract class BaseHeroModifier implements IHeroModifier { this.owner = attribute; } + saveState(_compression: SaveCompression): V { + return this.currentValue; + } + + loadState(state: V, _compression: SaveCompression): void { + this.setValue(state); + } + abstract modify(value: T, baseValue: T, name: string): T; abstract clone(): IHeroModifier; @@ -161,4 +171,14 @@ export class HeroAttribute implements IHeroAttribute { getModifiableClone(): IHeroAttribute { return this.clone(); } + + toStructured(): THero { + return structuredClone(this.attribute); + } + + *iterateModifiers(): IterableIterator<[keyof THero, IHeroModifier]> { + for (const [modifier, name] of this.modifierName) { + yield [name, modifier]; + } + } } diff --git a/packages-user/data-base/src/hero/state.ts b/packages-user/data-base/src/hero/state.ts index a202710..37a690d 100644 --- a/packages-user/data-base/src/hero/state.ts +++ b/packages-user/data-base/src/hero/state.ts @@ -1,11 +1,20 @@ +import { HeroAttribute } from './attribute'; import { IHeroAttribute, + IHeroModifier, IHeroMover, IHeroState, + IHeroStateSave, + IModifierStateSave, IReadonlyHeroAttribute } from './types'; +import { SaveCompression } from '../common'; +import { logger } from '@motajs/common'; export class HeroState implements IHeroState { + /** 修饰器工厂函数注册表 */ + private readonly registry: Map IHeroModifier> = new Map(); + constructor( public mover: IHeroMover, public attribute: IHeroAttribute @@ -34,4 +43,74 @@ export class HeroState implements IHeroState { getIsolatedAttribute(): IHeroAttribute { return this.attribute.getModifiableClone(); } + + registerModifier(type: string, cons: () => IHeroModifier): void { + this.registry.set(type, cons); + } + + createModifier(type: string): IHeroModifier | null { + const cons = this.registry.get(type); + if (!cons) { + logger.warn(116, type); + return null; + } else { + return cons() as IHeroModifier; + } + } + + createAndInsertModifier( + type: string, + name: K + ): IHeroModifier | null { + const modifier = this.createModifier(type); + if (!modifier) return null; + this.attribute.addModifier(name, modifier); + return modifier; + } + + saveState(compression: SaveCompression): IHeroStateSave { + const modifiers: IModifierStateSave[] = []; + for (const [name, modifier] of this.attribute.iterateModifiers()) { + modifiers.push({ + name, + type: modifier.type, + state: modifier.saveState(compression) + }); + } + return { + attribute: this.attribute.toStructured(), + locator: { + x: this.mover.x, + y: this.mover.y, + direction: this.mover.direction + }, + followers: structuredClone(this.mover.followers), + modifiers + }; + } + + loadState( + state: IHeroStateSave, + compression: SaveCompression + ): void { + const newAttribute = new HeroAttribute(state.attribute); + for (const save of state.modifiers) { + const cons = this.registry.get(save.type); + if (!cons) continue; + const modifier = cons(); + modifier.loadState(save.state as never, compression); + newAttribute.addModifier( + save.name as keyof THero, + modifier as unknown as IHeroModifier + ); + } + this.attribute = newAttribute; + this.mover.setPosition(state.locator.x, state.locator.y); + this.mover.turn(state.locator.direction); + this.mover.removeAllFollowers(); + state.followers.forEach(follower => { + this.mover.addFollower(follower.num, follower.identifier); + this.mover.setFollowerAlpha(follower.identifier, follower.alpha); + }); + } } diff --git a/packages-user/data-base/src/hero/types.ts b/packages-user/data-base/src/hero/types.ts index c87daaa..a35902b 100644 --- a/packages-user/data-base/src/hero/types.ts +++ b/packages-user/data-base/src/hero/types.ts @@ -1,9 +1,15 @@ -import { IHookBase, IHookable } from '@motajs/common'; -import { FaceDirection } from '@user/data-state'; +import { IFacedTileLocator, IHookBase, IHookable } from '@motajs/common'; +import { FaceDirection, ISaveableContent } from '../common'; //#region 勇士属性 -export interface IHeroModifier { +export interface IHeroModifier< + T = unknown, + V = unknown, + S = unknown +> extends ISaveableContent { + /** 修饰器类型 */ + readonly type: string; /** 修饰器优先级 */ readonly priority: number; /** 修饰器参数值 */ @@ -42,6 +48,15 @@ export interface IHeroModifier { clone(): IHeroModifier; } +export interface IModifierStateSave { + /** 属性名称 */ + readonly name: PropertyKey; + /** 修饰器类型 */ + readonly type: string; + /** 修饰器存档数据 */ + readonly state: unknown; +} + export interface IReadonlyHeroAttribute { /** * 获取勇士的基础属性,即未经过任何 Buff 或装备等加成的属性 @@ -77,6 +92,16 @@ export interface IReadonlyHeroAttribute { * 获取此勇士属性对象的可修改副本 */ getModifiableClone(): IHeroAttribute; + + /** + * 转换为结构化对象 + */ + toStructured(): THero; + + /** + * 遍历所有已挂载的属性修饰器 + */ + iterateModifiers(): Iterable<[PropertyKey, IHeroModifier]>; } export interface IHeroAttribute extends IReadonlyHeroAttribute { @@ -332,7 +357,20 @@ export interface IHeroMover extends IHookable { //#region 勇士状态 -export interface IHeroState { +export interface IHeroStateSave { + /** 勇士属性状态 */ + readonly attribute: THero; + /** 勇士当前位置 */ + readonly locator: IFacedTileLocator; + /** 勇士当前的跟随者 */ + readonly followers: readonly Readonly[]; + /** 勇士属性修饰器状态 */ + readonly modifiers: readonly IModifierStateSave[]; +} + +export interface IHeroState extends ISaveableContent< + IHeroStateSave +> { /** 勇士移动对象 */ readonly mover: IHeroMover; /** 勇士属性对象 */ @@ -369,6 +407,29 @@ export interface IHeroState { * 获取独立勇士属性对象,修改此对象不会影响勇士本身的属性 */ getIsolatedAttribute(): IHeroAttribute; + + /** + * 注册一个修饰器工厂函数 + * @param type 修饰器类型 + * @param cons 工厂函数 + */ + registerModifier(type: string, cons: () => IHeroModifier): void; + + /** + * 创建指定类型的修饰器实例 + * @param type 修饰器类型 + */ + createModifier(type: string): IHeroModifier | null; + + /** + * 创建指定类型的修饰器实例并插入至勇士属性对象 + * @param type 修饰器类型 + * @param name 属性名称 + */ + createAndInsertModifier( + type: string, + name: K + ): IHeroModifier | null; } //#endregion diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index c4d18de..bd52a39 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -1,9 +1,7 @@ -import { IMotaDataLoader } from './load'; -import { ILoadProgressTotal } from '@motajs/loader'; import { IHeroFollower, IHeroState } from './hero'; -import { IEnemyContext, IEnemyManager } from './enemy'; +import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; -import { IRoleFaceBinder } from './common'; +import { IRoleFaceBinder, ISaveableContent } from './common'; import { ILayerState } from './map'; export interface IStateSaveData { @@ -19,11 +17,6 @@ export interface IStateBase { /** 图块数字到 id 的映射 */ readonly numberIdMap: Map; - /** 加载进度对象 */ - readonly loadProgress: ILoadProgressTotal; - /** 数据端加载对象 */ - readonly dataLoader: IMotaDataLoader; - /** 地图状态 */ readonly layer: ILayerState; /** 勇士状态 */ @@ -31,20 +24,20 @@ export interface IStateBase { /** 怪物管理器 */ readonly enemyManager: IEnemyManager; - /** 怪物上下文 */ - readonly enemyContext: IEnemyContext; /** Flag 系统 */ readonly flags: IFlagSystem; /** - * 保存当前状态 + * 添加可存档对象,添加后系统将会自动在存档时将对象存储 + * @param id 可存档对象的 id + * @param content 可存档对象 */ - saveState(): IStateSaveData; + addSaveableContent(id: string, content: ISaveableContent): void; /** - * 加载状态 - * @param state 状态对象 + * 根据 id 获取对应的可存档对象 + * @param id 可存档对象的 id */ - loadState(state: IStateSaveData): void; + getSaveableContent(id: string): ISaveableContent | null; } diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 3466e78..47135f2 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -1,4 +1,4 @@ -import { ICoreState, IStateSaveData } from './types'; +import { ICoreState, ISaveableExecutor } from './types'; import { DamageSystem, EnemyContext, @@ -19,9 +19,12 @@ import { ILayerState, LayerState, RoleFaceBinder, - FaceDirection + FaceDirection, + ISaveableContent, + IStateSaveData, + SaveCompression } from '@user/data-base'; -import { IEnemyAttr } from './enemy/types'; +import { IEnemyAttr } from './enemy'; import { CommonAuraConverter, EnemyLegacyBridge, @@ -36,23 +39,38 @@ import { HERO_DEFAULT_ATTRIBUTE, TILE_HEIGHT, TILE_WIDTH } from './shared'; import { IHeroAttr } from './hero'; import { ILoadProgressTotal, LoadProgressTotal } from '@motajs/loader'; import { isNil } from 'lodash-es'; +import { logger } from '@motajs/common'; +import { ISaveSystem } from './save'; +import { SaveSystem } from './save/system'; export class CoreState implements ICoreState { + // 全局内容 readonly roleFace: IRoleFaceBinder; readonly idNumberMap: Map; readonly numberIdMap: Map; - readonly loadProgress: ILoadProgressTotal; - readonly dataLoader: IMotaDataLoader; - + // 可存档内容 readonly layer: ILayerState; readonly hero: IHeroState; - readonly enemyManager: IEnemyManager; - readonly enemyContext: IEnemyContext; - readonly flags: IFlagSystem; + // 状态内容 + readonly loadProgress: ILoadProgressTotal; + readonly dataLoader: IMotaDataLoader; + readonly enemyContext: IEnemyContext; + readonly saveSystem: ISaveSystem; + + /** 可存档对象映射 */ + private readonly saveables: Map> = new Map(); + /** 所有已添加的可存档对象 */ + private readonly addedSaveables: Set> = new Set(); + /** 已绑定的存档执行器 */ + private readonly executors: Map< + ISaveableContent, + ISaveableExecutor + > = new Map(); + constructor() { this.layer = new LayerState(); this.roleFace = new RoleFaceBinder(); @@ -101,6 +119,25 @@ export class CoreState implements ICoreState { //#endregion + //#region 存档系统 + + this.saveSystem = new SaveSystem(); + // 配置存档系统,一般情况下不建议动,除非你知道你在干什么 + this.saveSystem.config({ + autosaveLevel: SaveCompression.LowCompression, + commonSaveLevel: SaveCompression.HighCompression, + autosaveTimeTolerance: 50, + saveTimeTolerance: 100, + autosaveStackSize: 20 + }); + + // 初始化存档数据库,不要动 + loading.once('coreInit', () => { + this.saveSystem.init(`@game/${core.firstData.name}`); + }); + + //#endregion + //#region 其他初始化 this.flags = new FlagSystem(); @@ -110,6 +147,8 @@ export class CoreState implements ICoreState { this.initEnemyManager(enemys_fcae963b_31c9_42b4_b48c_bb48d09f3f80); }); + this.addSaveableContent('flags', this.flags); + //#endregion } @@ -144,6 +183,36 @@ export class CoreState implements ICoreState { } } + addSaveableContent(id: string, content: ISaveableContent): void { + if (this.saveables.has(id)) { + logger.warn(112, id); + return; + } + this.saveables.set(id, content); + } + + getSaveableContent(id: string): ISaveableContent | null { + const content = this.saveables.get(id); + return (content as ISaveableContent) ?? null; + } + + bindSaveableExecuter( + content: ISaveableContent | string, + executor: ISaveableExecutor + ): void { + if (typeof content === 'string') { + const saveable = this.saveables.get(content); + if (!saveable) return; + this.executors.set(saveable, executor); + } else { + if (!this.addedSaveables.has(content)) { + logger.warn(113); + return; + } + this.executors.set(content, executor); + } + } + saveState(): IStateSaveData { return structuredClone({ followers: this.hero.mover.followers diff --git a/packages-user/data-state/src/enemy/index.ts b/packages-user/data-state/src/enemy/index.ts index c923f4c..5998ef6 100644 --- a/packages-user/data-state/src/enemy/index.ts +++ b/packages-user/data-state/src/enemy/index.ts @@ -5,3 +5,4 @@ export * from './final'; export * from './legacy'; export * from './mapDamage'; export * from './special'; +export * from './types'; diff --git a/packages-user/data-state/src/save/index.ts b/packages-user/data-state/src/save/index.ts new file mode 100644 index 0000000..fcb073f --- /dev/null +++ b/packages-user/data-state/src/save/index.ts @@ -0,0 +1 @@ +export * from './types'; diff --git a/packages-user/data-state/src/save/system.ts b/packages-user/data-state/src/save/system.ts new file mode 100644 index 0000000..8b5fecd --- /dev/null +++ b/packages-user/data-state/src/save/system.ts @@ -0,0 +1,222 @@ +import Dexie, { Table } from 'dexie'; +import { logger } from '@motajs/common'; +import { + IGlobalTrasaction, + ISaveRead, + ISaveSystem, + ISaveSystemConfig +} from './types'; +import { ISaveableContent, SaveCompression } from '@user/data-base'; +import { isNil } from 'lodash-es'; + +interface ISaveRecord { + /** 存档 id */ + readonly id: number; + /** 存档压缩级别 */ + readonly compression: SaveCompression; + /** 存档内容 */ + readonly data: Map; +} + +interface IGlobalRecord { + /** 全局存储的键名 */ + readonly key: string; + /** 全局存储的内容 */ + readonly value: unknown; +} + +export class GlobalTransaction implements IGlobalTrasaction { + constructor(readonly table: Table) {} + + async get(key: string): Promise { + const record = await this.table.get(key); + return record!.value as T; + } + + async set(key: string, value: unknown): Promise { + await this.table.put({ key, value }); + } +} + +export class SaveSystem implements ISaveSystem { + db!: Dexie; + + /** 当前的撤回栈 */ + private readonly undoStack: ISaveRead[] = []; + /** 当前的重做栈 */ + private readonly redoStack: ISaveRead[] = []; + + /** 撤回栈与重做栈的最大长度 */ + private stackSize: number = 20; + /** 自动存档压缩级别 */ + private autosaveLevel: SaveCompression = SaveCompression.LowCompression; + /** 普通存档压缩级别 */ + private commonSaveLevel: SaveCompression = SaveCompression.HighCompression; + /** 普通存档容忍时长 */ + private saveTimeTolerance: number = 100; + /** 自动存档容忍时长 */ + private autosaveTimeTolerance: number = 50; + + init(name: string) { + this.db = new Dexie(name); + this.db.version(1).stores({ + saves: 'id', + global: 'key' + }); + } + + config(config: Readonly>): void { + if (!isNil(config.autosaveLevel)) { + this.autosaveLevel = config.autosaveLevel; + } + if (!isNil(config.commonSaveLevel)) { + this.commonSaveLevel = config.commonSaveLevel; + } + if (!isNil(config.saveTimeTolerance)) { + this.saveTimeTolerance = config.saveTimeTolerance; + } + if (!isNil(config.autosaveTimeTolerance)) { + this.autosaveTimeTolerance = config.autosaveTimeTolerance; + } + if (!isNil(config.autosaveStackSize)) { + const size = config.autosaveStackSize; + this.stackSize = size; + if (this.undoStack.length > size) { + this.undoStack.splice(0, this.undoStack.length - size); + } + if (this.redoStack.length > size) { + this.redoStack.splice(0, this.redoStack.length - size); + } + } + } + + undoAutosave( + current: Map> + ): ISaveRead | null { + if (this.undoStack.length === 0) return null; + const data = new Map(); + for (const [key, content] of current) { + data.set(key, content.saveState(this.autosaveLevel)); + } + this.redoStack.push({ compression: this.autosaveLevel, data }); + if (this.redoStack.length > this.stackSize) { + this.redoStack.splice(0, this.redoStack.length - this.stackSize); + } + return this.undoStack.pop()!; + } + + redoAutosave( + current: Map> + ): ISaveRead | null { + if (this.redoStack.length === 0) return null; + const data = new Map(); + for (const [key, content] of current) { + data.set(key, content.saveState(this.autosaveLevel)); + } + this.undoStack.push({ compression: this.autosaveLevel, data }); + if (this.undoStack.length > this.stackSize) { + this.undoStack.splice(0, this.undoStack.length - this.stackSize); + } + return this.redoStack.pop()!; + } + + getUndoStack(): ISaveRead[] { + return this.undoStack.slice(); + } + + getRedoStack(): ISaveRead[] { + return this.redoStack.slice(); + } + + autosave(state: Map>): void { + const data = new Map(); + for (const [key, content] of state) { + data.set(key, content.saveState(this.autosaveLevel)); + } + this.undoStack.push({ compression: this.autosaveLevel, data }); + this.redoStack.length = 0; + if (this.undoStack.length > this.stackSize) { + this.undoStack.splice(0, this.undoStack.length - this.stackSize); + } + } + + async saveAutosaveToDB(): Promise { + if (this.undoStack.length === 0) return; + const t0 = performance.now(); + const top = this.undoStack[this.undoStack.length - 1]; + const table = this.db.table('saves'); + await table.put({ + id: -1, + compression: top.compression, + data: top.data + }); + const t1 = performance.now(); + if (t1 - t0 > this.autosaveTimeTolerance) { + logger.warn( + 115, + (t1 - t0).toFixed(0), + this.autosaveTimeTolerance.toString() + ); + } + } + + async save( + id: number, + state: Map> + ): Promise { + const t0 = performance.now(); + const data = new Map(); + for (const [key, content] of state) { + data.set(key, content.saveState(this.commonSaveLevel)); + } + const table = this.db.table('saves'); + await table.put({ id, compression: this.commonSaveLevel, data }); + await this.setGlobal('lastSlot', id); + const t1 = performance.now(); + if (t1 - t0 > this.saveTimeTolerance) { + logger.warn( + 114, + (t1 - t0).toFixed(0), + this.saveTimeTolerance.toString() + ); + } + } + + async load(id: number): Promise { + const table = this.db.table('saves'); + const record = await table.get(id); + if (record === undefined) return null; + return { compression: record.compression, data: record.data }; + } + + async deleteSave(id: number): Promise { + const table = this.db.table('saves'); + await table.delete(id); + } + + async getLastSlot(): Promise { + const value = await this.getGlobal('lastSlot'); + return value ?? 0; + } + + async getGlobal(key: string): Promise { + const table = this.db.table('global'); + const record = await table.get(key); + if (!record) return null; + else return record.value as T; + } + + async setGlobal(key: string, value: unknown): Promise { + const table = this.db.table('global'); + await table.put({ key, value }); + } + + async startGlobalTransaction( + handle: (transaction: IGlobalTrasaction) => PromiseLike + ): Promise { + const globalTable = this.db.table('global'); + return this.db.transaction('rw', globalTable, () => { + return handle(new GlobalTransaction(globalTable)); + }); + } +} diff --git a/packages-user/data-state/src/save/types.ts b/packages-user/data-state/src/save/types.ts new file mode 100644 index 0000000..034db4b --- /dev/null +++ b/packages-user/data-state/src/save/types.ts @@ -0,0 +1,142 @@ +import { ISaveableContent, SaveCompression } from '@user/data-base'; +import { Dexie, Table } from 'dexie'; + +export interface IGlobalTrasaction { + /** 全局存储对应的表 */ + readonly table: Table; + + /** + * 获取指定键值对应的数据 + * @param key 全局键值 + */ + get(key: string): Promise; + + /** + * 设置指定键值存储的数据 + * @param key 全局键值 + * @param value 存储数据 + */ + set(key: string, value: unknown): Promise; +} + +export interface ISaveSystemConfig { + /** 自动存档使用的压缩等级 */ + autosaveLevel: SaveCompression; + /** 普通存档使用的压缩等级 */ + commonSaveLevel: SaveCompression; + /** 可容忍的最大存档耗时,超过此值会抛出警告 */ + saveTimeTolerance: number; + /** 可容忍的最大自动存档耗时,超过此值会抛出警告 */ + autosaveTimeTolerance: number; + /** 自动存档栈最大大小 */ + autosaveStackSize: number; +} + +export interface ISaveRead { + /** 该存档的压缩等级 */ + readonly compression: SaveCompression; + /** 该存档的数据 */ + readonly data: Map; +} + +export interface ISaveSystem { + /** Dexie 数据库 */ + readonly db: Dexie; + + /** + * 初始化存档数据库 + * @param name 数据库名称 + */ + init(name: string): void; + + /** + * 配置此存档系统 + * @param config 配置对象 + */ + config(config: Readonly>): void; + + /** + * 从 `undo` 栈读取上一个自动存档,然后将当前状态加入 `redo` 栈 + * @param current 当前游戏状态,需要加入 `redo` 栈 + */ + undoAutosave( + current: Map> + ): ISaveRead | null; + + /** + * 从 `redo` 栈读取自动存档,并将当前状态加入 `undo` 栈 + * @param current 当前游戏状态,需要加入 `undo` 栈 + */ + redoAutosave( + current: Map> + ): ISaveRead | null; + + /** + * 获取当前的撤回栈 + */ + getUndoStack(): ISaveRead[]; + + /** + * 获取当前的重做栈 + */ + getRedoStack(): ISaveRead[]; + + /** + * 进行自动存档,加入撤回栈 + * @param state 状态对象 + */ + autosave(state: Map>): void; + + /** + * 将 `undo` 栈顶的自动存档真正存入 `IndexedDB` + */ + saveAutosaveToDB(): Promise; + + /** + * 将状态对象存入存档 + * @param id 存档 id,用于建立存档索引及查询 + * @param state 状态对象 + */ + save( + id: number, + state: Map> + ): Promise; + + /** + * 根据 id 读取指定存档 + * @param id 存档 id + */ + load(id: number): Promise; + + /** + * 删除指定存档 + * @param id 存档 id + */ + deleteSave(id: number): Promise; + + /** + * 获取最后一次存档的存档栏位 + */ + getLastSlot(): Promise; + + /** + * 获取指定键值对应的全局存储 + * @param key 全局键值 + */ + getGlobal(key: string): Promise; + + /** + * 设置指定键值对应的全局存储 + * @param key 全局键值 + * @param value 存储数据 + */ + setGlobal(key: string, value: unknown): Promise; + + /** + * 进行全局存储的事务处理,适用于多内容查询与设置,当出现错误时其中的任何写入操作都不会真正存储 + * @param handle 事务处理函数 + */ + startGlobalTransaction( + handle: (transaction: IGlobalTrasaction) => PromiseLike + ): Promise; +} diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index 41365d7..318816e 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -1,10 +1,41 @@ -import { IHeroFollower, IStateBase } from '@user/data-base'; -import { IEnemyAttr } from './enemy/types'; +import { + IEnemyContext, + IMotaDataLoader, + ISaveableContent, + IStateBase +} from '@user/data-base'; +import { IEnemyAttr } from './enemy'; import { IHeroAttr } from './hero'; +import { ILoadProgressTotal } from '@motajs/loader'; +import { ISaveSystem } from './save'; -export interface IStateSaveData { - /** 跟随者列表 */ - readonly followers: readonly IHeroFollower[]; +export interface ISaveableExecutor { + /** + * 当数据读取后执行的函数,允许对其他存档对象进行读取 + * @param data 对应可存档对象的存档数据 + * @param state 当前的基础状态 + */ + afterLoad(data: T, state: IStateBase): void; } -export interface ICoreState extends IStateBase {} +export interface ICoreState extends IStateBase { + /** 加载进度对象 */ + readonly loadProgress: ILoadProgressTotal; + /** 数据端加载对象 */ + readonly dataLoader: IMotaDataLoader; + /** 怪物上下文 */ + readonly enemyContext: IEnemyContext; + + /** 存档系统 */ + readonly saveSystem: ISaveSystem; + + /** + * 将某个存档执行器绑定至指定的可存档对象,一个可存档对象只能绑定一个执行器,但一个执行器可以绑定多个可存档对象 + * @param content 可存档对象或其注册 id + * @param executor 可存档对象对应的执行器 + */ + bindSaveableExecuter( + content: ISaveableContent | string, + executor: ISaveableExecutor + ): void; +} diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 74e1cc6..3f850b1 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -168,6 +168,11 @@ "109": "Expected a different object reference returned, but got a same reference at modifier '$1' for property '$2'.", "110": "Expected a hero attribute binding before executing any enemy context calculation.", "111": "Cannot add value to flag field '$1', since the current value is not a number.", + "112": "Cannot add saveable content since id '$1' has already been occupied.", + "113": "Cannot bind saveable executor since target saveable content has not been added.", + "114": "Save operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.", + "115": "Autosave operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.", + "116": "Cannot construct modifier of type '$1' since no registry for it.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } diff --git a/packages/common/src/utils/types.ts b/packages/common/src/utils/types.ts index 39784d6..8334175 100644 --- a/packages/common/src/utils/types.ts +++ b/packages/common/src/utils/types.ts @@ -1,3 +1,5 @@ +import { FaceDirection } from '@user/data-base'; + export interface ISearchable4Dir { /** 获取上侧元素 */ up(): ISearchable4Dir | null; @@ -142,6 +144,11 @@ export interface ITileLocator { y: number; } +export interface IFacedTileLocator extends ITileLocator { + /** 图块朝向 */ + direction: FaceDirection; +} + export const enum InternalDirectionGroup { /** 上下左右四方向 */ Dir4, diff --git a/prompt.md b/prompt.md index c4da0e7..e683987 100644 --- a/prompt.md +++ b/prompt.md @@ -5,8 +5,8 @@ 1. 将我已经写好的代码视为绝对正确,除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。如果你认为我的代码中存在逻辑错误,应当在对话中提出,而不是直接修改。 2. 我做的任何代码修改都是有原因的,如果我在两次对话期间新增、删除或修改了部分代码,不要将其恢复。 3. 时刻以目的进行驱动,想明白我为什么要这么设计接口,这个接口设计的目的是什么,而不是简单地以实现接口为目标。 -4. 如果思考或实现时有任何问题,应该立刻提问,而不是按照自己的想法去写。 -5. 如果我的目标是重构某个接口,按照我说的方式进行重构,如果是彻底性的重构(接口完全没有重合),则按照正常的方式进行实现,旧代码仅做逻辑与思路上的参考;如果是结构性的重构(接口基本一致,但有一些细节上的差距),则应该将旧代码搬到新的接口上,然后进行一些微调,**不要**擅自新增任何参数、任何新的方法或接口,**不要**仅仅通过新增一个兼容层兼容旧代码来实现重构。 +4. 如果思考或实现时有任何问题,比如我的描述比较模糊,或接口描述比较模糊,或某些地方会产生歧义等等,应该立刻向我提问,而不是按照自己的想法去写。 +5. 如果我的目标是重构某个接口,按照我说的方式进行重构。如果是彻底性的重构(接口完全没有重合),则按照正常的方式进行实现,旧代码仅做逻辑与思路上的参考;如果是结构性的重构(接口基本一致,但有一些细节上的差距),则应该将旧代码搬到新的接口上,然后进行一些微调,**不要**擅自新增任何参数、任何新的方法或接口,**不要**仅仅通过新增一个兼容层兼容旧代码来实现重构。 # 建议规则 @@ -15,3 +15,70 @@ 1. 我有时会在对话中给你提出实现建议,你应该对建议内容进行合理的参考,合理运用建议内容,一定注意不要滥用。 2. 如果实现与类型标注有冲突,应当以类型标注(一般是 `types.ts`)中的内容为参考来源。 3. 如果你认为类型标注中的接口设计有问题,或在实现中发现其缺少某些接口,应该向我提问是否添加,我同意后方可添加。 + +**时刻谨记上述要求,避免一个需求写好几次都写不出来,或写出我不满意的代码而挨骂** + +# 开发流程 + +当我提出需求时,如果没有明确说明直接实现或有其他明确要求,则遵循如下开发流程: + +1. 阅读当前代码,分析需求,将需求整理为一个 markdown 文档,文档中明确标记需求细节,以及代码实现的大体思路。这一阶段中应当考虑全面,遇到任何问题应向我提问并确认。文档可以放在 `docs/dev` 目录下。 +2. 我会对文档进行全面的阅读,确保实现细节与思路没有问题后,允许你开始实现。这一步中我可能会对文档进行细微的调整,确保重新仔细阅读文档。如果实现时遇到了任何问题,应该向我提问,而不是按照自己的想法去写。 + +## 示例文档 + +大致按照下述示例文档的格式编写,如果某些场景需要详细描述某个东西,可以单独开一个标题来写。 + +```md +# 需求综述 + +描述清楚需求的内容与目的。 + +# 实现思路 + +按照下面的格式分条描述实现思路,可以创建为 `todo list`。 + +## 1. 完成 xxx + +... + +## 2. 完成 xxx + +... + +# 涉及文件 + +## 需要引用的文件 + +按照第三方库-其他包-当前包的其他文件的顺序写。 + +- `xxx 库`: 引用第三方库,说明引用目的,以及需要的接口 +- `@user/xxx`: 引用的目的,需要这个文件的哪些接口 +- `xxx.ts`: 引用此文件的目的,需要这个文件的哪些接口 + +## 需要修改的文件 + +### `@user/package/[folder/]file.ts` + +除非必要或明确提出,一般不建议擅自新增公共方法或成员,必要时可以向我提问。 + +- [ ] 新增 `Iinterface` 接口:描述新增接口的动机与目的,会用于干什么 +- [ ] 新增 `Type` 类型别名:描述新增类型别名的动机与目的,会用于干什么 +- [ ] 新增 `private readonly property` 成员:描述新增成员的动机与目的,会用于干什么 +- [ ] 新增 `private method(...)` 方法:描述新增方法的动机与目的,会用于干什么 +- [ ] 编写 `Class.method` 方法:描述实现的大体内容 +- [ ] 修改 `Class.method` 方法中的部分内容:描述修改哪些内容,修改这些内容的目的 +- [ ] 重构文件结构,将 `xxx` 与 `yyy` 修改为 `zzz` 与 `www`... + ... + +### `@motajs/package/[folder/]file.ts` + +... + +# 问题 + +如果我的描述中有歧义或比较模糊,可以在这把问题写出来,或者直接向我提问。 + +1. xxxxxx? +2. xxxxxx? +``` From 2ce50bf23ebdab0d51001211403d76a5e294bc83 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Fri, 24 Apr 2026 22:17:01 +0800 Subject: [PATCH 03/26] =?UTF-8?q?refactor:=20=E6=80=AA=E7=89=A9=E7=AE=A1?= =?UTF-8?q?=E7=90=86=E5=99=A8=E5=AD=98=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot --- docs/dev/enemy-manager-save.md | 194 +++++++++++++++++++ docs/dev/hero-modifier-save.md | 26 +-- packages-user/data-base/src/enemy/enemy.ts | 25 +++ packages-user/data-base/src/enemy/manager.ts | 135 ++++++++++++- packages-user/data-base/src/enemy/special.ts | 27 +++ packages-user/data-base/src/enemy/types.ts | 74 ++++++- packages/common/src/logger.json | 4 + 7 files changed, 464 insertions(+), 21 deletions(-) create mode 100644 docs/dev/enemy-manager-save.md diff --git a/docs/dev/enemy-manager-save.md b/docs/dev/enemy-manager-save.md new file mode 100644 index 0000000..c08cf0c --- /dev/null +++ b/docs/dev/enemy-manager-save.md @@ -0,0 +1,194 @@ +# 需求综述 + +对怪物管理器 `IEnemyManager` 进行存档适配,使其能够参与游戏存档系统。 +由于大多数情况下怪物模板不会被修改,不需要全量存储, +只需对比"参考状态"(游戏加载完成时的初始模板),仅保存发生了变化的模板。 + +为此需要: + +- `IEnemy` 和 `ISpecial` 继承 `ISaveableContent` 以支持自身序列化; +- 给 `ISpecial` 添加 `deepEqualsTo` 接口用于特殊属性间的深度比较; +- `IEnemyManager` 继承 `ISaveableContent`,新增 `compareWith`、`modifyPrefabAttribute`、 + `attachEnemyComparer`、`getEnemyComparer` 接口; +- `IEnemyManager` 内部维护 dirty 集合,以首次 `compareWith` 传入的参考为唯一基准; +- `getPrefab` / `getPrefabById` 返回值收窄为 `IReadonlyEnemy`, + 统一由 `modifyPrefabAttribute` 承担模板修改职责。 + +--- + +# 实现思路 + +## 1. 新增存档状态类型 + +在 `types.ts` 中新增如下类型,用于序列化怪物与管理器的状态: + +```ts +/** 单个 IEnemy 的存档状态 */ +interface IEnemySaveState { + readonly attrs: TAttr; + // 特殊属性按 code 映射,值为各 ISpecial.saveState() 的结果 + readonly specials: ReadonlyMap; +} + +/** IEnemyManager 的存档状态,只保存与参考状态不同的模板 */ +interface IEnemyManagerSaveState { + // code -> 变更后的 IEnemySaveState + readonly modified: ReadonlyMap>; +} +``` + +## 2. 新增 `IEnemyComparer` 接口 + +由于管理器外部没有比较怪物属性的需求,将比较逻辑封装为独立的比较器, +附着在 `EnemyManager` 上。比较器接口如下: + +```ts +interface IEnemyComparer { + compare( + enemyA: IReadonlyEnemy, + enemyB: IReadonlyEnemy + ): boolean; +} +``` + +由用户在初始化时通过 `attachEnemyComparer` 提供。若未提供比较器, +在调用 `modifyPrefabAttribute` 或 `changePrefab` 时需发出警告,且视所有怪物均为脏。 + +## 3. `ISpecial` 继承 `ISaveableContent` + +- `saveState` 返回 `structuredClone(this.value)`(即 `getValue()` 的深拷贝); +- `loadState` 调用 `setValue(state)`; +- 新增 `deepEqualsTo(other: ISpecial): boolean`:先对比 `code`, + 再对 `value` 进行深度比较。 + +各内置实现类的比较策略: + +- `NonePropertySpecial`:只需比较 `code`,`value` 为 `void` 无需对比; +- `CommonSerializableSpecial`:`value` 为普通可序列化对象, + 使用 `lodash-es` 的 `isEqual` 进行递归深度比较。 + +## 4. `IEnemy` 继承 `ISaveableContent>` + +- `saveState(compression)`:深拷贝 `attrs`,对每个 special 调用 + `saveState(compression)` 收集到 `specials` Map,返回 `IEnemySaveState`; +- `loadState(state, compression)`:以 `state.attrs` 还原属性, + 然后对已有的每个 special 按 code 查找存档中的对应条目并调用 `loadState`; + 若存档中出现当前怪物未注册的 special code,发出 logger 警告并跳过。 + +## 5. `IEnemyManager` 接口修改 + +### 5a. 继承 `ISaveableContent>` + +- `saveState(compression)`:遍历 dirty 集合,对每个脏模板调用 + `prefab.saveState(compression)`,汇总为 `IEnemyManagerSaveState` 并返回; +- `loadState(state, compression)`:遍历 `state.modified`, + 找到 code 对应的现有模板,调用 `prefab.loadState(enemyState, compression)` 还原; + 若某 code 不在当前 prefab 表中,发出 logger 警告并跳过; + **不清空 dirty 集合**,始终以首次 `compareWith` 提供的参考为唯一基准; + `loadState` 结束后重新用比较器对每个已有脏模板进行比对, + 刷新 dirty 集合(避免加载后实际已恢复初始值的模板仍停留在 dirty 中)。 + +### 5b. 新增 `compareWith` + +```ts +compareWith(reference: ReadonlyMap>): void; +``` + +- 由调用方在游戏初始化完成后提供参考快照,外部传入,管理器保存引用; +- **首次调用**:直接存储参考,清空 dirty 集合; +- **非首次调用**:通过 logger 发出警告,提示此操作风险高, + 请作者确认操作意图,但仍然执行覆盖(直接替换参考,重置 dirty 集合)。 + +### 5c. `getPrefab` / `getPrefabById` 返回值改为 `IReadonlyEnemy` + +原来返回 `IEnemy`,外部可以直接修改模板。 +改为只读引用,外部不能直接修改,必须通过 `modifyPrefabAttribute` 完成。 + +### 5d. 新增 `modifyPrefabAttribute` + +```ts +modifyPrefabAttribute( + code: number | string, + modify: (prefab: IEnemy) => IEnemy +): void; +``` + +执行流程: + +1. 根据 `code`(数字或 id 字符串)找到对应的模板; +2. 将模板以可写引用传入 `modify`,获得修改结果; +3. 若 `modify` 返回的是**新引用**(与传入的不同),则将该新对象替换模板表条目 + (同时更新 `prefabByCode` 与 `prefabById`); +4. 将最终生效的模板与 `compareWith` 中提供的参考模板进行 `IEnemyComparer.compare` 比较: + - 若不相等,则将此 code 加入 dirty 集合; + - 若相等(改回了初始值),则从 dirty 集合中移除; +5. 若未附加比较器,则始终视为脏,并发出 logger 警告。 + +### 5e. 新增 `attachEnemyComparer` / `getEnemyComparer` + +```ts +attachEnemyComparer(comparer: IEnemyComparer): void; +getEnemyComparer(): IEnemyComparer | null; +``` + +- `attachEnemyComparer`:设置当前管理器使用的比较器; +- `getEnemyComparer`:返回当前比较器,如未设置则返回 `null`, + 允许外部在特殊场景下借用比较器。 + +### 5f. `changePrefab` 也参与 dirty 追踪 + +`changePrefab` 直接替换模板表,修改完成后同样与参考模板进行比较, +更新 dirty 集合(逻辑与 `modifyPrefabAttribute` 步骤 4 相同)。 + +`deletePrefab` 不参与 dirty 追踪,存档时直接跳过被删除的模板。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `lodash-es`:`CommonSerializableSpecial.deepEqualsTo` 中使用 `isEqual` 进行深度比较 +- `@motajs/common`:引用 `logger` 接口 +- `@user/data-base/common/types.ts`:引用 `ISaveableContent`、`SaveCompression` + +## 需要修改的文件 + +### `packages-user/data-base/src/enemy/types.ts` + +- [ ] 新增 `IEnemySaveState` 类型:单个怪物的存档状态 +- [ ] 新增 `IEnemyManagerSaveState` 类型:管理器的存档状态 +- [ ] 新增 `IEnemyComparer` 接口:包含 `compare` 方法,由用户实现 +- [ ] 修改 `ISpecial`:继承 `ISaveableContent`, + 新增 `deepEqualsTo(other: ISpecial): boolean` +- [ ] 修改 `IEnemy`:继承 `ISaveableContent>` +- [ ] 修改 `IEnemyManager`:继承 `ISaveableContent>`, + 新增 `compareWith`、`modifyPrefabAttribute`、`attachEnemyComparer`、`getEnemyComparer`; + 修改 `getPrefab` 与 `getPrefabById` 返回类型为 `IReadonlyEnemy` + +### `packages-user/data-base/src/enemy/enemy.ts`(`Enemy` 类) + +- [ ] 实现 `saveState(compression): IEnemySaveState` +- [ ] 实现 `loadState(state, compression): void` + +### `packages-user/data-base/src/enemy/manager.ts`(`EnemyManager` 类) + +- [ ] 新增 `private readonly dirtySet: Set` 成员:记录脏模板的 code +- [ ] 新增 `private referenceByCode: Map>` 成员: + 保存参考快照 +- [ ] 新增 `private comparer: IEnemyComparer | null` 成员:比较器 +- [ ] 新增 `private hasReference: boolean` 成员:标记是否已首次调用 `compareWith` +- [ ] 实现 `compareWith`:存储参考快照,非首次调用发出警告,重置 dirty 集合 +- [ ] 实现 `modifyPrefabAttribute`:调用 modify、处理引用变化、比较、更新 dirty 集合 +- [ ] 修改 `changePrefab`:替换模板后同步更新 dirty 集合 +- [ ] 修改 `getPrefab` / `getPrefabById` 返回类型(仅类型,实现无需改动) +- [ ] 实现 `attachEnemyComparer` / `getEnemyComparer` +- [ ] 实现 `saveState`:遍历 dirty 集合,序列化并返回 +- [ ] 实现 `loadState`:根据存档恢复脏模板,恢复后重新刷新 dirty 集合 + +### 引擎内置特殊属性(当前包内) + +- [ ] `NonePropertySpecial`:实现 `saveState`、`loadState`、`deepEqualsTo` + (`value` 为 `void`,`deepEqualsTo` 只比较 `code`) +- [ ] `CommonSerializableSpecial`:实现 `saveState`、`loadState`、`deepEqualsTo` + (`deepEqualsTo` 的 value 比较使用 `lodash-es` 的 `isEqual`) diff --git a/docs/dev/hero-modifier-save.md b/docs/dev/hero-modifier-save.md index c060db7..b5a87e1 100644 --- a/docs/dev/hero-modifier-save.md +++ b/docs/dev/hero-modifier-save.md @@ -83,28 +83,28 @@ iterateModifiers(): Iterable<[keyof THero, IHeroModifier]>; ### `@user/data-base/hero/types.ts` -- [ ] 修改 `IHeroModifier` 接口: +- [x] 修改 `IHeroModifier` 接口: 改为 `IHeroModifier`,`identifier` 改名为 `type`, 继承 `ISaveableContent` -- [ ] 新增 `IModifierStateSave` 接口:单条修饰器的存档格式 -- [ ] 修改 `IHeroStateSave`:新增 `readonly modifiers: readonly IModifierStateSave[]` 字段 -- [ ] 修改 `IReadonlyHeroAttribute`:新增 `iterateModifiers()` 方法签名 -- [ ] 修改 `IHeroState`:新增以下方法签名 - `registerModifier(type: string, cons: () => IHeroModifier): void` - `createModifier(type: string): IHeroModifier` - `createAndInsertModifier(type: string, name: K): IHeroModifier` +- [x] 新增 `IModifierStateSave` 接口:单条修饰器的存档格式 +- [x] 修改 `IHeroStateSave`:新增 `readonly modifiers: readonly IModifierStateSave[]` 字段 +- [x] 修改 `IReadonlyHeroAttribute`:新增 `iterateModifiers()` 方法签名 +- [x] 修改 `IHeroState`:新增以下方法签名 - `registerModifier(type: string, cons: () => IHeroModifier): void` - `createModifier(type: string): IHeroModifier` - `createAndInsertModifier(type: string, name: K): IHeroModifier` ### `@user/data-base/hero/attribute.ts` -- [ ] 修改 `BaseHeroModifier`: +- [x] 修改 `BaseHeroModifier`: 将 `abstract readonly identifier` 改为 `abstract readonly type`; 实现 `saveState` / `loadState` -- [ ] 修改 `HeroAttribute`:实现 `iterateModifiers()` +- [x] 修改 `HeroAttribute`:实现 `iterateModifiers()` ### `@user/data-base/hero/state.ts` -- [ ] 修改 `HeroState`:新增 `private readonly registry: Map IHeroModifier>` 成员 -- [ ] 实现 `HeroState.registerModifier`:将工厂函数写入 `registry` -- [ ] 实现 `HeroState.createModifier`:从 `registry` 取出工厂并调用,返回新实例; +- [x] 修改 `HeroState`:新增 `private readonly registry: Map IHeroModifier>` 成员 +- [x] 实现 `HeroState.registerModifier`:将工厂函数写入 `registry` +- [x] 实现 `HeroState.createModifier`:从 `registry` 取出工厂并调用,返回新实例; 若 `type` 未注册则抛出错误 -- [ ] 实现 `HeroState.createAndInsertModifier`:调用 `createModifier` 后, +- [x] 实现 `HeroState.createAndInsertModifier`:调用 `createModifier` 后, 再调用 `this.attribute.addModifier(name, modifier)`,返回同一实例 -- [ ] 修改 `HeroState.saveState`:遍历 `iterateModifiers()` 写入 `modifiers` 字段 -- [ ] 修改 `HeroState.loadState`:遍历 `state.modifiers` 重建修饰器并挂载 +- [x] 修改 `HeroState.saveState`:遍历 `iterateModifiers()` 写入 `modifiers` 字段 +- [x] 修改 `HeroState.loadState`:遍历 `state.modifiers` 重建修饰器并挂载 diff --git a/packages-user/data-base/src/enemy/enemy.ts b/packages-user/data-base/src/enemy/enemy.ts index 501da36..189e2f1 100644 --- a/packages-user/data-base/src/enemy/enemy.ts +++ b/packages-user/data-base/src/enemy/enemy.ts @@ -2,10 +2,12 @@ import { logger } from '@motajs/common'; import { IEnemy, IEnemyContext, + IEnemySaveState, IReadonlyEnemy, ISpecial, IEnemyView } from './types'; +import { SaveCompression } from '../common/types'; export class Enemy implements IEnemy { /** 怪物身上的特殊属性列表 */ @@ -87,6 +89,29 @@ export class Enemy implements IEnemy { this.addSpecial(special.clone()); } } + + saveState(_compression: SaveCompression): IEnemySaveState { + const specials: Map = new Map(); + for (const special of this.specials) { + specials.set(special.code, special.saveState(_compression)); + } + return { attrs: structuredClone(this.attributes), specials }; + } + + loadState( + state: IEnemySaveState, + compression: SaveCompression + ): void { + this.attributes = structuredClone(state.attrs); + for (const special of this.specials) { + const saved = state.specials.get(special.code); + if (saved === undefined) { + logger.warn(120, special.code.toString(), this.id); + continue; + } + special.loadState(saved, compression); + } + } } export class EnemyView implements IEnemyView { diff --git a/packages-user/data-base/src/enemy/manager.ts b/packages-user/data-base/src/enemy/manager.ts index 2f69c34..210f601 100644 --- a/packages-user/data-base/src/enemy/manager.ts +++ b/packages-user/data-base/src/enemy/manager.ts @@ -2,10 +2,15 @@ import { logger } from '@motajs/common'; import { Enemy as EnemyImpl } from './enemy'; import { IEnemy, + IEnemyComparer, IEnemyManager, + IEnemyManagerSaveState, IEnemyLegacyBridge, - SpecialCreation + IReadonlyEnemy, + SpecialCreation, + IEnemySaveState } from './types'; +import { SaveCompression } from '../common/types'; export class EnemyManager implements IEnemyManager { /** 特殊属性注册表,code -> 创建函数 */ @@ -19,6 +24,14 @@ export class EnemyManager implements IEnemyManager { private readonly prefabById: Map> = new Map(); /** 旧样板怪物 id 到 code 的映射,用于 fromLegacyEnemy 快速查找已有模板 */ private readonly legacyIdToCode: Map = new Map(); + /** 脏模板集合,存储发生了变化的模板 code */ + private readonly dirtySet: Set = new Set(); + /** 参考快照,code -> IReadonlyEnemy,由 compareWith 提供 */ + private referenceByCode: Map> = new Map(); + /** 当前附加的怪物比较器 */ + private comparer: IEnemyComparer | null = null; + /** 是否已首次调用 compareWith */ + private hasReference: boolean = false; constructor(readonly bridge: IEnemyLegacyBridge) {} @@ -127,6 +140,7 @@ export class EnemyManager implements IEnemyManager { const cloned = enemy.clone(); this.prefabByCode.set(enemy.code, cloned); this.prefabById.set(enemy.id, cloned); + this.updateDirty(cloned.code, cloned); } addPrefabFromLegacy(code: number, enemy: Enemy): void { @@ -137,13 +151,14 @@ export class EnemyManager implements IEnemyManager { this.prefabByCode.set(code, prefab); this.prefabById.set(prefab.id, prefab); this.legacyIdToCode.set(enemy.id, code); + this.updateDirty(code, prefab); } - getPrefab(code: number): IEnemy | null { + getPrefab(code: number): IReadonlyEnemy | null { return this.prefabByCode.get(code) ?? null; } - getPrefabById(id: string): IEnemy | null { + getPrefabById(id: string): IReadonlyEnemy | null { return this.prefabById.get(id) ?? null; } @@ -160,6 +175,7 @@ export class EnemyManager implements IEnemyManager { // 再添加新的模板 this.prefabByCode.set(enemy.code, enemy); this.prefabById.set(enemy.id, enemy); + this.updateDirty(enemy.code, enemy); } reusePrefab(source: number | string, code: number, id: string): void { @@ -168,4 +184,117 @@ export class EnemyManager implements IEnemyManager { this.prefabByCode.set(code, prefab); this.prefabById.set(id, prefab); } + + compareWith(reference: ReadonlyMap>): void { + const isSubsequentCall = this.hasReference; + if (isSubsequentCall) { + logger.warn(117); + } + this.referenceByCode = new Map(); + reference.forEach((enemy, key) => { + this.referenceByCode.set(key, enemy.clone()); + }); + this.hasReference = true; + this.dirtySet.clear(); + if (isSubsequentCall) { + this.refreshDirty(reference.keys()); + } + } + + modifyPrefabAttribute( + code: number | string, + modify: (prefab: IEnemy) => IEnemy + ): void { + const prefab = this.internalGetPrefab(code); + if (!prefab) return; + const result = modify(prefab); + const prefabCode = prefab.code; + if (result !== prefab) { + this.prefabByCode.set(result.code, result); + this.prefabById.set(result.id, result); + if (result.code !== prefabCode) { + this.prefabByCode.delete(prefabCode); + } + if (result.id !== prefab.id) { + this.prefabById.delete(prefab.id); + } + } + this.updateDirty(result.code, result); + } + + attachEnemyComparer(comparer: IEnemyComparer): void { + this.comparer = comparer; + } + + getEnemyComparer(): IEnemyComparer | null { + return this.comparer; + } + + saveState(compression: SaveCompression): IEnemyManagerSaveState { + const modified: Map> = new Map(); + for (const code of this.dirtySet) { + const prefab = this.prefabByCode.get(code); + if (!prefab) continue; + modified.set(code, prefab.saveState(compression)); + } + return { modified }; + } + + loadState( + state: IEnemyManagerSaveState, + compression: SaveCompression + ): void { + for (const [code, enemyState] of state.modified) { + const prefab = this.prefabByCode.get(code); + if (!prefab) { + logger.warn(119, code.toString()); + continue; + } + prefab.loadState(enemyState, compression); + } + // loadState 结束后重新刷新 dirty 集合 + this.refreshDirty(state.modified.keys()); + } + + /** + * 根据参考快照更新指定 code 的脏状态 + * @param code 怪物图块数字 + * @param current 当前模板对象 + */ + private updateDirty(code: number, current: IEnemy): void { + if (!this.hasReference) return; + if (!this.comparer) { + logger.warn(118); + this.dirtySet.add(code); + return; + } + const ref = this.referenceByCode.get(code); + if (!ref || !this.comparer.compare(current, ref)) { + this.dirtySet.add(code); + } else { + this.dirtySet.delete(code); + } + } + + /** + * 将所有模板加入脏集合,再与参考比较,去除未变化的模板 + */ + private refreshDirty(dirties: Iterable): void { + if (!this.hasReference) return; + for (const code of dirties) { + this.dirtySet.add(code); + } + if (!this.comparer) return; + for (const code of [...this.dirtySet]) { + const prefab = this.prefabByCode.get(code); + if (!prefab) { + this.dirtySet.delete(code); + continue; + } + const ref = this.referenceByCode.get(code); + if (ref && this.comparer.compare(prefab, ref)) { + this.dirtySet.delete(code); + } + } + } } diff --git a/packages-user/data-base/src/enemy/special.ts b/packages-user/data-base/src/enemy/special.ts index 5072728..59c1083 100644 --- a/packages-user/data-base/src/enemy/special.ts +++ b/packages-user/data-base/src/enemy/special.ts @@ -1,3 +1,5 @@ +import { isEqual } from 'lodash-es'; +import { SaveCompression } from '../common/types'; import { ISpecial, SpecialCreation } from './types'; // TODO: 颜色参数 @@ -45,6 +47,19 @@ export class CommonSerializableSpecial implements ISpecial { this.config ); } + + saveState(_compression: SaveCompression): T { + return structuredClone(this.value); + } + + loadState(state: T, _compression: SaveCompression): void { + this.setValue(state); + } + + deepEqualsTo(other: ISpecial): boolean { + if (this.code !== other.code) return false; + return isEqual(this.value, other.getValue()); + } } export class NonePropertySpecial implements ISpecial { @@ -78,6 +93,18 @@ export class NonePropertySpecial implements ISpecial { clone(): ISpecial { return new NonePropertySpecial(this.code, this.config); } + + saveState(_compression: SaveCompression): void { + return undefined; + } + + loadState(_state: void, _compression: SaveCompression): void { + // 无属性,无需操作 + } + + deepEqualsTo(other: ISpecial): boolean { + return this.code === other.code; + } } export function defineCommonSerializableSpecial( diff --git a/packages-user/data-base/src/enemy/types.ts b/packages-user/data-base/src/enemy/types.ts index 210381a..849a7a2 100644 --- a/packages-user/data-base/src/enemy/types.ts +++ b/packages-user/data-base/src/enemy/types.ts @@ -1,9 +1,36 @@ import { IRange, ITileLocator } from '@motajs/common'; import { IHeroAttribute, IReadonlyHeroAttribute } from '../hero'; +import { ISaveableContent } from '../common/types'; //#region 怪物基础 -export interface ISpecial { +/** 单个 IEnemy 的存档状态 */ +export interface IEnemySaveState { + /** 怪物属性的深拷贝 */ + readonly attrs: TAttr; + /** 特殊属性按 code 映射,值为各 ISpecial.saveState() 的结果 */ + readonly specials: ReadonlyMap; +} + +/** IEnemyManager 的存档状态,只保存与参考状态不同的模板 */ +export interface IEnemyManagerSaveState { + /** code -> 变更后的 IEnemySaveState,仅包含脏模板 */ + readonly modified: ReadonlyMap>; +} + +export interface IEnemyComparer { + /** + * 比较两个怪物是否完全相同 + * @param enemyA 怪物 A + * @param enemyB 怪物 B + */ + compare( + enemyA: IReadonlyEnemy, + enemyB: IReadonlyEnemy + ): boolean; +} + +export interface ISpecial extends ISaveableContent { /** 特殊属性代码 */ readonly code: number; /** 特殊属性需要的数值 */ @@ -40,6 +67,12 @@ export interface ISpecial { * 深拷贝此特殊属性 */ clone(): ISpecial; + + /** + * 深度比较此特殊属性与另一特殊属性是否相同 + * @param other 另一特殊属性 + */ + deepEqualsTo(other: ISpecial): boolean; } export interface IReadonlyEnemy { @@ -82,7 +115,8 @@ export interface IReadonlyEnemy { clone(): IReadonlyEnemy; } -export interface IEnemy extends IReadonlyEnemy { +export interface IEnemy + extends IReadonlyEnemy, ISaveableContent> { /** * 添加特殊属性 * @param special 特殊属性对象 @@ -138,7 +172,9 @@ export interface IEnemyLegacyBridge { fromLegacyEnemy(enemy: Enemy, defaultValue: Partial): TAttr; } -export interface IEnemyManager { +export interface IEnemyManager extends ISaveableContent< + IEnemyManagerSaveState +> { /** * 注册一个特殊属性 * @param code 特殊属性代码 @@ -193,13 +229,13 @@ export interface IEnemyManager { * 获取指定怪物的模板 * @param code 怪物图块数字 */ - getPrefab(code: number): IEnemy | null; + getPrefab(code: number): IReadonlyEnemy | null; /** * 根据怪物的 `id` 获取对应的怪物模板 * @param id 怪物 `id` */ - getPrefabById(id: string): IEnemy | null; + getPrefabById(id: string): IReadonlyEnemy | null; /** * 删除指定的怪物模板 @@ -221,6 +257,34 @@ export interface IEnemyManager { * @param id 复用怪物 id */ reusePrefab(source: number | string, code: number, id: string): void; + + /** + * 设置参考快照,后续对模板的修改将与此比较以确定是否脏。 + * 非首次调用时会发出警告,但仍执行覆盖 + * @param reference code -> 参考怪物的 Map + */ + compareWith(reference: ReadonlyMap>): void; + + /** + * 修改指定怪物模板的属性,修改完成后自动与参考模板比较并更新 dirty 集合 + * @param code 怪物的图块数字或 `id` + * @param modify 修改函数,传入可写怪物对象,返回修改后的对象 + */ + modifyPrefabAttribute( + code: number | string, + modify: (prefab: IEnemy) => IEnemy + ): void; + + /** + * 附加怪物比较器,用于 dirty 集合的判断 + * @param comparer 比较器对象 + */ + attachEnemyComparer(comparer: IEnemyComparer): void; + + /** + * 获取当前附加的怪物比较器,如未设置则返回 `null` + */ + getEnemyComparer(): IEnemyComparer | null; } //#endregion diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 3f850b1..2028acd 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -173,6 +173,10 @@ "114": "Save operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.", "115": "Autosave operation took $1ms, exceeding the tolerance of $2ms. Consider reducing compression level.", "116": "Cannot construct modifier of type '$1' since no registry for it.", + "117": "EnemyManager.compareWith called more than once. The previous reference will be overridden. Please ensure you intend to do this.", + "118": "No enemy comparer attached to EnemyManager. All enemies will be treated as dirty.", + "119": "Enemy prefab with code $1 not found during loadState, skipping.", + "120": "Special with code $1 not found in enemy '$2' during loadState, skipping.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } From 476f735adc064248aa66ba687145daf1668c6d7a Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Fri, 24 Apr 2026 23:12:18 +0800 Subject: [PATCH 04/26] =?UTF-8?q?refactor:=20manager=20=E7=9A=84=E5=A4=8D?= =?UTF-8?q?=E7=94=A8=E6=96=B9=E6=A1=88=20&=20fix:=20=E7=B1=BB=E5=9E=8B?= =?UTF-8?q?=E9=94=99=E8=AF=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot --- .../src/render/elements/props.ts | 2 +- .../client-modules/src/render/map/element.ts | 2 +- .../src/render/map/extension/door.ts | 2 +- .../src/render/map/extension/hero.ts | 3 +- .../src/render/map/extension/manager.ts | 2 +- .../src/render/map/extension/types.ts | 2 +- .../client-modules/src/render/map/moving.ts | 2 +- .../client-modules/src/render/map/renderer.ts | 2 +- .../client-modules/src/render/map/status.ts | 2 +- .../client-modules/src/render/map/types.ts | 2 +- .../client-modules/src/render/map/vertex.ts | 2 +- packages-user/data-base/src/enemy/manager.ts | 20 ++++++++---- packages-user/data-state/src/core.ts | 16 ++++++++-- .../data-state/src/enemy/comparer.ts | 31 +++++++++++++++++++ packages-user/data-state/src/legacy/move.ts | 5 ++- .../legacy-plugin-data/src/fallback.ts | 11 ++----- packages/legacy-ui/src/tools/fixed.ts | 2 ++ 17 files changed, 76 insertions(+), 32 deletions(-) create mode 100644 packages-user/data-state/src/enemy/comparer.ts diff --git a/packages-user/client-modules/src/render/elements/props.ts b/packages-user/client-modules/src/render/elements/props.ts index ce4da18..a3c7a7d 100644 --- a/packages-user/client-modules/src/render/elements/props.ts +++ b/packages-user/client-modules/src/render/elements/props.ts @@ -1,6 +1,6 @@ import { BaseProps, TagDefine } from '@motajs/render-vue'; import { ERenderItemEvent, SizedCanvasImageSource } from '@motajs/render'; -import { ILayerState } from '@user/data-state'; +import { ILayerState } from '@user/data-base'; import { IMapExtensionManager, IMapRenderer } from '../map'; export interface IconProps extends BaseProps { diff --git a/packages-user/client-modules/src/render/map/element.ts b/packages-user/client-modules/src/render/map/element.ts index 11487d8..a2352dd 100644 --- a/packages-user/client-modules/src/render/map/element.ts +++ b/packages-user/client-modules/src/render/map/element.ts @@ -1,5 +1,5 @@ import { MotaOffscreenCanvas2D, RenderItem } from '@motajs/render'; -import { ILayerState } from '@user/data-state'; +import { ILayerState } from '@user/data-base'; import { IMapRenderer } from './types'; import { ElementNamespace, ComponentInternalInstance } from 'vue'; import { CELL_HEIGHT, CELL_WIDTH, MAP_HEIGHT, MAP_WIDTH } from '../../shared'; diff --git a/packages-user/client-modules/src/render/map/extension/door.ts b/packages-user/client-modules/src/render/map/extension/door.ts index ce08fc5..7420ddc 100644 --- a/packages-user/client-modules/src/render/map/extension/door.ts +++ b/packages-user/client-modules/src/render/map/extension/door.ts @@ -2,7 +2,7 @@ import { IMapLayer, IMapLayerHookController, IMapLayerHooks -} from '@user/data-state'; +} from '@user/data-base'; import { IMapDoorRenderer } from './types'; import { IMapRenderer } from '../types'; import { sleep } from 'mutate-animate'; diff --git a/packages-user/client-modules/src/render/map/extension/hero.ts b/packages-user/client-modules/src/render/map/extension/hero.ts index 039ed77..e28d05a 100644 --- a/packages-user/client-modules/src/render/map/extension/hero.ts +++ b/packages-user/client-modules/src/render/map/extension/hero.ts @@ -7,7 +7,7 @@ import { IHeroMovingHooks, nextFaceDirection } from '@user/data-base'; -import { IMapLayer, state } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { IMapRenderer, IMapRendererTicker, IMovingBlock } from '../types'; import { isNil } from 'lodash-es'; import { IHookController, logger } from '@motajs/common'; @@ -15,6 +15,7 @@ import { BlockCls, IMaterialFramedData } from '@user/client-base'; import { ITexture, ITextureSplitter, TextureRowSplitter } from '@motajs/render'; import { IMapHeroRenderer } from './types'; import { TimingFn } from 'mutate-animate'; +import { state } from '@user/data-state'; /** 默认的移动时长 */ const DEFAULT_TIME = 100; diff --git a/packages-user/client-modules/src/render/map/extension/manager.ts b/packages-user/client-modules/src/render/map/extension/manager.ts index 41c6481..4a01b30 100644 --- a/packages-user/client-modules/src/render/map/extension/manager.ts +++ b/packages-user/client-modules/src/render/map/extension/manager.ts @@ -1,5 +1,5 @@ import { IHeroMover } from '@user/data-base'; -import { IMapLayer } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { IMapDoorRenderer, IMapExtensionManager, diff --git a/packages-user/client-modules/src/render/map/extension/types.ts b/packages-user/client-modules/src/render/map/extension/types.ts index 82577d0..bd685cc 100644 --- a/packages-user/client-modules/src/render/map/extension/types.ts +++ b/packages-user/client-modules/src/render/map/extension/types.ts @@ -4,7 +4,7 @@ import { HeroAnimateDirection, IHeroMover } from '@user/data-base'; -import { IMapLayer } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { IMapRenderResult } from '../types'; diff --git a/packages-user/client-modules/src/render/map/moving.ts b/packages-user/client-modules/src/render/map/moving.ts index 8c89b9b..ea464cb 100644 --- a/packages-user/client-modules/src/render/map/moving.ts +++ b/packages-user/client-modules/src/render/map/moving.ts @@ -2,7 +2,7 @@ import { linear, TimingFn } from 'mutate-animate'; import { IMapRenderer, IMapVertexGenerator, IMovingBlock } from './types'; import { IMaterialFramedData, IMaterialManager } from '@user/client-base'; import { logger } from '@motajs/common'; -import { IMapLayer } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { DynamicBlockStatus } from './status'; export interface IMovingRenderer { diff --git a/packages-user/client-modules/src/render/map/renderer.ts b/packages-user/client-modules/src/render/map/renderer.ts index df54f0d..6292c82 100644 --- a/packages-user/client-modules/src/render/map/renderer.ts +++ b/packages-user/client-modules/src/render/map/renderer.ts @@ -30,7 +30,7 @@ import { MapTileBehavior, MapTileSizeTestMode } from './types'; -import { ILayerState, ILayerStateHooks, IMapLayer } from '@user/data-state'; +import { ILayerState, ILayerStateHooks, IMapLayer } from '@user/data-base'; import { IHookController, logger } from '@motajs/common'; import { compileProgramWith } from '@motajs/client-base'; import { isNil, maxBy } from 'lodash-es'; diff --git a/packages-user/client-modules/src/render/map/status.ts b/packages-user/client-modules/src/render/map/status.ts index 922b14b..979abaa 100644 --- a/packages-user/client-modules/src/render/map/status.ts +++ b/packages-user/client-modules/src/render/map/status.ts @@ -1,4 +1,4 @@ -import { IMapLayer } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { IBlockStatus, IMapVertexStatus } from './types'; export class StaticBlockStatus implements IBlockStatus { diff --git a/packages-user/client-modules/src/render/map/types.ts b/packages-user/client-modules/src/render/map/types.ts index 8b93aa0..438586c 100644 --- a/packages-user/client-modules/src/render/map/types.ts +++ b/packages-user/client-modules/src/render/map/types.ts @@ -10,7 +10,7 @@ import { IMaterialManager, ITrackedAssetData } from '@user/client-base'; -import { ILayerState, IMapLayer } from '@user/data-state'; +import { ILayerState, IMapLayer } from '@user/data-base'; import { TimingFn } from 'mutate-animate'; export const enum MapBackgroundRepeat { diff --git a/packages-user/client-modules/src/render/map/vertex.ts b/packages-user/client-modules/src/render/map/vertex.ts index e9bb9a5..a8ca1af 100644 --- a/packages-user/client-modules/src/render/map/vertex.ts +++ b/packages-user/client-modules/src/render/map/vertex.ts @@ -1,4 +1,4 @@ -import { IMapLayer } from '@user/data-state'; +import { IMapLayer } from '@user/data-base'; import { IBlockData, IBlockSplitter, diff --git a/packages-user/data-base/src/enemy/manager.ts b/packages-user/data-base/src/enemy/manager.ts index 210f601..915bd56 100644 --- a/packages-user/data-base/src/enemy/manager.ts +++ b/packages-user/data-base/src/enemy/manager.ts @@ -24,6 +24,10 @@ export class EnemyManager implements IEnemyManager { private readonly prefabById: Map> = new Map(); /** 旧样板怪物 id 到 code 的映射,用于 fromLegacyEnemy 快速查找已有模板 */ private readonly legacyIdToCode: Map = new Map(); + /** 复用映射,reusedCode -> sourceCode */ + private readonly reuseByCode: Map = new Map(); + /** 复用映射,reusedId -> sourceId */ + private readonly reuseById: Map = new Map(); /** 脏模板集合,存储发生了变化的模板 code */ private readonly dirtySet: Set = new Set(); /** 参考快照,code -> IReadonlyEnemy,由 compareWith 提供 */ @@ -124,9 +128,11 @@ export class EnemyManager implements IEnemyManager { private internalGetPrefab(code: number | string) { if (typeof code === 'number') { - return this.prefabByCode.get(code) ?? null; + const sourceCode = this.reuseByCode.get(code) ?? code; + return this.prefabByCode.get(sourceCode) ?? null; } else { - return this.prefabById.get(code) ?? null; + const sourceId = this.reuseById.get(code) ?? code; + return this.prefabById.get(sourceId) ?? null; } } @@ -155,11 +161,13 @@ export class EnemyManager implements IEnemyManager { } getPrefab(code: number): IReadonlyEnemy | null { - return this.prefabByCode.get(code) ?? null; + const sourceCode = this.reuseByCode.get(code) ?? code; + return this.prefabByCode.get(sourceCode) ?? null; } getPrefabById(id: string): IReadonlyEnemy | null { - return this.prefabById.get(id) ?? null; + const sourceId = this.reuseById.get(id) ?? id; + return this.prefabById.get(sourceId) ?? null; } deletePrefab(code: number | string): void { @@ -181,8 +189,8 @@ export class EnemyManager implements IEnemyManager { reusePrefab(source: number | string, code: number, id: string): void { const prefab = this.internalGetPrefab(source); if (!prefab) return; - this.prefabByCode.set(code, prefab); - this.prefabById.set(id, prefab); + this.reuseByCode.set(code, prefab.code); + this.reuseById.set(id, prefab.id); } compareWith(reference: ReadonlyMap>): void { diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 47135f2..d1eaa10 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -22,7 +22,8 @@ import { FaceDirection, ISaveableContent, IStateSaveData, - SaveCompression + SaveCompression, + IReadonlyEnemy } from '@user/data-base'; import { IEnemyAttr } from './enemy'; import { @@ -42,6 +43,7 @@ import { isNil } from 'lodash-es'; import { logger } from '@motajs/common'; import { ISaveSystem } from './save'; import { SaveSystem } from './save/system'; +import { MainEnemyComparer } from './enemy/comparer'; export class CoreState implements ICoreState { // 全局内容 @@ -92,7 +94,9 @@ export class CoreState implements ICoreState { //#region 怪物初始化 // 怪物管理器初始化 + const comparer = new MainEnemyComparer(); const enemyManager = new EnemyManager(new EnemyLegacyBridge()); + enemyManager.attachEnemyComparer(comparer); enemyManager.setAttributeDefaults('hp', 0); enemyManager.setAttributeDefaults('atk', 0); enemyManager.setAttributeDefaults('def', 0); @@ -159,6 +163,7 @@ export class CoreState implements ICoreState { private initEnemyManager(data: Record) { // TODO: 修改怪物模板并存入存档,即 core.setEnemy const manager = this.enemyManager; + const reference = new Map>(); for (const [id, enemy] of Object.entries(structuredClone(data))) { const num = this.idNumberMap.get(id); if (isNil(num)) continue; @@ -169,7 +174,9 @@ export class CoreState implements ICoreState { const upCode = this.idNumberMap.get(up)!; const rightCode = this.idNumberMap.get(right)!; const downCode = this.idNumberMap.get(down)!; - manager.addPrefabFromLegacy(downCode, enemy); + const prefab = manager.fromLegacyEnemy(downCode, enemy); + reference.set(downCode, prefab); + manager.addPrefab(prefab); this.roleFace.malloc(downCode, FaceDirection.Down); this.roleFace.bind(leftCode, downCode, FaceDirection.Left); this.roleFace.bind(upCode, downCode, FaceDirection.Up); @@ -178,9 +185,12 @@ export class CoreState implements ICoreState { manager.reusePrefab(num, upCode, up); manager.reusePrefab(num, rightCode, right); } else { - manager.addPrefabFromLegacy(num, enemy); + const prefab = manager.fromLegacyEnemy(num, enemy); + reference.set(num, prefab); + manager.addPrefab(prefab); } } + manager.compareWith(reference); } addSaveableContent(id: string, content: ISaveableContent): void { diff --git a/packages-user/data-state/src/enemy/comparer.ts b/packages-user/data-state/src/enemy/comparer.ts new file mode 100644 index 0000000..a04bef7 --- /dev/null +++ b/packages-user/data-state/src/enemy/comparer.ts @@ -0,0 +1,31 @@ +import { IEnemyComparer, IReadonlyEnemy } from '@user/data-base'; +import { IEnemyAttr } from './types'; + +export class MainEnemyComparer implements IEnemyComparer { + compare( + enemyA: IReadonlyEnemy, + enemyB: IReadonlyEnemy + ): boolean { + // 比较基本属性 + if ( + enemyA.getAttribute('hp') !== enemyB.getAttribute('hp') || + enemyA.getAttribute('atk') !== enemyB.getAttribute('atk') || + enemyA.getAttribute('def') !== enemyB.getAttribute('def') || + enemyA.getAttribute('money') !== enemyB.getAttribute('money') || + enemyA.getAttribute('exp') !== enemyB.getAttribute('exp') || + enemyA.getAttribute('point') !== enemyB.getAttribute('point') + ) { + return false; + } + + // 比较特殊属性 + const specialsA = [...enemyA.iterateSpecials()]; + const specialsB = [...enemyB.iterateSpecials()]; + if (specialsA.length !== specialsB.length) return false; + for (const special of specialsA) { + const other = enemyB.getSpecial(special.code); + if (!other || !special.deepEqualsTo(other)) return false; + } + return true; + } +} diff --git a/packages-user/data-state/src/legacy/move.ts b/packages-user/data-state/src/legacy/move.ts index 51e4509..48c3aa3 100644 --- a/packages-user/data-state/src/legacy/move.ts +++ b/packages-user/data-state/src/legacy/move.ts @@ -1,10 +1,9 @@ import EventEmitter from 'eventemitter3'; import { backDir, toDir } from './utils'; -import { loading } from '@user/data-base'; -import type { RenderAdapter } from '@motajs/render'; +import { fromDirectionString, loading } from '@user/data-base'; import type { HeroKeyMover } from '@user/client-modules'; import { sleep } from '@motajs/common'; -import { fromDirectionString, state } from '..'; +import { state } from '..'; // todo: 转身功能 diff --git a/packages-user/legacy-plugin-data/src/fallback.ts b/packages-user/legacy-plugin-data/src/fallback.ts index 8519db7..1271d38 100644 --- a/packages-user/legacy-plugin-data/src/fallback.ts +++ b/packages-user/legacy-plugin-data/src/fallback.ts @@ -1,11 +1,6 @@ import type { TimingFn } from 'mutate-animate'; -import { - fromDirectionString, - heroMoveCollection, - MoveStep, - state -} from '@user/data-state'; -import { hook, loading } from '@user/data-base'; +import { heroMoveCollection, MoveStep, state } from '@user/data-state'; +import { fromDirectionString, hook, loading } from '@user/data-base'; import { Patch, PatchClass } from '@motajs/legacy-common'; import { isNil } from 'lodash-es'; @@ -59,8 +54,6 @@ export function initFallback() { Mota.r(() => { // ----- 引入 - const { mainRenderer } = Mota.require('@user/client-modules'); - const Animation = Mota.require('MutateAnimate'); const patch = new Patch(PatchClass.Control); const patch2 = new Patch(PatchClass.Events); diff --git a/packages/legacy-ui/src/tools/fixed.ts b/packages/legacy-ui/src/tools/fixed.ts index 2383108..ba05235 100644 --- a/packages/legacy-ui/src/tools/fixed.ts +++ b/packages/legacy-ui/src/tools/fixed.ts @@ -29,8 +29,10 @@ export function getDetailedEnemy( return typeof func === 'string' ? func : func(enemy); }; const special: [string, string, string][] = [...enemy.info.special] + // @ts-expect-error 之后修 .filter(v => !enemy.info.specialHalo?.includes(v)) .map(vv => { + // @ts-expect-error 之后修 const s = Mota.require('@user/data-state').specials[vv]; return [ fromFunc(s.name, enemy.info), From 70a58ef4dc755b5fcf745740dbae01ddee80b8a1 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 26 Apr 2026 13:33:49 +0800 Subject: [PATCH 05/26] =?UTF-8?q?refactor:=20=E5=9C=B0=E5=9B=BE=E5=AD=98?= =?UTF-8?q?=E5=82=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot --- docs/dev/map-store-save.md | 294 ++++++++++++++ packages-user/data-base/src/enemy/manager.ts | 2 +- packages-user/data-base/src/map/index.ts | 1 + packages-user/data-base/src/map/layerState.ts | 21 + packages-user/data-base/src/map/mapLayer.ts | 33 +- packages-user/data-base/src/map/mapStore.ts | 383 ++++++++++++++++++ packages-user/data-base/src/map/types.ts | 124 +++++- packages-user/data-base/src/types.ts | 4 +- packages/common/src/logger.json | 5 + 9 files changed, 853 insertions(+), 14 deletions(-) create mode 100644 docs/dev/map-store-save.md create mode 100644 packages-user/data-base/src/map/mapStore.ts diff --git a/docs/dev/map-store-save.md b/docs/dev/map-store-save.md new file mode 100644 index 0000000..fdc8c05 --- /dev/null +++ b/docs/dev/map-store-save.md @@ -0,0 +1,294 @@ +# 需求综述 + +当前 `LayerState` 只存储当前激活地图的数据,切换地图时原地图内容彻底丢失, +无法参与存档系统。为此引入 `IMapStore`,集中管理所有楼层的 `LayerState`, +并实现 `ISaveableContent` 接口以支持存档读档。 + +核心目标: + +- 多楼层数据同时存在于内存中,通过 id 访问; +- 通过 `active` 标记区分"玩家可能到达"与"无需关注"的楼层,节省存档开销; +- 通过 `compareWith` 提供参考基准,配合分级压缩大幅减少存档体积; +- `IStateBase.layer` 类型由 `ILayerState` 改为 `IMapStore`, + 操作楼层必须先通过 `getLayerState(id)` 取得具体楼层。 + +--- + +# 实现思路 + +## 1. 给 LayerState 添加 active 成员 + +`ILayerState` 新增 `readonly active: boolean` 和 `setActiveStatus(active: boolean): void` +两个接口,`LayerState` 实现类中 `active` 默认为 `false`。 + +两者的关系: + +- `ILayerState.setActiveStatus`:直接操作楼层对象; +- `IMapStore.setMapActiveStatus(id, active)`:通过 id 操作, + 内部查找对应楼层后调用其 `setActiveStatus`。 + +## 2. 脏数据追踪(dirty tracking) + +为支持 `LowCompression` 和 `HighCompression` 的差分存档, +需要知道哪些楼层相对于参考基准是否发生了修改。 + +**推荐方案:楼层级简单脏标记 + 存档时实际比较** + +在 `LayerState` 内部维护 `private dirty: boolean = false`: + +- 当楼层内任意 `MapLayer` 触发 `onUpdateBlock`、`onUpdateArea`、`onResize` + 钩子时,将 `dirty` 置为 `true`; +- `dirty` 只在 `compareWith` 首次调用时根据实际数据对比结果初始化, + 初始化后的 gameplay 过程中不再重置(仅置 true)。 + +在 `saveState` 时: + +- 若 `dirty = false`,跳过该楼层(初始化后从未被触碰过); +- 若 `dirty = true`: + - **LowCompression**:与参考基准进行全量比较,若完全一致则跳过 + (消除"改了又改回"场景下的误判),否则存储所有行; + - **HighCompression**:逐行与参考基准比较,只存储不一致的行。 + +在 `loadState` 时:若存档中此楼层没有任何数据(即未出现在 `floors` 中), +读档后将 `dirty` 置为 `false`(视为与参考基准一致)。 + +**不在 `MapLayer` 内维护 `dirtyRows`**,行级比较在 `saveState` 时直接对照参考基准进行。 +这避免了每次 `setBlock`/`putMapData` 都更新行级标记的热路径开销, +且存档时实际比较已能消除误判,无需 `probablyDirty` + `setInterval` 或哈希方案。 + +存档时比较的开销:Uint32Array 内存连续,实际耗时极低,且保存操作本身是低频的, +若将来发现存档耗时问题,可考虑将比较逻辑移至 Web Worker。 + +## 3. compareWith 接口与参数类型 + +```ts +compareWith(ref: Map>): void; +``` + +外层 `Map` 以楼层 id 为键,内层 `Map` 以图层 `zIndex` 为键, +值为对应图层的完整图块数组(Uint32Array,含所有行的扁平数据)。 + +使用此类型而非 `IMapStore` 的理由:接口更轻量,调用方可直接从游戏原始数据构建, +无需额外持有一个完整的 `IMapStore` 实例。 + +关于图层标识符:继续使用 `zIndex`,在单个楼层内 `zIndex` 是语义唯一的, +与已有 `MapLayer.zIndex` 接口保持一致。 + +**`compareWith` 以首次调用为唯一基准**,再次调用不更新参考(以游戏原始数据为基准, +避免存档之间产生依赖关系)。 + +实现步骤: + +1. 若 `refData` 已存在,直接返回; +2. 保存 `ref` 引用到 `private refData`; +3. 遍历当前所有楼层,对每个楼层在 `ref` 中查找对应 id: + - 不存在:`dirty = true`(新楼层,视为全脏); + - 存在:对每个 `MapLayer`(按 `zIndex` 匹配)做全量比较, + 若所有行与参考数据完全一致则 `dirty = false`,否则 `dirty = true`。 + +## 4. 楼层的创建与管理 + +`MapStore` 内部以 `Map` 存储所有楼层。 +`getLayerState(id)` 对不存在的 id 直接返回 `null`,不自动创建。 + +只提供一个创建接口: + +- `createLayerState(id: string): ILayerState`:创建并注册一个空白楼层 + (无任何 `MapLayer`,用户拿到后再调用 `addLayer` 配置图层结构),返回楼层对象。 + +注册时若 id 已存在,发出 logger 警告并覆盖。 + +若 `compareWith` 已调用后再通过上述接口新增楼层,新楼层直接视为全脏(`dirty = true`), +因为 `refData` 中不存在对应数据。 + +## 5. 存档数据格式 + +### 类型定义 + +```ts +/** 单个 MapLayer 的存档数据 */ +interface IMapLayerSave { + readonly width: number; + readonly height: number; + /** + * key = 行索引,value = 该行完整的 Uint32Array 数据; + * NoCompression/LowCompression 时包含所有行(0 到 height - 1); + * HighCompression 时只包含与参考基准不同的行; + * 读档时,不在此 Map 中的行从参考基准还原。 + */ + readonly rows: ReadonlyMap; +} + +/** 单个楼层的存档数据 */ +interface ILayerStateSave { + readonly background: number; + /** + * key = zIndex,value = 对应图层存档数据; + * 使用 Map 格式以支持图层的动态增删。 + */ + readonly layers: ReadonlyMap; +} + +/** 整个 MapStore 的存档数据 */ +interface IMapStoreSave { + /** + * key = 楼层 id,只包含 active 的楼层; + * inactive 的楼层不写入,读档时无需处理。 + */ + readonly floors: ReadonlyMap; +} +``` + +### 各压缩等级存储策略 + +| 压缩级别 | 楼层粒度 | 行粒度 | +| ----------------- | --------------------------------------------------------------- | ------------------------ | +| `NoCompression` | 存储所有 active 楼层 | 存储该楼层所有行 | +| `LowCompression` | 跳过 `dirty = false` 的楼层;dirty 楼层全量比较后仍一致的也跳过 | 存储该楼层所有行 | +| `HighCompression` | 同 LowCompression | 只存储与参考基准不同的行 | + +### 读档策略 + +读档时直接操作数组引用(通过 `setMapRef`),避免逐行拷贝的额外开销: + +1. 若参考基准(`refData`)未设置,抛出 logger 错误,**不进行任何读档操作**; +2. 遍历 `state.floors`,对每个楼层 id: + - 若当前 `MapStore` 中不存在该 id,发出 logger 警告并跳过; + - 对该楼层每个图层,先从参考基准取出对应 `zIndex` 的数组, + 将其深拷贝为新数组作为底层(确保未存档行使用参考基准值); + - 再将 `ILayerStateSave.layers` 中对应图层的 `rows` 数据写入该数组的对应行; + - 调用 `MapLayer.setMapRef(array)` 直接替换内部引用,无需额外拷贝; +3. 对未出现在 `state.floors` 中的 active 楼层, + 从参考基准深拷贝完整数组后调用 `setMapRef` 还原,并将 `dirty` 置为 `false`。 + +## 6. saveState / loadState 实现 + +根据压缩等级分别编写三个存档函数和三个读档函数, +`saveState(compression)` 和 `loadState(state, compression)` 根据 `compression` 分发, +无需在每个楼层的遍历循环内部判断等级: + +- `private saveNoCompression(): IMapStoreSave` +- `private saveLowCompression(): IMapStoreSave` +- `private saveHighCompression(): IMapStoreSave` +- `private loadNoCompression(state: IMapStoreSave): void` +- `private loadLowCompression(state: IMapStoreSave): void` +- `private loadHighCompression(state: IMapStoreSave): void` + +`saveState` 结果需通过 `structuredClone` 深拷贝后返回。 + +## 7. IMapStore 接口设计(新增到 `map/types.ts`) + +```ts +interface IMapStore extends ISaveableContent { + /** 所有楼层的 id 集合 */ + readonly maps: ReadonlySet; + + // --- 楼层访问 --- + /** 获取指定 id 的楼层状态,不存在则返回 null */ + getLayerState(id: string): ILayerState | null; + /** 获取指定 id 的楼层状态,要求楼层必须是 active 的,否则返回 null */ + getActiveMap(id: string): ILayerState | null; + + // --- 楼层管理 --- + /** 创建并注册一个空白楼层,返回楼层状态对象 */ + createLayerState(id: string): ILayerState; + + // --- active 管理 --- + /** 获取指定 id 的楼层是否激活,不存在的 id 返回 false */ + isMapActive(id: string): boolean; + /** 设置指定 id 楼层的激活状态 */ + setMapActiveStatus(id: string, active: boolean): void; + /** 迭代所有 active 的楼层,yield [id, ILayerState] */ + iterateActiveMaps(): Iterable<[string, ILayerState]>; + /** 迭代所有 inactive 的楼层,yield [id, ILayerState] */ + iterateInactiveMaps(): Iterable<[string, ILayerState]>; + /** 迭代所有楼层,yield [id, ILayerState] */ + iterateAllMaps(): Iterable<[string, ILayerState]>; + + // --- 差分压缩基准 --- + /** + * 设置压缩参考基准,以首次调用为唯一基准,再次调用不更新。 + * @param ref 外层 key = 楼层 id,内层 key = zIndex,value = 图层完整图块数据 + */ + compareWith(ref: Map>): void; +} +``` + +## 8. ILayerState 接口修改 + +在现有 `ILayerState` 上新增: + +```ts +/** 此楼层是否处于激活状态 */ +readonly active: boolean; +/** 设置楼层激活状态 */ +setActiveStatus(active: boolean): void; +``` + +## 9. IStateBase 修改 + +将 `IStateBase.layer: ILayerState` 改为 `IStateBase.layer: IMapStore`。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `@user/common/types.ts`: `ISaveableContent`, `SaveCompression` +- `@user/data-base/map/types.ts`: 全部现有地图接口(`IMapLayer`, `ILayerState`, 等) + +## 需要修改的文件 + +### `@user/data-base/src/map/types.ts` + +- [ ] 新增 `IMapLayerSave` 接口:单个 MapLayer 存档数据格式 +- [ ] 新增 `ILayerStateSave` 接口:单个楼层存档数据格式 +- [ ] 新增 `IMapStoreSave` 接口:MapStore 整体存档数据格式 +- [ ] 修改 `ILayerState`:新增 `readonly active: boolean` 和 + `setActiveStatus(active: boolean): void` +- [ ] 修改 `IMapLayer`:新增 `setMapRef(array: Uint32Array): void` +- [ ] 新增 `IMapStore` 接口:继承 `ISaveableContent`, + 含全部接口(见第 7 节) + +### `@user/data-base/src/map/mapLayer.ts` + +### `@user/data-base/src/map/layerState.ts` + +- [ ] 新增 `active: boolean = false` 成员:楼层激活状态 +- [ ] 实现 `setActiveStatus(active: boolean): void` +- [ ] 新增 `private dirty: boolean = false` 成员:楼层级脏标记 +- [ ] 修改 `StateMapLayerHook.onUpdateArea`、`onUpdateBlock`、`onResize`: + 在转发钩子的同时,将 `state.dirty` 置 `true` +- [ ] 新增 `isDirty(): boolean` 方法:返回 `this.dirty`,供 `MapStore` 读取 +- [ ] 新增 `setDirty(dirty: boolean): void` 方法: + 供 `MapStore.compareWith` 时根据实际比较结果设置 + +### `@user/data-base/src/map/mapLayer.ts` + +- [ ] 新增 `setMapRef(array: Uint32Array): void` 方法: + 直接替换内部图块数组引用,跳过拷贝,供 `MapStore` 读档时使用。 + 需确保传入数组长度与 `width × height` 匹配, + 并触发必要的钩子通知(不触发 `onResize`,应触发 `onUpdateArea` 通知全区域更新)。 + 在方法注释中明确标注:调用后不得再持有或修改传入的数组。 + +### `@user/data-base/src/map/mapStore.ts`(新文件) + +- [ ] 实现 `MapStore` 类,实现 `IMapStore` +- [ ] `private mapData: Map`:楼层 id 到状态对象的映射 +- [ ] `readonly maps: ReadonlySet`:所有楼层 id 的只读集合视图 +- [ ] `private refData: Map> | null`:参考基准 +- [ ] 实现 `getLayerState`、`getActiveMap`、`createLayerState` +- [ ] 实现 `isMapActive`、`setMapActiveStatus`、`iterateActiveMaps`、`iterateInactiveMaps`、`iterateAllMaps` +- [ ] 实现 `compareWith` +- [ ] 实现 `saveNoCompression`、`saveLowCompression`、`saveHighCompression` +- [ ] 实现 `loadNoCompression`、`loadLowCompression`、`loadHighCompression` +- [ ] 实现 `saveState(compression)` 和 `loadState(state, compression)` 分发 + +### `@user/data-base/src/map/index.ts` + +- [ ] 补充导出 `mapStore.ts` + +### `@user/data-base/src/types.ts` + +- [ ] 将 `IStateBase.layer` 类型由 `ILayerState` 改为 `IMapStore` diff --git a/packages-user/data-base/src/enemy/manager.ts b/packages-user/data-base/src/enemy/manager.ts index 915bd56..b3ad7c1 100644 --- a/packages-user/data-base/src/enemy/manager.ts +++ b/packages-user/data-base/src/enemy/manager.ts @@ -10,7 +10,7 @@ import { SpecialCreation, IEnemySaveState } from './types'; -import { SaveCompression } from '../common/types'; +import { SaveCompression } from '../common'; export class EnemyManager implements IEnemyManager { /** 特殊属性注册表,code -> 创建函数 */ diff --git a/packages-user/data-base/src/map/index.ts b/packages-user/data-base/src/map/index.ts index 1f9d7d5..8a6081a 100644 --- a/packages-user/data-base/src/map/index.ts +++ b/packages-user/data-base/src/map/index.ts @@ -1,3 +1,4 @@ export * from './layerState'; export * from './mapLayer'; +export * from './mapStore'; export * from './types'; diff --git a/packages-user/data-base/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts index d6c8d24..37f4359 100644 --- a/packages-user/data-base/src/map/layerState.ts +++ b/packages-user/data-base/src/map/layerState.ts @@ -29,6 +29,12 @@ export class LayerState /** 图层钩子映射 */ private layerHookMap: Map = new Map(); + /** 楼层是否处于激活状态 */ + active: boolean = false; + + /** 楼层级脏标记 */ + private dirty: boolean = false; + addLayer(width: number, height: number): IMapLayer { const array = new Uint32Array(width * height); const layer = new MapLayer(array, width, height); @@ -106,6 +112,18 @@ export class LayerState return this.backgroundTile; } + setActiveStatus(active: boolean): void { + this.active = active; + } + + isDirty(): boolean { + return this.dirty; + } + + setDirty(dirty: boolean): void { + this.dirty = dirty; + } + protected createController( hook: Partial ): IHookController { @@ -120,18 +138,21 @@ class StateMapLayerHook implements Partial { ) {} onUpdateArea(x: number, y: number, width: number, height: number): void { + this.state.setDirty(true); this.state.forEachHook(hook => { hook.onUpdateLayerArea?.(this.layer, x, y, width, height); }); } onUpdateBlock(block: number, x: number, y: number): void { + this.state.setDirty(true); this.state.forEachHook(hook => { hook.onUpdateLayerBlock?.(this.layer, block, x, y); }); } onResize(width: number, height: number): void { + this.state.setDirty(true); this.state.forEachHook(hook => { hook.onResizeLayer?.(this.layer, width, height); }); diff --git a/packages-user/data-base/src/map/mapLayer.ts b/packages-user/data-base/src/map/mapLayer.ts index a1a7879..326c4cf 100644 --- a/packages-user/data-base/src/map/mapLayer.ts +++ b/packages-user/data-base/src/map/mapLayer.ts @@ -186,14 +186,12 @@ export class MapLayer } const res = new Uint32Array(width * height); const arr = this.mapArray; - const nr = Math.min(r, w); const nb = Math.min(b, h); - for (let nx = x; nx < nr; nx++) { - for (let ny = y; ny < nb; ny++) { - const origin = ny * w + nx; - const target = (ny - y) * width + (nx - x); - res[target] = arr[origin]; - } + for (let ny = y; ny < nb; ny++) { + const lineStart = ny * w + x; + const lineEnd = lineStart + width; + const dy = ny - y; + res.set(arr.subarray(lineStart, lineEnd), dy * width); } return res; } @@ -205,6 +203,27 @@ export class MapLayer return this.mapData; } + setMapRef(array: Uint32Array): void { + if (array.length !== this.width * this.height) { + logger.warn( + 123, + array.length.toString(), + (this.width * this.height).toString() + ); + return; + } + this.mapData.expired = true; + this.mapArray = array; + this.mapData = { + expired: false, + array: this.mapArray + }; + this.empty = !array.some(v => v !== 0); + this.forEachHook(hook => { + hook.onUpdateArea?.(0, 0, this.width, this.height); + }); + } + protected createController( hook: Partial ): IMapLayerHookController { diff --git a/packages-user/data-base/src/map/mapStore.ts b/packages-user/data-base/src/map/mapStore.ts new file mode 100644 index 0000000..19e1fe8 --- /dev/null +++ b/packages-user/data-base/src/map/mapStore.ts @@ -0,0 +1,383 @@ +import { logger } from '@motajs/common'; +import { SaveCompression } from '../common'; +import { + ILayerState, + ILayerStateSave, + IMapLayer, + IMapLayerSave, + IMapStore, + IMapStoreSave +} from './types'; +import { LayerState } from './layerState'; + +export class MapStore implements IMapStore { + /** 楼层 id 到状态对象的映射 */ + private readonly mapData: Map = new Map(); + + /** 所有楼层 id 的只读集合视图 */ + readonly maps: Set = new Set(); + + /** 差分压缩参考基准,首次 compareWith 后设置,之后不再更新 */ + private refData: Map> | null = null; + + //#region 楼层访问 + + getLayerState(id: string): ILayerState | null { + return this.mapData.get(id) ?? null; + } + + getActiveMap(id: string): ILayerState | null { + const state = this.mapData.get(id); + if (!state || !state.active) return null; + return state; + } + + //#endregion + + //#region 楼层管理 + + createLayerState(id: string): ILayerState { + if (this.mapData.has(id)) { + logger.warn(121, id); + } + const state = new LayerState(); + // 若 refData 已存在,新楼层直接视为全脏 + if (this.refData !== null) { + state.setDirty(true); + } + this.mapData.set(id, state); + this.maps.add(id); + return state; + } + + //#endregion + + //#region active 管理 + + isMapActive(id: string): boolean { + return this.mapData.get(id)?.active ?? false; + } + + setMapActiveStatus(id: string, active: boolean): void { + this.mapData.get(id)?.setActiveStatus(active); + } + + *iterateActiveMaps(): Iterable<[string, ILayerState]> { + for (const [id, state] of this.mapData) { + if (state.active) yield [id, state]; + } + } + + *iterateInactiveMaps(): Iterable<[string, ILayerState]> { + for (const [id, state] of this.mapData) { + if (!state.active) yield [id, state]; + } + } + + iterateAllMaps(): Iterable<[string, ILayerState]> { + return this.mapData; + } + + //#endregion + + //#region 存档及压缩 + + compareWith(ref: Map>): void { + if (this.refData !== null) return; + this.refData = ref; + + for (const [id, state] of this.mapData) { + const refFloor = ref.get(id); + if (!refFloor) { + state.setDirty(true); + continue; + } + let dirty = false; + for (const layer of state.layerList) { + const refArray = refFloor.get(layer.zIndex); + if (!refArray) { + dirty = true; + break; + } + const cur = layer.getMapRef().array; + if (cur.length !== refArray.length) { + dirty = true; + break; + } + if (cur.some((v, i) => refArray[i] !== v)) { + dirty = true; + break; + } + } + state.setDirty(dirty); + } + } + + private saveNoCompression(): IMapStoreSave { + const floors = new Map(); + for (const [id, state] of this.mapData) { + if (!state.active) continue; + floors.set(id, this.saveLayerStateFull(state)); + } + return { floors }; + } + + private saveLowCompression(): IMapStoreSave { + const floors = new Map(); + for (const [id, state] of this.mapData) { + if (!state.active) continue; + // 非 dirty 或 dirty 但与参考基准完全一致 → 空 layers(读档时从参考基准恢复) + if ( + !state.isDirty() || + (this.refData && this.isStateEqualToRef(id, state)) + ) { + floors.set(id, { + background: state.getBackground(), + layers: new Map() + }); + } else { + floors.set(id, this.saveLayerStateFull(state)); + } + } + return { floors }; + } + + private saveHighCompression(): IMapStoreSave { + const floors = new Map(); + for (const [id, state] of this.mapData) { + if (!state.active) continue; + if (!state.isDirty()) { + floors.set(id, { + background: state.getBackground(), + layers: new Map() + }); + continue; + } + const refFloor = this.refData?.get(id); + const layersMap = new Map(); + for (const layer of state.layerList) { + const refArray = refFloor?.get(layer.zIndex); + const rows = this.diffRows(layer, refArray); + if (rows.size === 0 && refArray) continue; // 与参考完全一致 + layersMap.set(layer.zIndex, { + width: layer.width, + height: layer.height, + rows + }); + } + floors.set(id, { + background: state.getBackground(), + layers: layersMap + }); + } + return { floors }; + } + + /** + * NoCompression 读档:每个图层均有 fullMap,直接转移所有权,无需参考基准。 + */ + private loadNoCompression(state: IMapStoreSave): void { + for (const [id, cur] of this.mapData) { + cur.setActiveStatus(state.floors.has(id)); + } + for (const [id, layerStateSave] of state.floors) { + const cur = this.mapData.get(id); + if (!cur) { + logger.warn(122, id); + continue; + } + cur.setBackground(layerStateSave.background); + for (const layer of cur.layerList) { + const layerSave = layerStateSave.layers.get(layer.zIndex); + if (!layerSave?.fullMap) continue; + layer.setMapRef(new Uint32Array(layerSave.fullMap)); + } + cur.setDirty(false); + } + } + + /** + * LowCompression 读档: + * - layers 有数据(dirty 楼层)→ fullMap 直接转移所有权 + * - layers 为空(非 dirty 楼层)→ 从参考基准恢复 + */ + private loadLowCompression(state: IMapStoreSave): void { + if (!this.refData) { + logger.error(55); + return; + } + for (const [id, cur] of this.mapData) { + cur.setActiveStatus(state.floors.has(id)); + } + for (const [id, layerStateSave] of state.floors) { + const cur = this.mapData.get(id); + const refFloor = this.refData.get(id); + if (!cur) { + logger.warn(122, id); + continue; + } + if (!refFloor) { + logger.warn(124, id); + continue; + } + cur.setBackground(layerStateSave.background); + for (const layer of cur.layerList) { + const layerSave = layerStateSave.layers.get(layer.zIndex); + if (layerSave?.fullMap) { + layer.setMapRef(layerSave.fullMap); + } else { + const refArray = refFloor?.get(layer.zIndex); + if (!refArray) { + logger.warn(124, id); + return; + } + layer.setMapRef(new Uint32Array(refArray)); + } + } + cur.setDirty(false); + } + } + + /** + * HighCompression 读档: + * - layers 有数据(dirty 楼层)→ 以参考基准为底,叠加差分行 + * - layers 为空(非 dirty 楼层)或图层无变化(rows 缺失)→ 从参考基准恢复 + */ + private loadHighCompression(state: IMapStoreSave): void { + if (!this.refData) { + logger.error(55); + return; + } + for (const [id, cur] of this.mapData) { + cur.setActiveStatus(state.floors.has(id)); + } + for (const [id, layerStateSave] of state.floors) { + const cur = this.mapData.get(id); + const refFloor = this.refData.get(id); + if (!cur) { + logger.warn(122, id); + continue; + } + if (!refFloor) { + logger.warn(124, id); + continue; + } + cur.setBackground(layerStateSave.background); + let isMapDirty = true; + for (const layer of cur.layerList) { + const refArray = refFloor.get(layer.zIndex); + if (!refArray) { + logger.warn(124, id); + continue; + } + const layerSave = layerStateSave.layers.get(layer.zIndex); + if (!layerSave?.rows || layerSave.rows.size === 0) { + // 图层无变化或非 dirty 楼层,从参考基准恢复 + layer.setMapRef(new Uint32Array(refArray)); + } else { + // 以参考基准为底,叠加差分行 + isMapDirty = false; + const size = layer.width * layer.height; + const buf = new Uint32Array(size); + if (refArray) buf.set(refArray.subarray(0, size)); + for (const [rowIdx, rowData] of layerSave.rows) { + buf.set( + rowData.subarray(0, layer.width), + rowIdx * layer.width + ); + } + layer.setMapRef(buf); + } + } + cur.setDirty(isMapDirty); + } + } + + saveState(compression: SaveCompression): IMapStoreSave { + if (compression === SaveCompression.HighCompression) { + return this.saveHighCompression(); + } else if (compression === SaveCompression.LowCompression) { + return this.saveLowCompression(); + } else { + return this.saveNoCompression(); + } + } + + loadState(state: IMapStoreSave, compression: SaveCompression): void { + if (compression === SaveCompression.HighCompression) { + this.loadHighCompression(state); + } else if (compression === SaveCompression.LowCompression) { + this.loadLowCompression(state); + } else { + this.loadNoCompression(state); + } + } + + //#region 内部方法 + + /** + * 将楼层所有图层全量序列化(NoCompression / LowCompression 用) + */ + private saveLayerStateFull(state: LayerState): ILayerStateSave { + const layersMap = new Map(); + for (const layer of state.layerList) { + const arr = layer.getMapRef().array; + layersMap.set(layer.zIndex, { + width: layer.width, + height: layer.height, + fullMap: new Uint32Array(arr) + }); + } + return { background: state.getBackground(), layers: layersMap }; + } + + /** + * 仅返回与参考基准不同的行(HighCompression 用) + */ + private diffRows( + layer: IMapLayer, + refArray?: Uint32Array + ): Map { + const rows = new Map(); + const arr = layer.getMapRef().array; + if (refArray) { + for (let row = 0; row < layer.height; row++) { + const start = row * layer.width; + const end = start + layer.width; + const slice = arr.subarray(start, end); + const refSlice = refArray.subarray(start, end); + const same = refSlice.every((v, i) => slice[i] === v); + if (!same) { + rows.set(row, new Uint32Array(slice)); + } + } + } else { + for (let row = 0; row < layer.height; row++) { + const start = row * layer.width; + const end = start + layer.width; + rows.set(row, new Uint32Array(arr.subarray(start, end))); + } + } + return rows; + } + + /** + * 判断楼层所有图层是否与参考基准完全一致(LowCompression 去误判用) + */ + private isStateEqualToRef(id: string, state: LayerState): boolean { + const refFloor = this.refData?.get(id); + if (!refFloor) return false; + for (const layer of state.layerList) { + const refArray = refFloor.get(layer.zIndex); + if (!refArray) return false; + const cur = layer.getMapRef().array; + if (cur.length !== refArray.length) return false; + for (let i = 0; i < cur.length; i++) { + if (cur[i] !== refArray[i]) return false; + } + } + return true; + } + + //#endregion +} diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index a702edb..7f959b3 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -1,4 +1,5 @@ import { IHookable, IHookBase, IHookController } from '@motajs/common'; +import { ISaveableContent } from '../common'; export interface IMapLayerData { /** 当前引用是否过期,当地图图层内部的地图数组引用更新时,此项会变为 `true` */ @@ -48,8 +49,7 @@ export interface IMapLayerHooks extends IHookBase { onCloseDoor(num: number, x: number, y: number): Promise; } -export interface IMapLayerHookController - extends IHookController { +export interface IMapLayerHookController extends IHookController { /** 拓展所属的图层对象 */ readonly layer: IMapLayer; @@ -59,8 +59,10 @@ export interface IMapLayerHookController getMapData(): Readonly; } -export interface IMapLayer - extends IHookable { +export interface IMapLayer extends IHookable< + IMapLayerHooks, + IMapLayerHookController +> { /** 地图宽度 */ readonly width: number; /** 地图高度 */ @@ -155,6 +157,15 @@ export interface IMapLayer * @param y 门纵坐标 */ closeDoor(num: number, x: number, y: number): Promise; + + /** + * 直接替换内部图块数组引用,跳过拷贝,高性能但风险较高。 + * 一般仅供 `MapStore` 读档时内部使用,外部正常情况下不应调用。 + * 调用方需确保传入数组的长度与 `width * height` 匹配, + * 且调用后不得再持有或修改传入的数组。 + * @param array 地图数组,会直接替换内部引用 + */ + setMapRef(array: Uint32Array): void; } export interface ILayerStateHooks extends IHookBase { @@ -212,6 +223,8 @@ export interface ILayerStateHooks extends IHookBase { export interface ILayerState extends IHookable { /** 地图列表 */ readonly layerList: Set; + /** 此楼层是否处于激活状态 */ + readonly active: boolean; /** * 添加图层 @@ -275,4 +288,107 @@ export interface ILayerState extends IHookable { * 获取背景图块数字,如果没有设置过,则返回 0 */ getBackground(): number; + + /** + * 设置楼层激活状态 + * @param active 激活状态 + */ + setActiveStatus(active: boolean): void; + + /** + * 楼层是否被修改过(相对于参考基准) + */ + isDirty(): boolean; + + /** + * 设置楼层脏标记 + */ + setDirty(dirty: boolean): void; +} + +/** 单个 MapLayer 的存档数据 */ +export interface IMapLayerSave { + readonly width: number; + readonly height: number; + + /** + * key = 行索引,value = 该行完整的 Uint32Array 数据; + * HighCompression 时使用此接口,仅包含与参考基准不同的行; + * 读档时,不在此 Map 中的行从参考基准还原。 + */ + readonly rows?: ReadonlyMap; + + /** 完整地图,当使用 `NoCompression` 和 `LowCompression` 时使用此接口 */ + readonly fullMap?: Uint32Array; +} + +/** 单个楼层的存档数据 */ +export interface ILayerStateSave { + readonly background: number; + + /** key = zIndex,value = 对应图层存档数据 */ + readonly layers: ReadonlyMap; +} + +/** 整个 MapStore 的存档数据 */ +export interface IMapStoreSave { + /** key = 楼层 id,只包含 active 的楼层,inactive 的楼层不写入,读档时无需处理 */ + readonly floors: ReadonlyMap; +} + +export interface IMapStore extends ISaveableContent { + /** 所有楼层的 id 集合 */ + readonly maps: ReadonlySet; + + /** + * 获取指定 id 的楼层状态,不存在则返回 null + * @param id 楼层 id + */ + getLayerState(id: string): ILayerState | null; + + /** + * 获取指定 id 的楼层状态,要求楼层必须是 active 的,否则返回 null + * @param id 楼层 id + */ + getActiveMap(id: string): ILayerState | null; + + /** + * 创建并注册一个空白楼层,若 id 已存在则警告并覆盖,返回楼层状态对象 + * @param id 楼层 id + */ + createLayerState(id: string): ILayerState; + + /** + * 获取指定 id 的楼层是否激活,不存在的 id 返回 false + * @param id 楼层 id + */ + isMapActive(id: string): boolean; + + /** + * 设置指定 id 楼层的激活状态 + * @param id 楼层 id + * @param active 激活状态 + */ + setMapActiveStatus(id: string, active: boolean): void; + + /** + * 迭代所有 active 的楼层,yield [id, ILayerState] + */ + iterateActiveMaps(): Iterable<[string, ILayerState]>; + + /** + * 迭代所有 inactive 的楼层,yield [id, ILayerState] + */ + iterateInactiveMaps(): Iterable<[string, ILayerState]>; + + /** + * 迭代所有楼层,yield [id, ILayerState] + */ + iterateAllMaps(): Iterable<[string, ILayerState]>; + + /** + * 设置压缩参考基准,以首次调用为唯一基准,再次调用不更新。 + * @param ref 外层 key = 楼层 id,内层 key = zIndex,value = 图层完整图块数据 + */ + compareWith(ref: Map>): void; } diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index bd52a39..9c4b160 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -2,7 +2,7 @@ import { IHeroFollower, IHeroState } from './hero'; import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; import { IRoleFaceBinder, ISaveableContent } from './common'; -import { ILayerState } from './map'; +import { IMapStore } from './map'; export interface IStateSaveData { /** 跟随者列表 */ @@ -18,7 +18,7 @@ export interface IStateBase { readonly numberIdMap: Map; /** 地图状态 */ - readonly layer: ILayerState; + readonly layer: IMapStore; /** 勇士状态 */ readonly hero: IHeroState; diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 2028acd..e9b8dcd 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -54,6 +54,7 @@ "52": "To get divider payload, an excitation binding is expected.", "53": "Expected serializable value set as enemy's default attribute.", "54": "Legacy '$1' API has been removed, consider using new APIs: '$2'.", + "55": "Cannot load MapStore state: reference data (compareWith) has not been set.", "1201": "Floor-damage extension needs 'floor-binder' extension as dependency." }, "warn": { @@ -177,6 +178,10 @@ "118": "No enemy comparer attached to EnemyManager. All enemies will be treated as dirty.", "119": "Enemy prefab with code $1 not found during loadState, skipping.", "120": "Special with code $1 not found in enemy '$2' during loadState, skipping.", + "121": "MapStore.createLayerState: floor '$1' already exists, the existing floor will be overwritten.", + "122": "MapStore.loadState: floor '$1' not found in current map data, skipping.", + "123": "MapLayer.setMapRef: array length $1 does not match expected size $2, setMapRef will be ignored.", + "124": "MapStore.loadState: floor '$1' or its layer(s) not found in current reference data, skipping.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } From c43bfa2ab0e7dcdd22285447609e68e566ebf5f5 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 26 Apr 2026 15:31:27 +0800 Subject: [PATCH 06/26] =?UTF-8?q?refactor:=20=E5=9C=B0=E5=9B=BE=E5=AD=98?= =?UTF-8?q?=E6=A1=A3=E7=9A=84=E5=8A=A0=E8=BD=BD=E9=80=82=E9=85=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/client-modules/src/client.ts | 4 +- .../client-modules/src/render/ui/main.tsx | 2 +- packages-user/data-base/src/types.ts | 2 +- packages-user/data-state/src/core.ts | 127 ++++++++++++++---- packages-user/data-state/src/enemy/index.ts | 1 + packages-user/data-state/src/index.ts | 18 --- packages-user/data-state/src/save/index.ts | 1 + packages-user/data-state/src/shared.ts | 17 +++ packages-user/data-state/src/types.ts | 3 +- .../legacy-plugin-data/src/fallback.ts | 8 +- 10 files changed, 130 insertions(+), 53 deletions(-) diff --git a/packages-user/client-modules/src/client.ts b/packages-user/client-modules/src/client.ts index 4a2945e..14b538a 100644 --- a/packages-user/client-modules/src/client.ts +++ b/packages-user/client-modules/src/client.ts @@ -114,7 +114,7 @@ export class ClientCore implements IClientCore { // 使用分频器,用户可以在设置中调整,如果设备性能较差调高分频有助于提高性能表现 excitaion: excitationDivider }); - this.mainMapRenderer = new MapRenderer(this.materials, data.layer); + this.mainMapRenderer = new MapRenderer(this.materials, data.maps); this.mainMapExtension = new MapExtensionManager(this.mainMapRenderer); // 兼容层 @@ -133,7 +133,7 @@ export class ClientCore implements IClientCore { await this.materials.trackedAsset.then(); this.mainMapRenderer.useAsset(this.materials.trackedAsset); - const layer = this.data.layer.getLayerByAlias('event'); + const layer = this.data.maps.getLayerByAlias('event'); if (layer) { this.mainMapExtension.addHero(this.data.hero.mover, layer); this.mainMapExtension.addDoor(layer); diff --git a/packages-user/client-modules/src/render/ui/main.tsx b/packages-user/client-modules/src/render/ui/main.tsx index 40a77a5..f46e26a 100644 --- a/packages-user/client-modules/src/render/ui/main.tsx +++ b/packages-user/client-modules/src/render/ui/main.tsx @@ -243,7 +243,7 @@ const MainScene = defineComponent(() => { > diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index 9c4b160..673f5f4 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -18,7 +18,7 @@ export interface IStateBase { readonly numberIdMap: Map; /** 地图状态 */ - readonly layer: IMapStore; + readonly maps: IMapStore; /** 勇士状态 */ readonly hero: IHeroState; diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index d1eaa10..4b3b325 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -16,16 +16,14 @@ import { MotaDataLoader, loading, IRoleFaceBinder, - ILayerState, - LayerState, RoleFaceBinder, FaceDirection, ISaveableContent, - IStateSaveData, SaveCompression, - IReadonlyEnemy + IReadonlyEnemy, + IMapStore, + MapStore } from '@user/data-base'; -import { IEnemyAttr } from './enemy'; import { CommonAuraConverter, EnemyLegacyBridge, @@ -34,16 +32,25 @@ import { MainEnemyFinalEffect, MainMapDamageConverter, MainMapDamageReducer, - registerSpecials + registerSpecials, + MainEnemyComparer, + IEnemyAttr } from './enemy'; -import { HERO_DEFAULT_ATTRIBUTE, TILE_HEIGHT, TILE_WIDTH } from './shared'; +import { + BG2_ZINDEX, + BG_ZINDEX, + EVENT_ZINDEX, + FG2_ZINDEX, + FG_ZINDEX, + HERO_DEFAULT_ATTRIBUTE, + TILE_HEIGHT, + TILE_WIDTH +} from './shared'; import { IHeroAttr } from './hero'; import { ILoadProgressTotal, LoadProgressTotal } from '@motajs/loader'; import { isNil } from 'lodash-es'; import { logger } from '@motajs/common'; -import { ISaveSystem } from './save'; -import { SaveSystem } from './save/system'; -import { MainEnemyComparer } from './enemy/comparer'; +import { ISaveSystem, SaveSystem } from './save'; export class CoreState implements ICoreState { // 全局内容 @@ -52,7 +59,7 @@ export class CoreState implements ICoreState { readonly numberIdMap: Map; // 可存档内容 - readonly layer: ILayerState; + readonly maps: IMapStore; readonly hero: IHeroState; readonly enemyManager: IEnemyManager; readonly flags: IFlagSystem; @@ -74,7 +81,7 @@ export class CoreState implements ICoreState { > = new Map(); constructor() { - this.layer = new LayerState(); + this.maps = new MapStore(); this.roleFace = new RoleFaceBinder(); this.idNumberMap = new Map(); this.numberIdMap = new Map(); @@ -149,9 +156,16 @@ export class CoreState implements ICoreState { // 加载先使用兼容层实现 loading.once('loaded', () => { this.initEnemyManager(enemys_fcae963b_31c9_42b4_b48c_bb48d09f3f80); + this.initMapStore( + core.floorIds, + core.floors as Record + ); }); - this.addSaveableContent('flags', this.flags); + this.addSaveableContent('@system/hero', this.hero); + this.addSaveableContent('@system/flags', this.flags); + this.addSaveableContent('@system/maps', this.maps); + this.addSaveableContent('@system/enemy', this.enemyManager); //#endregion } @@ -193,12 +207,86 @@ export class CoreState implements ICoreState { manager.compareWith(reference); } + private initMapStore( + floors: FloorIds[], + data: Record + ) { + const reference = new Map>(); + for (const id of floors) { + const floor = data[id]; + const state = this.maps.createLayerState(id); + const bg = state.addLayer(floor.width, floor.height); + const bg2 = state.addLayer(floor.width, floor.height); + const event = state.addLayer(floor.width, floor.height); + const fg = state.addLayer(floor.width, floor.height); + const fg2 = state.addLayer(floor.width, floor.height); + bg.setZIndex(BG_ZINDEX); + bg2.setZIndex(BG2_ZINDEX); + event.setZIndex(EVENT_ZINDEX); + fg.setZIndex(FG_ZINDEX); + fg2.setZIndex(FG2_ZINDEX); + state.setLayerAlias(bg, 'bg'); + state.setLayerAlias(bg2, 'bg2'); + state.setLayerAlias(event, 'event'); + state.setLayerAlias(fg, 'fg'); + state.setLayerAlias(fg2, 'fg2'); + state.setActiveStatus(false); + + const size = floor.width * floor.height; + const ref = new Map(); + + if (floor.bgmap && floor.bgmap.length > 0) { + const arr = new Uint32Array(floor.bgmap.flat()); + bg.setMapRef(arr); + ref.set(BG_ZINDEX, new Uint32Array(arr)); + } else { + ref.set(BG_ZINDEX, new Uint32Array(size)); + } + + if (floor.bg2map && floor.bg2map.length > 0) { + const arr = new Uint32Array(floor.bg2map.flat()); + bg2.setMapRef(arr); + ref.set(BG2_ZINDEX, new Uint32Array(arr)); + } else { + ref.set(BG2_ZINDEX, new Uint32Array(size)); + } + + if (floor.map && floor.map.length > 0) { + const arr = new Uint32Array(floor.map.flat()); + event.setMapRef(arr); + ref.set(EVENT_ZINDEX, new Uint32Array(arr)); + } else { + ref.set(EVENT_ZINDEX, new Uint32Array(size)); + } + + if (floor.fgmap && floor.fgmap.length > 0) { + const arr = new Uint32Array(floor.fgmap.flat()); + fg.setMapRef(arr); + ref.set(FG_ZINDEX, new Uint32Array(arr)); + } else { + ref.set(FG_ZINDEX, new Uint32Array(size)); + } + + if (floor.fg2map && floor.fg2map.length > 0) { + const arr = new Uint32Array(floor.fg2map.flat()); + fg2.setMapRef(arr); + ref.set(FG2_ZINDEX, new Uint32Array(arr)); + } else { + ref.set(FG2_ZINDEX, new Uint32Array(size)); + } + + reference.set(id, ref); + } + this.maps.compareWith(reference); + } + addSaveableContent(id: string, content: ISaveableContent): void { if (this.saveables.has(id)) { logger.warn(112, id); return; } this.saveables.set(id, content); + this.addedSaveables.add(content); } getSaveableContent(id: string): ISaveableContent | null { @@ -222,17 +310,4 @@ export class CoreState implements ICoreState { this.executors.set(content, executor); } } - - saveState(): IStateSaveData { - return structuredClone({ - followers: this.hero.mover.followers - }); - } - - loadState(data: IStateSaveData): void { - this.hero.mover.removeAllFollowers(); - data.followers.forEach(v => { - this.hero.mover.addFollower(v.num, v.identifier); - }); - } } diff --git a/packages-user/data-state/src/enemy/index.ts b/packages-user/data-state/src/enemy/index.ts index 5998ef6..ae9c5d4 100644 --- a/packages-user/data-state/src/enemy/index.ts +++ b/packages-user/data-state/src/enemy/index.ts @@ -1,5 +1,6 @@ export * from './aura'; export * from './calculator'; +export * from './comparer'; export * from './damage'; export * from './final'; export * from './legacy'; diff --git a/packages-user/data-state/src/index.ts b/packages-user/data-state/src/index.ts index bc01750..2cdc90c 100644 --- a/packages-user/data-state/src/index.ts +++ b/packages-user/data-state/src/index.ts @@ -1,27 +1,9 @@ import { FaceDirection, loading } from '@user/data-base'; import { isNil } from 'lodash-es'; import { ICoreState } from './types'; -import { TILE_HEIGHT, TILE_WIDTH } from './shared'; import { state } from './ins'; function createCoreState(state: ICoreState) { - //#region 地图部分 - - const width = TILE_WIDTH; - const height = TILE_HEIGHT; - const bg = state.layer.addLayer(width, height); - const bg2 = state.layer.addLayer(width, height); - const event = state.layer.addLayer(width, height); - const fg = state.layer.addLayer(width, height); - const fg2 = state.layer.addLayer(width, height); - state.layer.setLayerAlias(bg, 'bg'); - state.layer.setLayerAlias(bg2, 'bg2'); - state.layer.setLayerAlias(event, 'event'); - state.layer.setLayerAlias(fg, 'fg'); - state.layer.setLayerAlias(fg2, 'fg2'); - - //#endregion - //#region 图块部分 const data = Object.entries(core.maps.blocksInfo); diff --git a/packages-user/data-state/src/save/index.ts b/packages-user/data-state/src/save/index.ts index fcb073f..213e667 100644 --- a/packages-user/data-state/src/save/index.ts +++ b/packages-user/data-state/src/save/index.ts @@ -1 +1,2 @@ +export * from './system'; export * from './types'; diff --git a/packages-user/data-state/src/shared.ts b/packages-user/data-state/src/shared.ts index 33d5ebb..0f4b609 100644 --- a/packages-user/data-state/src/shared.ts +++ b/packages-user/data-state/src/shared.ts @@ -1,10 +1,27 @@ import { IHeroAttr } from './hero'; +//#region 地图相关 + /** 每个地图的默认宽度 */ export const TILE_WIDTH = 13; /** 每个地图的默认高度 */ export const TILE_HEIGHT = 13; +// 图层纵深,这些纵深与渲染系统的纵深没有关系,仅在地图图层之间生效 + +/** 背景层纵深 */ +export const BG_ZINDEX = 0; +/** 背景层2纵深 */ +export const BG2_ZINDEX = 10; +/** 事件层纵深 */ +export const EVENT_ZINDEX = 20; +/** 前景层纵深 */ +export const FG_ZINDEX = 30; +/** 前景层2纵深 */ +export const FG2_ZINDEX = 40; + +//#endregion + //#region 勇士相关 /** 默认的勇士图片 */ diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index 318816e..5ef2e96 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -30,7 +30,8 @@ export interface ICoreState extends IStateBase { readonly saveSystem: ISaveSystem; /** - * 将某个存档执行器绑定至指定的可存档对象,一个可存档对象只能绑定一个执行器,但一个执行器可以绑定多个可存档对象 + * 将某个存档执行器绑定至指定的可存档对象,一个可存档对象只能绑定一个执行器, + * 但一个执行器可以绑定多个可存档对象,主要用来在读档后进行一些全局性的操作 * @param content 可存档对象或其注册 id * @param executor 可存档对象对应的执行器 */ diff --git a/packages-user/legacy-plugin-data/src/fallback.ts b/packages-user/legacy-plugin-data/src/fallback.ts index 1271d38..4cb8edf 100644 --- a/packages-user/legacy-plugin-data/src/fallback.ts +++ b/packages-user/legacy-plugin-data/src/fallback.ts @@ -324,7 +324,7 @@ export function initFallback() { callback?.(); }; - const layer = state.layer.getLayerByAlias('event')!; + const layer = state.maps.getLayerByAlias('event')!; layer.openDoor(x, y).then(cb); const animate = fallbackIds++; @@ -373,7 +373,7 @@ export function initFallback() { cb(); } else { const num = state.idNumberMap.get(id)!; - const layer = state.layer.getLayerByAlias('event')!; + const layer = state.maps.getLayerByAlias('event')!; layer.closeDoor(num, x, y).then(cb); const animate = fallbackIds++; @@ -514,11 +514,11 @@ export function initFallback() { // 先使用 mainMapRenderer 妥协 const { client } = Mota.require('@user/client-modules'); const renderer = client.mainMapRenderer; - if (renderer.layerState !== state.layer) { + if (renderer.layerState !== state.maps) { callback?.(); return; } - const layer = state.layer.getLayerByAlias('event'); + const layer = state.maps.getLayerByAlias('event'); if (!layer) { callback?.(); return; From a01caba0c83070cfc8a556c6ffecc30f386e23ec Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Wed, 6 May 2026 19:46:54 +0800 Subject: [PATCH 07/26] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=E6=8F=90?= =?UTF-8?q?=E7=A4=BA=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Copilot --- dev.md | 126 ++++++++++++++++++++++++++++++++---------------------- prompt.md | 34 ++++++++------- 2 files changed, 92 insertions(+), 68 deletions(-) diff --git a/dev.md b/dev.md index 50b1504..19d9c08 100644 --- a/dev.md +++ b/dev.md @@ -2,12 +2,12 @@ ## 项目结构 -`public`: mota-js 样板所在目录。 -`packages`: 核心引擎代码 monorepo。 -`packages-user`: 用户代码 monorepo。 -`src`: 游戏入口代码。 +- `public`: mota-js 样板所在目录 +- `packages`: 核心引擎代码 monorepo +- `packages-user`: 用户代码 monorepo +- `src`: 游戏入口代码 -`packages` `packages-user` 可以单独打包为库模式,`src` 单向引用 `packages-user`,`packages-user` 单向引用 `packages`,`src` 为游戏的入口代码。 +依赖关系为单向:`src` → `packages-user` → `packages`。`packages` 与 `packages-user` 均可独立打包为库模式,`src` 为游戏的入口代码。 ## 开发环境 @@ -15,66 +15,88 @@ - `pnpm >= 10.0.0` - 任意支持 `ESNext` 特性的浏览器 -**建议使用 `vscode`,搭配 `prettier` `eslint` 插件** +**建议使用 `vscode`,搭配 `prettier` `eslint` 插件。** ## 开发说明 1. 将项目拉取到本地。 -2. 运行 `pnpm i` 安装所有依赖,如有要求运行 `pnpm approve-builds`,请允许全部。 +2. 运行 `pnpm i` 安装所有依赖(如提示运行 `pnpm approve-builds`,请允许全部)。 3. 运行 `pnpm dev` 进入开发环境。 ## 构建说明 -- `pnpm build:packages`: 构建所有 `packages` 文件夹下的内容,使用库模式。 -- `pnpm build:game`: 构建为可以直接部署的构建包。 -- `pnpm build:lib`: 构建所有 `packages` `packages-user` 文件夹下的内容,使用库模式。 -- `pnpm type`: 对仓库执行类型检查 -- `pnpm check:circular`: 对仓库执行循环引用检查 +| 命令 | 说明 | +| --------------------- | ------------------------------------------------------- | +| `pnpm build:packages` | 以库模式构建 `packages` 下的所有内容 | +| `pnpm build:game` | 构建为可直接部署的游戏包 | +| `pnpm build:lib` | 以库模式构建 `packages` 与 `packages-user` 下的所有内容 | +| `pnpm type` | 对仓库执行类型检查 | +| `pnpm check:circular` | 对仓库执行循环引用检查 | ## 开发原则 -- 模块原则: - - 无副作用原则:所有模块不包含副作用内容,全部由函数、类、常量的声明组成,不出现导出的变量声明、代码执行内容,允许但不建议编写类的静态块。 - - 如果需要模块初始化,编写一个 `createXxx` 函数,然后在 `index.ts` 中整合,再逐级向上传递,直至遇到包含 `create` 函数的 `index.ts`,所有初始化将会统一在顶层模块中执行。 - - 不允许一个文件导出不属于当前 `monorepo` 或当前文件夹的内容。 - - 不允许出现循环引用,如果不得不进行循环引用,应当首先考虑接口设计是否有问题。 -- 命名规则: - - 变量、成员、一般常量、方法、函数使用小驼峰。 - - 类、接口、类型别名、命名空间、泛型、枚举、组件使用大驼峰。 - - 不变常量使用全大写命名法,单词之间使用下划线连接。 - - 专有名词缩写如 `HTTP`, `URI` 全部大写。 - - 会被 `implements` 的接口使用大写 `I` 开头。 - - `id`, `class` 等 `HTML/CSS` 内容使用连字符命名法。 - - 不使用下划线命名法。 -- 注释: - - 常用属性成员、方法、接口、类型必须添加 `jsDoc` 注释。 - - 长文件可使用 `#region` 分段,可以写上 `#endretion` 允许折叠。 - - TODO 使用 `// TODO:` 或 `// todo:` 格式。 - - 单行注释的双斜杠与注释内容之间添加一个空格,多行注释只允许出现 `jsDoc` 注释,如果需要多行非 `jsDoc` 注释,使用多个单行注释。 - - 注释进行合理换行,考虑到中文字符较宽,建议 40-60 个字符进行换行。不允许在句中换行,必须在标点符号后换行。参数注释换行后保持对齐。 - - 单行注释结尾不添加句号,对于多行长注释,可以在结尾添加句号。 -- 类型: - - 不允许出现非必要的 `any` 类型。 - - 所有类的成员必须显式声明类型。 - - 如果有无法避免出现类型错误的地方,使用 `// @ts-expect-error` 标记,并填写原因。 - - 没用到的变量、方法使用下划线开头。 - - 合理运用 `readonly` `protected` `private` 关键字。 - - 函数不建议使用过多可选参数,如果可选参数过多,可以考虑换用对象。 - - 尽量少地使用 `as` 关键字进行类型断言,一般情况下不建议进行任何 `as` 类型断言,除非必要。 -- 其他要求: - - 严格遵循 `eslint` 配置,不允许出现 `eslint` 报错。 - - 尽量不使用 `?.` 运算符,一般建议仅在副作用函数调用(如 `this.obj?.func()`,`this.obj.func?.()`),或对象 `Required` 化(如 `{ value: obj?.value ?? 0 }`)中使用 `?.` 运算符。 - - 只进行必要的非空判断,不必要的非空判断直接使用非空断言 `!` 实现。 - - 除非参数要求传入函数等情况,不建议在函数内写任何局部函数。 - - 语句尽量不换行,除非必要,尤其注意三元运算符与 `private readonly` 类成员。 +### 模块原则 + +- **无副作用**:所有模块只包含函数、类、常量的声明,不允许出现导出的变量声明或顶层代码执行,允许但不建议编写类的静态块。 +- **模块初始化**:如需初始化,编写一个 `createXxx` 函数,在 `index.ts` 中整合后逐级向上传递,直至顶层模块统一执行。 +- **不转发导出**:不允许一个文件导出不属于当前 monorepo 或当前文件夹的内容。 +- **无循环引用**:不允许出现循环引用。若遇到不得不循环引用的情况,应首先反思接口设计是否存在问题。 + +### 命名规则 + +| 命名对象 | 规范 | +| ---------------------------------------------- | ------------------------------------------ | +| 变量、成员、一般常量、方法、函数 | 小驼峰 | +| 类、接口、类型别名、命名空间、泛型、枚举、组件 | 大驼峰 | +| 不变常量 | 全大写,单词间下划线分隔(如 `MAX_COUNT`) | +| 专有名词缩写(如 `HTTP`、`URI`) | 全大写 | +| 需被 `implements` 的接口 | 大写 `I` 开头 | +| HTML/CSS 中的 `id`、`class` 等 | 连字符命名法 | + +不使用下划线命名法。 + +### 注释规范 + +- 常用属性成员、方法、接口、类型必须添加 `jsDoc` 注释。 +- 长文件可使用 `#region` / `#endregion` 分段以支持折叠。 +- TODO 使用 `// TODO:` 或 `// todo:` 格式。 +- 单行注释的 `//` 与注释内容之间留一个空格;不允许出现非 jsDoc 的多行注释,如需多行注释,使用多个单行注释代替。 +- 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不允许在句中换行;参数注释换行后保持对齐。 +- 单行注释结尾不加句号;较长的多行注释结尾可加句号。 +- 一般不建议给接口、类型别名或类本身写注释(不好看),特殊情况除外。 + +### 类型规范 + +- 不允许出现非必要的 `any` 类型。 +- 所有类的成员必须显式声明类型。 +- 无法避免类型错误时,使用 `// @ts-expect-error` 标记并说明原因。 +- 未使用的变量或方法以下划线开头命名。 +- 合理使用 `readonly`、`protected`、`private` 关键字。 +- 可选参数过多时,考虑改用对象参数。 +- 尽量避免 `as` 类型断言,除非必要。 + +### 其他要求 + +- 严格遵循 `eslint` 配置,不允许出现 eslint 报错。 +- 尽量不使用 `?.` 运算符,仅推荐在以下两种场景中使用: + - 副作用函数调用,如 `this.obj?.func()` 或 `this.obj.func?.()` + - 对象 Required 化,如 `{ value: obj?.value ?? 0 }` +- 只进行必要的非空判断,非必要时直接使用非空断言 `!`。 +- 除非参数要求传入函数等情况,不建议在函数内定义局部函数。 +- 语句尽量不换行,除非必要,尤其注意三元运算符与 `private readonly` 类成员。 ## 双端分离 -样板将渲染端与数据端彻底分离,数据端可以单独在 `node` 环境运行,可以直接用于录像验证。渲染端仅负责向数据端发送消息,不负责任何逻辑运算。 +样板将渲染端与数据端彻底分离: -- `@user/data-base`: 数据端的系统层,负责核心系统。 -- `@user/data-state`: 数据端的实现层,依靠系统层实现完整的游戏实例。 -- `@user/client-base`: 渲染端的系统层,负责渲染端的核心系统。 -- `@user/client-modules`: 渲染端的实现层,依靠系统层实现客户端的渲染与用户交互。 +- **数据端**:可在 `node` 环境中单独运行,可直接用于录像验证,不负责任何渲染逻辑。 +- **渲染端**:仅负责向数据端发送消息,不负责任何逻辑运算。 -数据端允许运行渲染端代码,但需要使用全局接口 `Mota.r(() => {})` 包裹。除非必要,否则不建议在数据端调用渲染端代码。 +| 包 | 层级 | 说明 | +| ---------------------- | ------------ | ------------------------------------ | +| `@user/data-base` | 数据端系统层 | 负责数据端核心系统 | +| `@user/data-state` | 数据端实现层 | 依赖系统层实现完整的游戏实例 | +| `@user/client-base` | 渲染端系统层 | 负责渲染端核心系统 | +| `@user/client-modules` | 渲染端实现层 | 依赖系统层实现客户端的渲染与用户交互 | + +数据端允许调用渲染端代码,但必须使用全局接口 `Mota.r(() => {})` 包裹。除非必要,否则不建议在数据端调用渲染端代码。 diff --git a/prompt.md b/prompt.md index e683987..1d7a51f 100644 --- a/prompt.md +++ b/prompt.md @@ -2,32 +2,34 @@ 以下规则必须时刻遵守,任何情况下都不允许违反。 -1. 将我已经写好的代码视为绝对正确,除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。如果你认为我的代码中存在逻辑错误,应当在对话中提出,而不是直接修改。 -2. 我做的任何代码修改都是有原因的,如果我在两次对话期间新增、删除或修改了部分代码,不要将其恢复。 -3. 时刻以目的进行驱动,想明白我为什么要这么设计接口,这个接口设计的目的是什么,而不是简单地以实现接口为目标。 -4. 如果思考或实现时有任何问题,比如我的描述比较模糊,或接口描述比较模糊,或某些地方会产生歧义等等,应该立刻向我提问,而不是按照自己的想法去写。 -5. 如果我的目标是重构某个接口,按照我说的方式进行重构。如果是彻底性的重构(接口完全没有重合),则按照正常的方式进行实现,旧代码仅做逻辑与思路上的参考;如果是结构性的重构(接口基本一致,但有一些细节上的差距),则应该将旧代码搬到新的接口上,然后进行一些微调,**不要**擅自新增任何参数、任何新的方法或接口,**不要**仅仅通过新增一个兼容层兼容旧代码来实现重构。 +1. **不擅自修改已有代码**:将我已经写好的代码视为绝对正确。除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。若认为我的代码存在逻辑错误,应在对话中提出,而不是直接修改。 +2. **不恢复我的修改**:我做的任何代码修改都是有原因的。若我在两次对话期间新增、删除或修改了部分代码,不要将其恢复。 +3. **以目的驱动,而非以接口驱动**:实现前先想清楚我为什么要这样设计接口、这个接口设计的目的是什么,而不是单纯地以将接口填满为目标。 +4. **遇到歧义立即提问**:若思考或实现时遇到任何问题——例如描述模糊、接口不清晰、某些地方存在歧义等——应立即向我提问,而不是按自己的想法去写。 +5. **按我说的方式重构**:若目标是重构某个接口,按照我指定的方式执行: + - **彻底性重构**(新旧接口完全没有重合):按正常方式全新实现,旧代码仅作逻辑与思路上的参考。 + - **结构性重构**(新旧接口基本一致,细节有差距):将旧代码搬移到新接口上后进行微调。**不要**擅自新增任何参数、方法或接口,**不要**仅通过新增兼容层的方式应对重构。 # 建议规则 -以下规则为建议性,尽量遵守,但是一些特殊情况也可以违反,由你自己把控。 +以下规则为建议性,尽量遵守,特殊情况下可灵活处理。 -1. 我有时会在对话中给你提出实现建议,你应该对建议内容进行合理的参考,合理运用建议内容,一定注意不要滥用。 -2. 如果实现与类型标注有冲突,应当以类型标注(一般是 `types.ts`)中的内容为参考来源。 -3. 如果你认为类型标注中的接口设计有问题,或在实现中发现其缺少某些接口,应该向我提问是否添加,我同意后方可添加。 +1. **合理参考建议**:我有时会在对话中给出实现建议,应合理参考,切忌滥用。 +2. **以类型标注为参考依据**:实现与类型标注有冲突时,以类型标注(一般是 `types.ts`)中的内容为准。 +3. **发现接口问题时提问**:若认为类型标注中的接口设计有问题,或在实现中发现缺少某些接口,应向我提问是否添加,经我同意后方可添加。 -**时刻谨记上述要求,避免一个需求写好几次都写不出来,或写出我不满意的代码而挨骂** +**时刻谨记上述要求,避免一个需求反复修改仍无法满足预期。** # 开发流程 -当我提出需求时,如果没有明确说明直接实现或有其他明确要求,则遵循如下开发流程: +当我提出需求时,若没有明确说明直接实现或有其他明确要求,则遵循如下开发流程: -1. 阅读当前代码,分析需求,将需求整理为一个 markdown 文档,文档中明确标记需求细节,以及代码实现的大体思路。这一阶段中应当考虑全面,遇到任何问题应向我提问并确认。文档可以放在 `docs/dev` 目录下。 -2. 我会对文档进行全面的阅读,确保实现细节与思路没有问题后,允许你开始实现。这一步中我可能会对文档进行细微的调整,确保重新仔细阅读文档。如果实现时遇到了任何问题,应该向我提问,而不是按照自己的想法去写。 +1. 阅读当前代码,分析需求,将需求整理为一个 markdown 文档,放在 `docs/dev` 目录下。文档中需明确标注需求细节,以及代码实现的大体思路。此阶段需考虑全面,遇到任何问题应向我提问并确认,不得自行假设。 +2. 我会对文档进行全面阅读,确认实现细节与思路无误后,方允许开始实现。我可能会对文档进行细微调整,请在实现前重新仔细阅读最终版本。实现过程中如有任何问题,应向我提问,而不是自行决定。 ## 示例文档 -大致按照下述示例文档的格式编写,如果某些场景需要详细描述某个东西,可以单独开一个标题来写。 +大致按照以下格式编写,如某部分需要详细描述,可单独开设标题。我会使用引用块的形式在文档中提出建议或回答。 ```md # 需求综述 @@ -50,7 +52,7 @@ ## 需要引用的文件 -按照第三方库-其他包-当前包的其他文件的顺序写。 +按照第三方库 → 其他包 → 当前包的其他文件的顺序写。 - `xxx 库`: 引用第三方库,说明引用目的,以及需要的接口 - `@user/xxx`: 引用的目的,需要这个文件的哪些接口 @@ -77,7 +79,7 @@ # 问题 -如果我的描述中有歧义或比较模糊,可以在这把问题写出来,或者直接向我提问。 +如果描述中有歧义或比较模糊的地方,可以在此列出,或者直接向我提问。 1. xxxxxx? 2. xxxxxx? From 4c48b63e7e693d6a250f3754c33e474e44b153ab Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Wed, 6 May 2026 19:57:11 +0800 Subject: [PATCH 08/26] =?UTF-8?q?refactor:=20=E5=9C=B0=E5=9B=BE=E5=88=86?= =?UTF-8?q?=E5=8C=BA=E4=B8=8E=E5=B0=BA=E5=AF=B8=E4=BC=98=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/map-store-improve.md | 212 ++++++++++++++++++ docs/dev/map-store-save.md | 50 ++--- packages-user/data-base/src/map/layerState.ts | 30 ++- packages-user/data-base/src/map/mapStore.ts | 119 ++++++++-- packages-user/data-base/src/map/types.ts | 98 +++++--- packages-user/data-state/src/core.ts | 16 +- packages/common/src/logger.json | 1 + 7 files changed, 441 insertions(+), 85 deletions(-) create mode 100644 docs/dev/map-store-improve.md diff --git a/docs/dev/map-store-improve.md b/docs/dev/map-store-improve.md new file mode 100644 index 0000000..f477b92 --- /dev/null +++ b/docs/dev/map-store-improve.md @@ -0,0 +1,212 @@ +# 需求综述 + +本次改动目标: + +1. **自动化分区激活器**:将楼层按游戏进程划分为若干"区域", + 到达新区域时自动激活对应楼层、失活旧区域楼层, + 从而替代目前繁琐的手动 `setActiveStatus` 调用。 +2. **楼层尺寸上移至 `LayerState`**:同一楼层的所有图层尺寸应当 + 保持一致,因此将尺寸的权威来源从 `MapLayer` 移至 `LayerState`。 + +--- + +# 实现思路 + +## 1. 有序地图 id 列表 + +当前 `IMapStore.maps` 是 `ReadonlySet`,无序且随楼层创建 +自动填充。区域功能需要以**下标**标识范围,因此需改为有序数组。 + +修改方案: + +- `IMapStore.maps` 类型改为 `ReadonlyArray`; +- 新增 `setMapList(maps: string[]): void`,由外部显式指定有序列表 + (一般在游戏初始化时调用一次); +- 新增 `useManualOrder(sort: (arr: string[]) => string[]): void`, + 允许自定义地图列表排序函数。调用时将当前 `maps` 的 `slice` 拷贝 + 传入 `sort`,再对输出做合法性校验:将新旧数组各转为 `Set`, + 校验 `size` 相等且新集合是旧集合的子集(利用 `Set.prototype.isSubsetOf`); + 校验通过后用返回值替换内部的 `maps`。这样当地图是动态生成时, + 作者依然可以自定义顺序,而不必手动维护全量列表; +- `createLayerState` 不再维护 `maps`,`maps` 完全由 `setMapList` 管理; +- 若 `createLayerState` 传入的 id 不在 `maps` 中,仍可正常创建, + 不影响存档逻辑,但该楼层不参与任何区域判断。 + +## 2. 区域定义与管理 + +### 类型定义 + +```ts +/** 单段闭区间 [start, end],start 和 end 均为 maps 下标 */ +export interface IMapAreaInterval { + readonly start: number; + readonly end: number; +} + +/** 一个区域由一个或多个独立区间组成 */ +export type MapArea = IMapAreaInterval[]; +``` + +### 接口 + +- `setArea(areas: Set): void`:一次性设置所有区域信息, + 覆盖原有区域定义;每个元素代表一个区域,区域可包含多个区间, + 使用 `Set` 表示无序区域集合; +- `activeArea(id: string): void`:手动激活指定楼层所在区域的所有楼层。 + 系统遍历 `areaList`,找到包含该楼层 id 的区域后,对该区域内的所有 + 楼层调用 `setMapActiveStatus(floor, true)`; +- `deactiveArea(id: string): void`:手动取消激活指定楼层所在区域的 + 所有楼层,逻辑与 `activeArea` 对称;判断时遍历 `areaList`, + 此操作为低频调用,无需缓存; + +## 3. 自动分区激活器 + +### 接口 + +- `useAutoActivitor(enable: boolean): void`:是否启用自动激活器。 + +### 触发接口 + +需要一个通知接口供玩家相关模块调用: + +- `notifyEnterFloor(id: string): void`:玩家进入指定楼层时调用此接口, + 通知地图管理器进行自动激活判断。 + +### 逻辑 + +`notifyEnterFloor(id)` 的执行流程(每次进入楼层均调用,内部短路): + +1. 若自动激活器未启用,直接返回; +2. 若 `isMapActive(id)` 为 `true`,直接返回(楼层已激活,无需操作); +3. 遍历 `areaList`,找出包含 `id` 的区域; +4. 若未找到,直接返回(该楼层不在任何区域内); +5. 若 `lastFloorId !== null`,调用 `deactiveArea(lastFloorId)` 失活上一个区域; +6. 调用 `activeArea(id)` 激活新区域,更新 `lastFloorId = id`。 + +### 内部状态 + +`MapStore` 新增: + +- `private areaList: Set`:所有区域定义; +- `private lastFloorId: string | null = null`:上一次触发 `notifyEnterFloor` + 的楼层 id,用于定位并失活上一个激活区域; +- `private autoActivitorEnabled: boolean = false`:自动激活器开关。 + +## 4. 楼层尺寸上移至 LayerState + +### 动机 + +当前 `MapLayer.width` / `MapLayer.height` 存储在图层中, +但同一楼层的所有图层尺寸必须一致,权威来源应当是 `LayerState`。 + +### 接口变动 + +**`ILayerState` 新增**: + +```ts +readonly width: number; +readonly height: number; +``` + +**`addLayer` 签名调整**: + +目前 `addLayer(width: number, height: number): IMapLayer`, +移除 width/height 参数,改为 `addLayer(): IMapLayer`, +使用 `LayerState` 内部存储的尺寸创建图层。 + +楼层尺寸在 `createLayerState` 创建时指定,`createLayerState` 签名改为: + +```ts +createLayerState(id: string, width: number, height: number): ILayerState; +``` + +运行时仍可通过 `resizeLayer` 修改楼层尺寸,该方法会同步对楼层内所有 +图层执行 resize,保持尺寸一致。 + +**`resizeLayer` 签名调整**: + +当前 `resizeLayer(layer, width, height, keepBlock?)` 只 resize 单个图层, +但既然尺寸是楼层级的,建议改为对该楼层的所有图层同步 resize: + +```ts +resizeLayer(width: number, height: number, keepBlock?: boolean): void; +``` + +**`IMapLayer.resize` / `IMapLayer.resize2`**: + +从 `IMapLayer` 接口中移除,保留为 `MapLayer` 的内部实现, +仅由 `LayerState.resizeLayer` 调用。 + +**`IMapLayer.width` / `IMapLayer.height`**: + +保留在 `IMapLayer` 接口中,供外部通过图层对象直接获取尺寸。 +其值始终与所属 `LayerState` 的 `width`/`height` 保持一致。 + +--- + +# 附加建议结论 + +1. **`IMapLayer.setMapRef` 可见性**:保留现有设计,偶尔有外部需求。 +2. **`active` 状态管理**:不需要单独维护区域激活状态; + `activeArea(id)` / `deactiveArea(id)` 是 `setMapActiveStatus` 的 + 快捷方式,遍历区域楼层批量调用即可,无需额外的区域状态字段。 +3. **`notifyEnterFloor` 返回值**:暂不添加,后续有需求再改进。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `@user/data-base/src/map/types.ts`: 全部现有地图接口 +- `@user/data-base/src/map/mapStore.ts`: `MapStore` 实现类 +- `@user/data-base/src/map/layerState.ts`: `LayerState` 实现类 +- `@user/data-base/src/map/mapLayer.ts`: `MapLayer` 实现类 + +## 需要修改的文件 + +### `@user/data-base/src/map/types.ts` + +- [x] 新增 `IMapAreaInterval` 接口:区间定义,含 `start`、`end` +- [x] 新增 `MapArea` 类型别名:`IMapAreaInterval[]`,表示一个区域 +- [x] 修改 `ILayerState`: + - [x] 新增 `readonly width: number` 和 `readonly height: number` + - [x] 修改 `addLayer` 签名,移除 `width`/`height` 参数(使用 `LayerState` 自身尺寸) + - [x] 修改 `resizeLayer` 签名:移除 `layer` 参数,改为对整个楼层所有图层同步 resize +- [x] 修改 `IMapLayer`: + - [x] 移除 `resize` / `resize2`(改为 `MapLayer` 内部方法) +- [x] 修改 `IMapStore`: + - [x] 将 `readonly maps` 类型改为 `ReadonlyArray` + - [x] 修改 `createLayerState` 签名:新增 `width: number`、`height: number` 参数 + - [x] 新增 `setMapList(maps: string[]): void` + - [x] 新增 `useManualOrder(sort: (arr: string[]) => string[]): void` + - [x] 新增 `setArea(areas: Set): void` + - [x] 新增 `activeArea(id: string): void` + - [x] 新增 `deactiveArea(id: string): void` + - [x] 新增 `useAutoActivitor(enable: boolean): void` + - [x] 新增 `notifyEnterFloor(id: string): void` + +### `@user/data-base/src/map/mapStore.ts` + +- [x] 将 `maps: Set` 改为 `maps: string[]` +- [x] 修改 `createLayerState`:添加 `width`/`height` 参数,不再维护 `maps` +- [x] 实现 `setMapList` +- [x] 实现 `useManualOrder` +- [x] 新增 `private areaList: Set` +- [x] 新增 `private lastFloorId: string | null` +- [x] 新增 `private autoActivitorEnabled: boolean` +- [x] 实现 `setArea`、`activeArea`、`deactiveArea` +- [x] 实现 `useAutoActivitor` +- [x] 实现 `notifyEnterFloor` + +### `@user/data-base/src/map/layerState.ts` + +- [x] 新增 `width: number` 和 `height: number` 成员(由构造参数初始化) +- [x] 修改 `addLayer`,移除 `width`/`height` 参数,使用 `this.width`/`this.height` +- [x] 修改 `resizeLayer`,移除 `layer` 参数,改为对所有图层同步 resize + +### `@user/data-base/src/map/mapLayer.ts` + +- [x] 将 `resize`/`resize2` 改为内部方法(从公共接口移除) + +--- diff --git a/docs/dev/map-store-save.md b/docs/dev/map-store-save.md index fdc8c05..1af0da1 100644 --- a/docs/dev/map-store-save.md +++ b/docs/dev/map-store-save.md @@ -242,31 +242,31 @@ setActiveStatus(active: boolean): void; ### `@user/data-base/src/map/types.ts` -- [ ] 新增 `IMapLayerSave` 接口:单个 MapLayer 存档数据格式 -- [ ] 新增 `ILayerStateSave` 接口:单个楼层存档数据格式 -- [ ] 新增 `IMapStoreSave` 接口:MapStore 整体存档数据格式 -- [ ] 修改 `ILayerState`:新增 `readonly active: boolean` 和 +- [x] 新增 `IMapLayerSave` 接口:单个 MapLayer 存档数据格式 +- [x] 新增 `ILayerStateSave` 接口:单个楼层存档数据格式 +- [x] 新增 `IMapStoreSave` 接口:MapStore 整体存档数据格式 +- [x] 修改 `ILayerState`:新增 `readonly active: boolean` 和 `setActiveStatus(active: boolean): void` -- [ ] 修改 `IMapLayer`:新增 `setMapRef(array: Uint32Array): void` -- [ ] 新增 `IMapStore` 接口:继承 `ISaveableContent`, +- [x] 修改 `IMapLayer`:新增 `setMapRef(array: Uint32Array): void` +- [x] 新增 `IMapStore` 接口:继承 `ISaveableContent`, 含全部接口(见第 7 节) ### `@user/data-base/src/map/mapLayer.ts` ### `@user/data-base/src/map/layerState.ts` -- [ ] 新增 `active: boolean = false` 成员:楼层激活状态 -- [ ] 实现 `setActiveStatus(active: boolean): void` -- [ ] 新增 `private dirty: boolean = false` 成员:楼层级脏标记 -- [ ] 修改 `StateMapLayerHook.onUpdateArea`、`onUpdateBlock`、`onResize`: +- [x] 新增 `active: boolean = false` 成员:楼层激活状态 +- [x] 实现 `setActiveStatus(active: boolean): void` +- [x] 新增 `private dirty: boolean = false` 成员:楼层级脏标记 +- [x] 修改 `StateMapLayerHook.onUpdateArea`、`onUpdateBlock`、`onResize`: 在转发钩子的同时,将 `state.dirty` 置 `true` -- [ ] 新增 `isDirty(): boolean` 方法:返回 `this.dirty`,供 `MapStore` 读取 -- [ ] 新增 `setDirty(dirty: boolean): void` 方法: +- [x] 新增 `isDirty(): boolean` 方法:返回 `this.dirty`,供 `MapStore` 读取 +- [x] 新增 `setDirty(dirty: boolean): void` 方法: 供 `MapStore.compareWith` 时根据实际比较结果设置 ### `@user/data-base/src/map/mapLayer.ts` -- [ ] 新增 `setMapRef(array: Uint32Array): void` 方法: +- [x] 新增 `setMapRef(array: Uint32Array): void` 方法: 直接替换内部图块数组引用,跳过拷贝,供 `MapStore` 读档时使用。 需确保传入数组长度与 `width × height` 匹配, 并触发必要的钩子通知(不触发 `onResize`,应触发 `onUpdateArea` 通知全区域更新)。 @@ -274,21 +274,21 @@ setActiveStatus(active: boolean): void; ### `@user/data-base/src/map/mapStore.ts`(新文件) -- [ ] 实现 `MapStore` 类,实现 `IMapStore` -- [ ] `private mapData: Map`:楼层 id 到状态对象的映射 -- [ ] `readonly maps: ReadonlySet`:所有楼层 id 的只读集合视图 -- [ ] `private refData: Map> | null`:参考基准 -- [ ] 实现 `getLayerState`、`getActiveMap`、`createLayerState` -- [ ] 实现 `isMapActive`、`setMapActiveStatus`、`iterateActiveMaps`、`iterateInactiveMaps`、`iterateAllMaps` -- [ ] 实现 `compareWith` -- [ ] 实现 `saveNoCompression`、`saveLowCompression`、`saveHighCompression` -- [ ] 实现 `loadNoCompression`、`loadLowCompression`、`loadHighCompression` -- [ ] 实现 `saveState(compression)` 和 `loadState(state, compression)` 分发 +- [x] 实现 `MapStore` 类,实现 `IMapStore` +- [x] `private mapData: Map`:楼层 id 到状态对象的映射 +- [x] `readonly maps: ReadonlySet`:所有楼层 id 的只读集合视图 +- [x] `private refData: Map> | null`:参考基准 +- [x] 实现 `getLayerState`、`getActiveMap`、`createLayerState` +- [x] 实现 `isMapActive`、`setMapActiveStatus`、`iterateActiveMaps`、`iterateInactiveMaps`、`iterateAllMaps` +- [x] 实现 `compareWith` +- [x] 实现 `saveNoCompression`、`saveLowCompression`、`saveHighCompression` +- [x] 实现 `loadNoCompression`、`loadLowCompression`、`loadHighCompression` +- [x] 实现 `saveState(compression)` 和 `loadState(state, compression)` 分发 ### `@user/data-base/src/map/index.ts` -- [ ] 补充导出 `mapStore.ts` +- [x] 补充导出 `mapStore.ts` ### `@user/data-base/src/types.ts` -- [ ] 将 `IStateBase.layer` 类型由 `ILayerState` 改为 `IMapStore` +- [x] 将 `IStateBase.layer` 类型由 `ILayerState` 改为 `IMapStore` diff --git a/packages-user/data-base/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts index 37f4359..9edb9ed 100644 --- a/packages-user/data-base/src/map/layerState.ts +++ b/packages-user/data-base/src/map/layerState.ts @@ -18,6 +18,8 @@ export class LayerState implements ILayerState { readonly layerList: Set = new Set(); + /** 具体 MapLayer 实例列表,供内部 resize 使用 */ + private readonly mapLayerList: Set = new Set(); /** 图层到图层别名映射 */ readonly layerAliasMap: WeakMap = new WeakMap(); /** 图层别名到图层的映射 */ @@ -35,10 +37,18 @@ export class LayerState /** 楼层级脏标记 */ private dirty: boolean = false; - addLayer(width: number, height: number): IMapLayer { - const array = new Uint32Array(width * height); - const layer = new MapLayer(array, width, height); + constructor( + public width: number, + public height: number + ) { + super(); + } + + addLayer(): IMapLayer { + const array = new Uint32Array(this.width * this.height); + const layer = new MapLayer(array, this.width, this.height); this.layerList.add(layer); + this.mapLayerList.add(layer); this.forEachHook(hook => { hook.onUpdateLayer?.(this.layerList); }); @@ -50,6 +60,7 @@ export class LayerState removeLayer(layer: IMapLayer): void { this.layerList.delete(layer); + this.mapLayerList.delete(layer as MapLayer); const alias = this.layerAliasMap.get(layer); if (alias) { const symbol = Symbol.for(alias); @@ -89,15 +100,18 @@ export class LayerState } resizeLayer( - layer: IMapLayer, width: number, height: number, keepBlock: boolean = false ): void { - if (keepBlock) { - layer.resize(width, height); - } else { - layer.resize2(width, height); + this.width = width; + this.height = height; + for (const layer of this.mapLayerList) { + if (keepBlock) { + layer.resize(width, height); + } else { + layer.resize2(width, height); + } } } diff --git a/packages-user/data-base/src/map/mapStore.ts b/packages-user/data-base/src/map/mapStore.ts index 19e1fe8..d72fc72 100644 --- a/packages-user/data-base/src/map/mapStore.ts +++ b/packages-user/data-base/src/map/mapStore.ts @@ -6,21 +6,65 @@ import { IMapLayer, IMapLayerSave, IMapStore, - IMapStoreSave + IMapStoreSave, + MapArea } from './types'; import { LayerState } from './layerState'; +import { uniq } from 'lodash-es'; export class MapStore implements IMapStore { /** 楼层 id 到状态对象的映射 */ private readonly mapData: Map = new Map(); - /** 所有楼层 id 的只读集合视图 */ - readonly maps: Set = new Set(); + /** 所有楼层 id 的有序数组 */ + readonly maps: string[] = []; /** 差分压缩参考基准,首次 compareWith 后设置,之后不再更新 */ private refData: Map> | null = null; - //#region 楼层访问 + /** 分区列表 */ + private areaList: Set = new Set(); + + /** 上一次调用 notifyEnterFloor 传入的楼层 id */ + private lastFloorId: string | null = null; + + /** 自动分区激活器开关 */ + private autoActivitorEnabled: boolean = false; + + //#region 楼层管理 + + createLayerState(id: string, width: number, height: number): ILayerState { + if (this.mapData.has(id)) { + logger.warn(121, id); + } else { + this.maps.push(id); + } + const state = new LayerState(width, height); + // 若 refData 已存在,新楼层直接视为全脏 + if (this.refData !== null) { + state.setDirty(true); + } + this.mapData.set(id, state); + return state; + } + + setMapList(maps: string[]): void { + this.maps.length = 0; + this.maps.push(...uniq(maps)); + } + + useManualOrder(sort: (arr: string[]) => string[]): void { + const copy = this.maps.slice(); + const sorted = sort(copy); + const oldSet = new Set(this.maps); + const newSet = new Set(sorted); + if (oldSet.size !== newSet.size || !newSet.isSubsetOf(oldSet)) { + logger.warn(125); + return; + } + this.maps.length = 0; + this.maps.push(...uniq(sorted)); + } getLayerState(id: string): ILayerState | null { return this.mapData.get(id) ?? null; @@ -34,20 +78,65 @@ export class MapStore implements IMapStore { //#endregion - //#region 楼层管理 + //#region 分区管理 - createLayerState(id: string): ILayerState { - if (this.mapData.has(id)) { - logger.warn(121, id); + setArea(areas: Set): void { + this.areaList = areas; + } + + activeArea(id: string): void { + const idx = this.maps.indexOf(id); + if (idx === -1) return; + const area = this.findAreaByIndex(idx); + if (!area) return; + this.setAreaActive(area, true); + } + + deactiveArea(id: string): void { + const idx = this.maps.indexOf(id); + if (idx === -1) return; + const area = this.findAreaByIndex(idx); + if (!area) return; + this.setAreaActive(area, false); + } + + useAutoActivitor(enable: boolean): void { + this.autoActivitorEnabled = enable; + } + + notifyEnterFloor(id: string): void { + if (!this.autoActivitorEnabled) return; + const idx = this.maps.indexOf(id); + if (idx === -1) return; + const area = this.findAreaByIndex(idx); + if (!area) return; + if (this.lastFloorId !== null) { + this.deactiveArea(this.lastFloorId); } - const state = new LayerState(); - // 若 refData 已存在,新楼层直接视为全脏 - if (this.refData !== null) { - state.setDirty(true); + this.activeArea(id); + this.lastFloorId = id; + } + + private findAreaByIndex(idx: number): MapArea | null { + for (const area of this.areaList) { + for (const interval of area) { + if (idx >= interval.start && idx <= interval.end) { + return area; + } + } + } + return null; + } + + private setAreaActive(area: MapArea, active: boolean): void { + for (const interval of area) { + for (let i = interval.start; i <= interval.end; i++) { + const floorId = this.maps[i]; + if (floorId !== undefined) { + this.setMapActiveStatus(floorId, active); + } + } } - this.mapData.set(id, state); - this.maps.add(id); - return state; } //#endregion diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index 7f959b3..47f0bfc 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -75,20 +75,6 @@ export interface IMapLayer extends IHookable< /** 图层纵深 */ readonly zIndex: number; - /** - * 调整地图尺寸,维持原有图块。如果尺寸变大,那么会补零,如果尺寸变小,那么会将当前数组裁剪 - * @param width 地图宽度 - * @param height 地图高度 - */ - resize(width: number, height: number): void; - - /** - * 调整地图尺寸,但是将地图全部重置为零,不保留原地图数据 - * @param width 地图宽度 - * @param height 地图高度 - */ - resize2(width: number, height: number): void; - /** * 设置某一点的图块 * @param block 图块数字 @@ -225,13 +211,15 @@ export interface ILayerState extends IHookable { readonly layerList: Set; /** 此楼层是否处于激活状态 */ readonly active: boolean; + /** 此楼层的地图宽度 */ + readonly width: number; + /** 此楼层的地图高度 */ + readonly height: number; /** - * 添加图层 - * @param width 地图宽度 - * @param height 地图高度 + * 添加图层,使用楼层预设的宽高 */ - addLayer(width: number, height: number): IMapLayer; + addLayer(): IMapLayer; /** * 移除指定图层 @@ -265,18 +253,12 @@ export interface ILayerState extends IHookable { getLayerAlias(layer: IMapLayer): string | undefined; /** - * 重新设置图层的大小 - * @param layer 图层对象 - * @param width 新的图层宽度 - * @param height 新的图层高度 + * 重新设置所有图层的大小,同时更新楼层预设宽高 + * @param width 新的地图宽度 + * @param height 新的地图高度 * @param keepBlock 是否保留原有图块,默认不保留 */ - resizeLayer( - layer: IMapLayer, - width: number, - height: number, - keepBlock?: boolean - ): void; + resizeLayer(width: number, height: number, keepBlock?: boolean): void; /** * 设置背景图块 @@ -336,9 +318,18 @@ export interface IMapStoreSave { readonly floors: ReadonlyMap; } +/** 单段闭区间 [start, end],start 和 end 均为 maps 下标 */ +export interface IMapAreaInterval { + readonly start: number; + readonly end: number; +} + +/** 一个区域由一个或多个独立区间组成 */ +export type MapArea = IMapAreaInterval[]; + export interface IMapStore extends ISaveableContent { - /** 所有楼层的 id 集合 */ - readonly maps: ReadonlySet; + /** 所有楼层的 id 有序数组 */ + readonly maps: ReadonlyArray; /** * 获取指定 id 的楼层状态,不存在则返回 null @@ -355,8 +346,10 @@ export interface IMapStore extends ISaveableContent { /** * 创建并注册一个空白楼层,若 id 已存在则警告并覆盖,返回楼层状态对象 * @param id 楼层 id + * @param width 地图宽度 + * @param height 地图高度 */ - createLayerState(id: string): ILayerState; + createLayerState(id: string, width: number, height: number): ILayerState; /** * 获取指定 id 的楼层是否激活,不存在的 id 返回 false @@ -391,4 +384,47 @@ export interface IMapStore extends ISaveableContent { * @param ref 外层 key = 楼层 id,内层 key = zIndex,value = 图层完整图块数据 */ compareWith(ref: Map>): void; + + /** + * 设定楼层有序列表。设定后有序列表将用于分区索引计算 + * @param maps 楼层 id 数组 + */ + setMapList(maps: string[]): void; + + /** + * 使用自定义排序函数重排 maps。排序函数接收当前列表的副本,返回新顺序。 + * 若返回的数组元素集合与原列表不一致,则警告并放弃本次排序 + * @param sort 排序函数 + */ + useManualOrder(sort: (arr: string[]) => string[]): void; + + /** + * 设定分区列表。每个分区由一个或多个区间组成 + * @param areas 分区集合 + */ + setArea(areas: Set): void; + + /** + * 激活指定楼层所属分区的所有楼层 + * @param id 楼层 id + */ + activeArea(id: string): void; + + /** + * 去激活指定楼层所属分区的所有楼层 + * @param id 楼层 id + */ + deactiveArea(id: string): void; + + /** + * 开启或关闭自动分区激活器 + * @param enable 是否开启 + */ + useAutoActivitor(enable: boolean): void; + + /** + * 通知当前进入的楼层。开启自动激活器时,将自动去激活上一个分区并激活新分区 + * @param id 楼层 id + */ + notifyEnterFloor(id: string): void; } diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 4b3b325..87bb0c5 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -214,12 +214,16 @@ export class CoreState implements ICoreState { const reference = new Map>(); for (const id of floors) { const floor = data[id]; - const state = this.maps.createLayerState(id); - const bg = state.addLayer(floor.width, floor.height); - const bg2 = state.addLayer(floor.width, floor.height); - const event = state.addLayer(floor.width, floor.height); - const fg = state.addLayer(floor.width, floor.height); - const fg2 = state.addLayer(floor.width, floor.height); + const state = this.maps.createLayerState( + id, + floor.width, + floor.height + ); + const bg = state.addLayer(); + const bg2 = state.addLayer(); + const event = state.addLayer(); + const fg = state.addLayer(); + const fg2 = state.addLayer(); bg.setZIndex(BG_ZINDEX); bg2.setZIndex(BG2_ZINDEX); event.setZIndex(EVENT_ZINDEX); diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index e9b8dcd..20fe5f9 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -182,6 +182,7 @@ "122": "MapStore.loadState: floor '$1' not found in current map data, skipping.", "123": "MapLayer.setMapRef: array length $1 does not match expected size $2, setMapRef will be ignored.", "124": "MapStore.loadState: floor '$1' or its layer(s) not found in current reference data, skipping.", + "125": "Expected sorted floor id array has a same floor id set, but an array with a different floor id set is returned.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } From fbdd609001164783bd373d2d9aa0dc670ab15803 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Mon, 11 May 2026 23:35:46 +0800 Subject: [PATCH 09/26] =?UTF-8?q?feat:=20=E5=8A=A8=E6=80=81=E5=9B=BE?= =?UTF-8?q?=E5=B1=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 7 +- docs/dev/{ => enemy}/enemy-manager-save.md | 0 docs/dev/{ => hero}/hero-modifier-save.md | 0 docs/dev/map/dynamic-tile-move.md | 595 ++++++++++++++++++ docs/dev/map/dynamic-tile.md | 407 ++++++++++++ docs/dev/{ => map}/map-store-improve.md | 0 docs/dev/{ => map}/map-store-save.md | 0 docs/dev/{ => system}/save-system.md | 0 packages-user/data-base/src/common/index.ts | 1 + packages-user/data-base/src/common/mover.ts | 579 +++++++++++++++++ .../data-base/src/map/dynamicLayer.ts | 142 +++++ .../data-base/src/map/dynamicTile.ts | 72 +++ packages-user/data-base/src/map/index.ts | 1 + packages-user/data-base/src/map/mapLayer.ts | 5 + packages-user/data-base/src/map/mover.ts | 78 +++ packages-user/data-base/src/map/types.ts | 168 ++++- .../data-state/src/enemy/calculator.ts | 9 - packages/common/src/logger.json | 5 + prompt.md | 9 +- 19 files changed, 2063 insertions(+), 15 deletions(-) rename docs/dev/{ => enemy}/enemy-manager-save.md (100%) rename docs/dev/{ => hero}/hero-modifier-save.md (100%) create mode 100644 docs/dev/map/dynamic-tile-move.md create mode 100644 docs/dev/map/dynamic-tile.md rename docs/dev/{ => map}/map-store-improve.md (100%) rename docs/dev/{ => map}/map-store-save.md (100%) rename docs/dev/{ => system}/save-system.md (100%) create mode 100644 packages-user/data-base/src/common/mover.ts create mode 100644 packages-user/data-base/src/map/dynamicLayer.ts create mode 100644 packages-user/data-base/src/map/dynamicTile.ts create mode 100644 packages-user/data-base/src/map/mover.ts diff --git a/dev.md b/dev.md index 19d9c08..de5e670 100644 --- a/dev.md +++ b/dev.md @@ -57,13 +57,15 @@ ### 注释规范 -- 常用属性成员、方法、接口、类型必须添加 `jsDoc` 注释。 +- 公共方法、接口必须在**源头处**(多数情况下为 `interface`)添加 `jsDoc` 注释;其他常用成员、方法、类型也必须添加注释(含义极为明确或极少使用的可例外,但建议全部添加)。 +- 继承或 `implements` 而来的 API(方法、成员等),若注释说明无需变更,则**不应重复添加** `jsDoc` 注释。 +- 不对构造器添加注释。若构造器使用了属性声明语法(`constructor(public prop: T)`)且成员需要说明,可仅对该成员添加参数注释,不写构造器描述。**在这种情况下**建议避免在构造器中使用属性声明语法,将成员单独声明并在构造器中赋值。此条建议**并非**要求不使用构造器的属性声明语法,而是仅在这一情况下不建议使用,常规情况下推荐使用此语法来缩短代码长度并提高可读性。 - 长文件可使用 `#region` / `#endregion` 分段以支持折叠。 - TODO 使用 `// TODO:` 或 `// todo:` 格式。 - 单行注释的 `//` 与注释内容之间留一个空格;不允许出现非 jsDoc 的多行注释,如需多行注释,使用多个单行注释代替。 - 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不允许在句中换行;参数注释换行后保持对齐。 - 单行注释结尾不加句号;较长的多行注释结尾可加句号。 -- 一般不建议给接口、类型别名或类本身写注释(不好看),特殊情况除外。 +- 一般不建议给接口(`inteface` 本身)、类型别名或类本身写注释(不好看),特殊情况除外。 ### 类型规范 @@ -77,6 +79,7 @@ ### 其他要求 +- 不使用字符串作为键或特殊标识符(如枚举值、事件名、状态名等),应使用枚举代替。仅当明确表示字符串本身(如字符串类型的 id 别名、文件路径等)时方可使用字符串字面量。 - 严格遵循 `eslint` 配置,不允许出现 eslint 报错。 - 尽量不使用 `?.` 运算符,仅推荐在以下两种场景中使用: - 副作用函数调用,如 `this.obj?.func()` 或 `this.obj.func?.()` diff --git a/docs/dev/enemy-manager-save.md b/docs/dev/enemy/enemy-manager-save.md similarity index 100% rename from docs/dev/enemy-manager-save.md rename to docs/dev/enemy/enemy-manager-save.md diff --git a/docs/dev/hero-modifier-save.md b/docs/dev/hero/hero-modifier-save.md similarity index 100% rename from docs/dev/hero-modifier-save.md rename to docs/dev/hero/hero-modifier-save.md diff --git a/docs/dev/map/dynamic-tile-move.md b/docs/dev/map/dynamic-tile-move.md new file mode 100644 index 0000000..ea4c905 --- /dev/null +++ b/docs/dev/map/dynamic-tile-move.md @@ -0,0 +1,595 @@ +# 动态图块移动系统 + +> 本文档为 [动态图块系统](./dynamic-tile.md) 的移动子系统设计文档, +> 重点描述双方向模型、`IDynamicMover` 计划式移动接口及执行流程。 +> 本文档中新增的类型与接口同样需要添加至 `@user/data-base/src/map/types.ts`。 + +--- + +# 背景与动机 + +`IDynamicLayer.moveDynamicStep` / `moveDynamicWith` 是命令式简单接口,适用于 +一次性的简单移动,但对以下场景力不从心: + +- **后退移动**:角色面朝上、向下移动时,朝向不变但位移反向, + 单一 `FaceDirection` 参数无法同时描述朝向和移动方向; +- **连续路径中途动态追加步骤**:命令式接口执行后无法继续追加; +- **移动速度切换**:路径中途需要变速,命令式接口不支持; +- **复杂动画编排**:需要按序执行多段计划时,纯 `Promise` 链表达不够直观。 + +因此引入以图块为粒度绑定的 `IDynamicMover`,采用**先建计划、再执行**的设计理念, +参考 `@motajs/animate/types.ts` 的链式计划构建模式, +以及 `@user/data-state/legacy/move.ts` 中 `ObjectMoverBase` 的双方向与队列设计。 + +--- + +# 实现思路 + +## 1. 双方向模型 + +每个动态图块维护两个方向字段: + +| 字段 | 含义 | 影响 | +| --------------- | ---------------------------- | --------------------------------------- | +| `faceDirection` | **朝向**,视觉上「面朝哪里」 | 通过 `IRoleFaceBinder` 决定渲染图块数字 | +| `moveDirection` | **移动方向**,「向哪边走」 | 结合 `getFaceMovement` 计算位移 | + +两者分离后可以表达: + +- **后退**:`moveDirection = Up`,执行 `backward()` 步, + `moveDirection = Down`,`faceDirection = Down`,位移向下,朝向同步翻转。 +- **横向移动不转身**:使用 `stepFace(move, face)` 单独指定朝向, + `moveDirection` 与 `faceDirection` 独立设置。 + +绝对方向步骤(传入 `FaceDirection`)默认将两者同时更新; +`forward()` 沿当前 `moveDirection` 移动并对齐 `faceDirection`; +`backward()` 将 `moveDirection` 取反并同步 `faceDirection`。 + +## 2. 方向步语义 + +绝对方向步(`IDynamicMoveStepDir` / `IDynamicMoveStepDirFace`)直接传入 `FaceDirection`: + +- `step(dir, count?: number)`:追加 `count`(默认 1)个绝对方向步,`moveDirection` 和 `faceDirection` 均更新为 `dir`; +- `stepFace(move, face, count?: number)`:追加 `count`(默认 1)个绝对方向步,`moveDirection` 更新为 `move`, + `faceDirection` 更新为 `face`——用于移动方向与朝向不一致的场景(如斜切移动保持正向)。 + +相对方向步(`IDynamicMoveStepSpecial`)通过独立方法构建: + +- `forward(count?)`:沿当前 `tile.moveDirection` 移动,`moveDirection` 不变, + `faceDirection` 对齐为 `moveDirection`; +- `backward(count?)`:沿 `opposite(tile.moveDirection)` 移动,`moveDirection` 取反, + `faceDirection` 同步更新为新的 `moveDirection`,自动使用逆向动画。 + +## 3. DynamicMoveStep 类型 + +步骤类型通过 `const enum` 区分,避免字符串比较。 +前进/后退方向用独立的 `DynamicSpecialStep` 枚举表示; +动画播放方向用独立的 `DynamicAnimDirection` 枚举表示,两者互不依赖: + +```ts +const enum DynamicMoveStepType { + /** 绝对方向步,同步更新 moveDirection 和 faceDirection */ + Dir, + /** 绝对方向步,单独指定 faceDirection */ + DirFace, + /** 速度步 */ + Speed, + /** 纯转向步,不产生位移 */ + Face, + /** 特殊步(前进或后退) */ + Special, + /** 动画方向步,不影响 moveDirection/faceDirection */ + AnimDir +} + +/** 特殊步方向:前进或后退 */ +const enum DynamicSpecialStep { + Forward, + Backward +} + +/** 动画播放方向:正向或逆向 */ +const enum DynamicAnimDirection { + Forward, + Backward +} + +/** 绝对方向步:move 方向既是移动方向也是朝向 */ +interface IDynamicMoveStepDir { + type: DynamicMoveStepType.Dir; + move: FaceDirection; +} + +/** 绝对方向步:move 是移动方向,face 是显式指定的朝向 */ +interface IDynamicMoveStepDirFace { + type: DynamicMoveStepType.DirFace; + move: FaceDirection; + face: FaceDirection; +} + +/** 速度步:修改后续移动的每格耗时(单位 ms,越小越快) */ +interface IDynamicMoveStepSpeed { + type: DynamicMoveStepType.Speed; + value: number; +} + +/** 转向步:仅更新 faceDirection,不产生位移,等待渲染动画完成 */ +interface IDynamicMoveStepFace { + type: DynamicMoveStepType.Face; + value: FaceDirection; +} + +/** 特殊步:前进(Forward)或后退(Backward)。`forward(n)`/`backward(n)` 构建时 n>1 会 push n 个相同步骤 */ +interface IDynamicMoveStepSpecial { + type: DynamicMoveStepType.Special; + direction: DynamicSpecialStep; +} + +/** 动画方向步:指定后续步骤动画正向播放(Forward)还是逆向播放(Backward) */ +interface IDynamicMoveAnimDir { + type: DynamicMoveStepType.AnimDir; + dir: DynamicAnimDirection; +} + +type DynamicMoveStep = + | IDynamicMoveStepDir + | IDynamicMoveStepDirFace + | IDynamicMoveStepSpeed + | IDynamicMoveStepFace + | IDynamicMoveStepSpecial + | IDynamicMoveAnimDir; +``` + +## 4. IMoverController 接口 + +`IDynamicMover.start()` 返回 `IMoverController`,用于控制进行中的移动。 + +```ts +interface IMoverController { + /** 本次移动是否已全部完成 */ + readonly done: boolean; + /** 当本次移动全部步骤完成时兑现 */ + readonly onEnd: Promise; + /** + * 向当前队列末尾追加步骤(仅在移动进行中有效,完成后追加无效) + */ + push(...steps: DynamicMoveStep[]): void; + /** + * 停止移动,等待当前步骤完成后停止,返回的 Promise 在停止后兑现 + */ + stop(): Promise; +} +``` + +## 5. IDynamicMover 接口 + +每个 `IDynamicTile` 持有一个**绑定**的 `IDynamicMover` 实例(`tile.mover`), +无需单独创建或管理生命周期。 + +### 5.1 状态读取 + +```ts +// 以下状态属性来自 IObjectMover,IDynamicMover 全部继承 +interface IObjectMover { + /** 是否正在移动 */ + readonly moving: boolean; + /** 当前朝向(与 tile.faceDirection 同步) */ + readonly faceDirection: FaceDirection; + /** 当前移动方向(与 tile.moveDirection 同步) */ + readonly moveDirection: FaceDirection; + /** 所属的可移动对象 */ + readonly tile: T; + // ... +} +``` + +### 5.2 计划构建(链式) + +所有构建方法均返回 `this`,支持链式调用。 +计划在调用 `start()` 前不执行,仅追加到内部队列。 + +```ts +interface IDynamicMover { + // ... + /** 追加 count(默认 1)个绝对方向步,同步更新 moveDirection 和 faceDirection */ + step(dir: FaceDirection, count?: number): this; + /** 追加 count(默认 1)个绝对方向步,单独指定 faceDirection(用于移动方向与朝向不一致的场景) */ + stepFace(move: FaceDirection, face: FaceDirection, count?: number): this; + /** 追加前进步,沿当前 moveDirection 移动,faceDirection 对齐为 moveDirection */ + forward(count?: number): this; + /** 追加后退步,moveDirection 取反,faceDirection 同步更新,自动使用逆向动画 */ + backward(count?: number): this; + /** 追加一个速度步,改变后续移动的每格耗时(ms) */ + speed(value: number): this; + /** 追加一个纯转向步,仅更新 faceDirection,不产生位移 */ + face(dir: FaceDirection): this; + /** 追加一个动画方向步,控制后续步骤的动画播放方向(Forward 正向 / Backward 逆向) */ + animDir(dir: DynamicAnimDirection): this; + /** 清空尚未执行的计划队列 */ + clear(): this; + // ... +} +``` + +**用法示例**: + +```ts +// 先向下走 2 步,切换为半速,再向右走 1 步 +tile.mover + .step(FaceDirection.Down, 2) + .speed(200) + .step(FaceDirection.Right) + .start(); + +// 后退 3 步(moveDirection/faceDirection 翻转,逆向动画) +tile.mover.backward(3).start(); + +// 向右移动但保持朝下(如横向滑步) +tile.mover.stepFace(FaceDirection.Right, FaceDirection.Down, 2).start(); +``` + +### 5.3 执行控制 + +```ts +interface IDynamicMover { + // ... + /** + * 开始执行计划队列,返回控制对象。 + * 若已在移动则返回 null(不中断当前移动)。 + */ + start(): IMoverController | null; +} +``` + +## 6. 移动执行流程 + +每次 `start()` 启动后,执行器按以下总流程处理队列: + +触发 `onMoveStart` → 循环每步:[ +`abstract onStepStart(step, tile, mover)` 执行并返回 `code: number`(子类计算本步场景)→ +触发 `IObjectMoverHooks.onStepStart(code, step, tile, mover)` 钩子(渲染预处理,此时 `tile.x/y` 为**移动前坐标**)→ +等待所有 Promise → +`abstract onStepEnd(code, step, tile, mover)` 执行**逻辑效果**(子类根据 code 决定如何执行)→ +触发 `IObjectMoverHooks.onStepEnd(code, step, tile, mover)` 钩子(此时 `tile.x/y` 为**移动后坐标**) +] → 触发 `onMoveEnd`。 + +### 6.1 绝对方向步(`DynamicMoveStepType.Dir`) + +**onStepStart 阶段**(`tile.x/y` 为原始坐标): + +1. `abstract onStepStart(step, tile, mover)` 执行,子类计算本步 `code`(正常移动、碰墙等)并返回 `Promise`。 +2. 父类拿到 `code`,触发 `IObjectMoverHooks.onStepStart(code, step, tile, mover)` 钩子——渲染端在此阶段播放移动动画, + 可由 `step.move` 与当前 `tile.x/y` 推算目标位置。 +3. `await Promise.all(promises)`——等待全部动画完成。 + +**onStepEnd 阶段**(逻辑效果): + +1. `abstract onStepEnd(code, step, tile, mover)` 执行——子类依据 `code` 决定本步实际效果: + 更新 `tile.moveDirection = step.move`。 +2. 计算 `{dx, dy} = getFaceMovement(step.move)`,**立即**更新 `tile.x += dx`、`tile.y += dy`。 +3. 同步更新 `posMap`。 +4. 执行转向逻辑(见 [dynamic-tile.md §8](./dynamic-tile.md#8-转向逻辑)), + 更新 `tile.faceDirection` 与 `tile.num`。 +5. 子类返回后,父类触发 `IObjectMoverHooks.onStepEnd(code, step, tile, mover)` 钩子,此时 `tile.x/y` 已为新坐标。 + +### 6.1.1 含显式朝向的绝对方向步(`DynamicMoveStepType.DirFace`) + +与 `Dir` 步骤相同,但步骤 5 改为直接将 `tile.faceDirection` 设为 `step.face`, +并通过 `getFaceOf(tile.num, step.face)` 更新 `tile.num`,不经过 `degradeFace` 降级。 + +### 6.2 速度步(`DynamicMoveStepType.Speed`) + +更新内部速度状态,立即生效,无位移,无需等待。 + +### 6.3 纯转向步(`DynamicMoveStepType.Face`) + +经由 `onStepStart` 触发钩子(`tile.x/y` 不变,`step.type === DynamicMoveStepType.Face` 供渲染端区分); +等待渲染端动画完成后,`onStepEnd` 阶段执行转向逻辑,更新 `faceDirection` 与 `tile.num`, +触发 `onStepEnd` 钩子。 + +### 6.4 特殊步(`DynamicMoveStepType.Special`) + +**语义说明**:`forward`/`backward` 以**上一步的移动方向**(即当前 `tile.moveDirection`)为基准; +若无上一步,则回退到当前 `faceDirection`;若图块无朝向绑定,则抛出错误。 + +**Forward**(`DynamicSpecialStep.Forward`): + +1. `actualDir = tile.moveDirection`(不改变 moveDirection); +2. 执行与 `Dir` 步骤相同的位移流程; +3. 步骤 2:跳过(`moveDirection` 保持不变); +4. 步骤 5:执行转向逻辑,以 `actualDir` 更新 `tile.faceDirection` 与 `tile.num`。 + +**Backward**(`DynamicSpecialStep.Backward`): + +1. `actualDir = opposite(tile.moveDirection)`; +2. 在执行前临时将逆向动画标志设为开启(步骤完成后恢复); +3. 执行与 `Dir` 步骤相同的位移流程; +4. 步骤 2:`tile.moveDirection = actualDir`; +5. 步骤 5:执行转向逻辑,以 `actualDir` 更新 `tile.faceDirection` 与 `tile.num`。 + +### 6.5 动画方向步(`DynamicMoveStepType.AnimDir`) + +指定后续步骤动画是**正向播放**(`DynamicAnimDirection.Forward`)还是**逆向播放**(`DynamicAnimDirection.Backward`), +与图块朝向无关(朝向始终由 `faceDirection` 决定)。 +修改 mover 内部的 `currentAnimDir` 状态。 +渲染端在 `onStepStart` 收到 `AnimDir` 步骤时读取并更新本地动画方向状态,后续步骤的 `onStepStart` 触发时依据此状态决定播放方向。 +`onStepEnd` 阶段无逻辑操作,立即完成,不影响坐标与方向。 + +## 7. onStepStart / onStepEnd 钩子返回值 + +`IObjectMoverHooks.onStepStart` 与 `onStepEnd` 均为可选钩子(`?`),返回类型为 `Promise`, +执行器始终通过 `Promise.all` 等待所有订阅方完成后再继续。 + +关键时序:`onStepStart` 所有 Promise 兑现后,才执行逻辑效果(abstract onStepEnd); +`onStepEnd` 全部兑现后,才进入下一步。 +多个订阅方通过 `Promise.all` 并行等待,与 `forEachHook` 返回所有值的设计天然契合—— +`const promises = forEachHook(hook => hook.onStepStart?.(code, step, tile, mover));` +`await Promise.all(promises);` + +## 8. 与 IDynamicLayer / IDynamicTile 接口的关系 + +`IDynamicLayer` 和 `IDynamicTile` **仅保留 `step(dir)` 单步便捷接口** +(等价于 `tile.mover.step(dir).start()`),不再提供 `moveDynamicWith` / `moveWith` 等批量接口。 +复杂移动能力(`forward`/`backward`/`animDir` 等)通过 `tile.mover` 访问。 + +**渲染端订阅移动事件的流程**: + +1. 订阅 `IDynamicLayer.onCreateDynamicTile`; +2. 创建图块时获取 `tile.mover` 引用,直接向其添加钩子; +3. 移动事件从 `tile.mover` 触发,无需经过 `IDynamicLayer` 转发。 + +为此,`IDynamicMover` 扩展为可订阅对象, +实现 `IHookable>`(见接口定义汇总)。 + +--- + +# 涉及文件 + +## 需要修改的文件 + +### `@user/data-base/src/map/types.ts` + +修改现有接口(移动相关新增类型已移至 `move/types.ts`): + +- [ ] `IDynamicTile` 新增 `readonly mover: IDynamicMover` +- [ ] `IDynamicTile` 已有 `readonly faceDirection: FaceDirection` 与 + `readonly moveDirection: FaceDirection`(已在主文档确认) +- [ ] `IObjectMovable` 接口(`x`、`y`、`moveDirection`、`faceDirection` 只读属性 + + `setPos`/`setMoveDirection`/`setFaceDirection`,定义在 `dynamic-tile.md`) +- [ ] `IDynamicLayer` / `IDynamicTile` 仅保留 `step(dir)` 便捷接口, + 移除 `moveDynamicWith` / `moveDynamicStep` / `moveWith` / `moveStep` + (主文档接口汇总需同步更新) + +#### `@user/data-base/src/map/types.ts` + +- [ ] `DynamicMoveStepType` `const enum`: + 含 `Dir`/`DirFace`/`Speed`/`Face`/`Special`/`AnimDir` 六个成员 +- [ ] `DynamicSpecialStep` `const enum`:含 `Forward`/`Backward` 两个成员 +- [ ] `DynamicAnimDirection` `const enum`:含 `Forward`/`Backward` 两个成员 +- [ ] `IDynamicMoveStepDir` 接口(`type: DynamicMoveStepType.Dir`,`move: FaceDirection`) +- [ ] `IDynamicMoveStepDirFace` 接口(`type: DynamicMoveStepType.DirFace`,`move`/`face: FaceDirection`) +- [ ] `IDynamicMoveStepSpeed` 接口(`type: DynamicMoveStepType.Speed`) +- [ ] `IDynamicMoveStepFace` 接口(`type: DynamicMoveStepType.Face`) +- [ ] `IDynamicMoveStepSpecial` 接口(`type: Special`,`direction: DynamicSpecialStep`;无 `count` 字段,`forward(n)`/`backward(n)` 改为 push n 个步骤对象) +- [ ] `IDynamicMoveAnimDir` 接口(`type: DynamicMoveStepType.AnimDir`,`dir: DynamicAnimDirection`) +- [ ] `DynamicMoveStep` 联合类型(含以上六种步骤) +- [ ] `IMoverController` 接口 +- [ ] `IObjectMoverHooks` 接口(含 `onMoveStart`/`onMoveEnd`/`onStepStart`/`onStepEnd`; + `onStepStart`/`onStepEnd` 参数顺序为 `(code, step, tile, mover)`,按使用频率排列) +- [ ] `IObjectMover` 接口(含 `faceDirection`/`moveDirection` 只读属性及全部计划构建方法;`step`/`stepFace` 含 `count?` 参数) +- [ ] `IDynamicMover extends IObjectMover`(无额外成员,继承基类全部能力;`IDynamicMoverHooks` 已移除,直接使用 `IObjectMoverHooks`) + +#### `@user/data-base/src/map/mover.ts` + +- [ ] `abstract class ObjectMover` 抽象基类: + - 实现 `IObjectMover`,在此提供全部**计划构建方法**(`step`/`stepFace`/`forward`/ + `backward`/`speed`/`face`/`animDir`/`clear`/`start`)及队列执行调度逻辑; + - 含四个**抽象方法**,子类必须实现,组成移动核心控制流: + - `abstract onMoveStart(tile, mover): Promise`: 整次移动开始时调用 + - `abstract onMoveEnd(tile, mover): Promise`: 整次移动结束时调用 + - `abstract onStepStart(step, tile, mover): Promise`: 单步逻辑执行前调用, + 子类计算并**返回** `code`;父类将 `code` 传给 `IObjectMoverHooks.onStepStart` 钩子后等待 + - `abstract onStepEnd(code, step, tile, mover): Promise`: 单步钩子等待完成后调用,子类依据 `code` 执行本步实际逻辑效果 +- [ ] `class DynamicMover extends ObjectMover implements IDynamicMover`: + 持有 `tile: IDynamicTile` 引用,维护 `moveQueue`、`moving`、 + `faceDirection`、`moveDirection` 状态;实现四个抽象方法(含 posMap 更新、转向逻辑等) +- [ ] `DynamicTile` 类新增 `readonly mover: DynamicMover`, + 在构造时以 `this` 为参数创建 + +--- + +# 接口定义汇总 + +```ts +const enum DynamicMoveStepType { + Dir, + DirFace, + Speed, + Face, + Special, + AnimDir +} + +const enum DynamicSpecialStep { + Forward, + Backward +} + +const enum DynamicAnimDirection { + Forward, + Backward +} + +interface IDynamicMoveStepDir { + type: DynamicMoveStepType.Dir; + move: FaceDirection; +} + +interface IDynamicMoveStepDirFace { + type: DynamicMoveStepType.DirFace; + move: FaceDirection; + face: FaceDirection; +} + +interface IDynamicMoveStepSpeed { + type: DynamicMoveStepType.Speed; + value: number; +} + +interface IDynamicMoveStepFace { + type: DynamicMoveStepType.Face; + value: FaceDirection; +} + +/** forward(n)/backward(n) 构建时 n>1 会 push n 个相同步骤,步骤对象本身不携带 count */ +interface IDynamicMoveStepSpecial { + type: DynamicMoveStepType.Special; + direction: DynamicSpecialStep; +} + +interface IDynamicMoveAnimDir { + type: DynamicMoveStepType.AnimDir; + dir: DynamicAnimDirection; +} + +type DynamicMoveStep = + | IDynamicMoveStepDir + | IDynamicMoveStepDirFace + | IDynamicMoveStepSpeed + | IDynamicMoveStepFace + | IDynamicMoveStepSpecial + | IDynamicMoveAnimDir; + +interface IMoverController { + readonly done: boolean; + readonly onEnd: Promise; + push(...steps: DynamicMoveStep[]): void; + stop(): Promise; +} + +interface IObjectMoverHooks extends IHookBase { + onMoveStart(mover: IObjectMover, tile: T): Promise; + onMoveEnd(mover: IObjectMover, tile: T): Promise; + /** 触发时 tile.x/y 为移动前坐标,适合渲染端在此播放动画 */ + onStepStart?( + code: number, + step: DynamicMoveStep, + tile: T, + mover: IObjectMover + ): Promise; + /** 触发时 tile.x/y 已更新为移动后坐标 */ + onStepEnd?( + code: number, + step: DynamicMoveStep, + tile: T, + mover: IObjectMover + ): Promise; +} + +interface IObjectMover extends IHookable< + IObjectMoverHooks +> { + readonly moving: boolean; + readonly tile: T; + readonly faceDirection: FaceDirection; + readonly moveDirection: FaceDirection; + + step(dir: FaceDirection, count?: number): this; + stepFace(move: FaceDirection, face: FaceDirection, count?: number): this; + forward(count?: number): this; + backward(count?: number): this; + speed(value: number): this; + face(dir: FaceDirection): this; + animDir(dir: DynamicAnimDirection): this; + clear(): this; + start(): IMoverController | null; +} + +// 这里的 onStepStart 不再接受 code 作为参数,因为这应当是其返回值 `Promise`, +// 具体来说,这四个方法是整个移动的核心方法而非钩子,它应当提供接口让子类实现, +// 子类应当真正执行移动效果,并进行一定的控制。显然子类是没办法知道 onStepStart 中的信息的, +// 所以才提供了一个 code,用于子类向 ObjectMover 提供信息,然后父类再传递给子类, +// 从而子类了解到 onStepStart 中的信息,再进一步决定这一步真正应该如何执行。 +// 而对于钩子,实际上是在子类的 onStepStart 执行完毕后进行的,所以是知道 code 的,所以才是参数。 +// 你应该好好想一想这之间的关系。 +// 以及子类是要求必须实现的,所以不应该会有返回 `void` 的场景,四个方法都应该返回 `Promise`。 +// 总的来说,父类是一个“系统级”的流程控制器,它通过这四个接口来实现真正的移动控制, +// 就像 legacy ObjectMoverBase 中的 startMove 一样。 +abstract class ObjectMover< + T extends IObjectMovable +> implements IObjectMover { + abstract onMoveStart(tile: T, mover: IObjectMover): Promise; + abstract onMoveEnd(tile: T, mover: IObjectMover): Promise; + /** 子类计算并返回本步 code;父类取得 code 后再触发 IObjectMoverHooks.onStepStart 钩子 */ + abstract onStepStart( + step: DynamicMoveStep, + tile: T, + mover: IObjectMover + ): Promise; + /** 子类依据 code 执行本步实际逻辑效果;父类在此之后触发 IObjectMoverHooks.onStepEnd 钩子 */ + abstract onStepEnd( + code: number, + step: DynamicMoveStep, + tile: T, + mover: IObjectMover + ): Promise; + // 计划构建方法(step/stepFace/forward/backward/speed/face/animDir/clear/start)在此实现 +} + +// faceDirection/moveDirection 已提升至 IObjectMover,IDynamicMover 无需额外声明 +// IDynamicMoverHooks 已移除,直接使用 IObjectMoverHooks +interface IDynamicMover extends IObjectMover { + // 继承自 IObjectMover:moving, faceDirection, moveDirection, tile, 全部计划构建方法及钩子 +} +``` + +--- + +# 问题 + +1. **`backward()` 的移动方向基准** ✅ 已确定 + + `backward()` 以 `opposite(tile.moveDirection)` 作为移动方向(基于 `moveDirection` 取反,非 `faceDirection`)。 + `moveDirection` 更新为反向,`faceDirection` 通过转向逻辑跟随同步更新。 + +2. **`forward()` 是否更新 faceDirection** ✅ 已确定 + + `forward()` 沿当前 `moveDirection` 移动,`moveDirection` 不变, + `faceDirection` 通过转向逻辑对齐为 `moveDirection`。 + +3. **转向步触发钩子方式** ✅ 已确定 + + 统一经由 `onStepStart(code, step, tile, mover)` 钩子处理,在步骤逻辑执行前触发。 + 渲染端通过 `step.type === DynamicMoveStepType.Face` 区分纯转向步与位移步; + `onStepStart` 触发时 `tile.x/y` 为原始坐标,渲染端可直接读取,无需反推。 + 转向逻辑(`faceDirection`/`num` 更新)在 `onStepEnd` 阶段执行。 + +4. **`animDir` 与渲染钩子集成** ✅ 已确定 + + `onStepStart` 统一接收所有步骤,`IDynamicMoveAnimDir` 步骤本身即为信息载体。 + 渲染端在 `onStepStart` 收到 `AnimDir` 步骤时更新本地动画方向状态; + 后续方向步的 `onStepStart` 触发时,渲染端依据本地状态决定动画播放方向。 + +5. **玩家移动与图块移动的复用** ✅ 已确定 + + 玩家(勇士)移动逻辑与 `IDynamicMover` 高度一致,共同抽象为 + `IObjectMover`(参考 legacy `ObjectMoverBase`,适配新 API); + 核心抽象类为 `abstract class ObjectMover`,含四个抽象方法组成控制流: + - **计划构建方法**(`step`/`stepFace`/`forward`/`backward`/ + `speed`/`face`/`animDir`/`clear`/`start`)全部在 `ObjectMover` 基类实现,子类无需重复声明。 + - **移动流程钩子**(`IObjectMoverHooks`,实现 `IHookable>`): + - `onMoveStart(mover, tile)`:整次移动队列开始时触发; + - `onMoveEnd(mover, tile)`:整次移动队列结束时触发; + - `onStepStart(code, step, tile, mover)`:单步开始前触发(`tile.x/y` 为移动前坐标); + - `onStepEnd(code, step, tile, mover)`:单步完成后触发(`tile.x/y` 已更新); + 其中 `code: number` 标识移动场景(如碰墙、遇敌、循环地图等),由具体实现层设置。 + - **四个抽象方法**(`onMoveStart`/`onMoveEnd`/`onStepStart`/`onStepEnd`):子类(`DynamicMover`/`HeroMover`) + 通过实现这四个方法完全控制移动行为,执行流程由 `ObjectMover` 基类统一调度。 + 关键:`onStepStart` 返回 `Promise`(code),父类将此 code 传给钩子后再调用 `onStepEnd(code, ...)`, + 子类在 `onStepEnd` 中依据 code 执行实际状态变更。四个方法均返回 `Promise`,无 `void` 选项。 + - **泛型参数** `T extends IObjectMovable`:`IObjectMovable` 是可移动对象的最小接口 + (`x`、`y`、`moveDirection`、`faceDirection` 只读属性 + + `setPos`/`setMoveDirection`/`setFaceDirection` 方法),定义在 `dynamic-tile.md`; + `IDynamicTile extends IObjectMovable`,玩家侧使用 `IHeroMovable extends IObjectMovable`。 + - **`IDynamicMover extends IObjectMover`**: + 无额外成员,直接继承基类全部能力(含 `faceDirection`/`moveDirection` 及 `IObjectMoverHooks`)。 diff --git a/docs/dev/map/dynamic-tile.md b/docs/dev/map/dynamic-tile.md new file mode 100644 index 0000000..3d59a4e --- /dev/null +++ b/docs/dev/map/dynamic-tile.md @@ -0,0 +1,407 @@ +# 需求综述 + +当前地图系统仅支持静态图块(通过 `IMapLayer` / `Uint32Array` 存储), +无法支持可移动的动态图块(例如 NPC、推箱子、可交互物件等)。 +动态图块的核心特点: + +1. **允许重叠**——同一格点可同时存在多个动态图块; +2. **整数坐标**——始终处于格点整数坐标,不出现小数,便于渲染优化与交互; +3. **异步移动**——移动接口返回 `Promise`,配合渲染动画; +4. **朝向转向**——部分图块移动时需同步更新朝向(如四方向 NPC 行走图)。 + +--- + +# 实现思路 + +## 1. 动态图块标识方案 + +**采用引用标识**:`createDynamicTile` 与 `transferToDynamic` 均返回 +`IDynamicTile` 对象引用,调用方持有该引用作为后续操作(移动、删除、 +设置朝向等)的唯一凭证。无需维护任何 ID,无唯一性管理负担。 + +调用方可将返回的 `IDynamicTile` 引用存储在自己的数据结构中, +`tile.x`、`tile.y`、`tile.num`、`tile.direction` 等字段始终反映图块的 +最新状态——内部实现类持有可变字段,接口以 `readonly` 暴露给外部, +保证外部不能直接修改,内部可通过类实例更新。 + +## 2. 坐标表示 + +使用独立的 `x: number, y: number` 参数,与现有 `IMapLayer` 接口风格 +(如 `setBlock(block, x, y)`、`getBlock(x, y)`)保持一致,不引入 `ITileLocator`。 + +## 3. 方向表示 + +移动方向与转向方向统一使用 `FaceDirection` 枚举: + +- 语义明确,与已有 `IRoleFaceBinder`(朝向绑定)直接对接; +- 已有工具函数 `getFaceMovement(dir)` 可将其转换为坐标偏移,无需重复实现; +- 多步路径(`moveDynamicWith` 的 `steps` 参数)使用 `FaceDirection[]`。 + +`IDirectionDescriptor` 更偏向纯数学计算(用于范围迭代等), +语义上不适合表达「图块朝向某方向移动」的含义。 + +**已确定**:移动方向(`moveDirection`)与朝向(`faceDirection`)分离为两个独立字段。 +后退等相对移动必须依赖两者分离才能正确表达(例如面朝上、向下后退时,`faceDirection` +保持 `Up`,`moveDirection` 更新为 `Down`)。 + +移动系统另立文档独立设计,包含双方向模型、`IDynamicMover` 抽象、 +计划式移动接口及执行流程等完整方案,见 +[动态图块移动系统](./dynamic-tile-move.md)。 + +`moveDynamicStep` / `moveDynamicWith` 保留为命令式便捷接口,适用于单次简单移动; +复杂路径和计划式移动统一使用 `IDynamicMover`。 + +## 4. 动态图块数据模型与图层归属 + +动态图块按**所属静态图层**组织层级关系:每个 `IMapLayer` 持有一个 +`IDynamicLayer`,动态图块的渲染深度即为其所属 `IMapLayer` 的 `zIndex`, +与静态图块一致。因此 `IDynamicLayer` 接口挂载在 `IMapLayer` 上, +而不是 `ILayerState` 上(见第 5 节)。 + +每个动态图块存储以下信息: + +```ts +/** 可移动对象的最小公共接口,供 `IObjectMover` 泛型约束使用 */ +interface IObjectMovable { + readonly x: number; + readonly y: number; + readonly moveDirection: FaceDirection; + readonly faceDirection: FaceDirection; + setPos(x: number, y: number): void; + setMoveDirection(dir: FaceDirection): void; + setFaceDirection(dir: FaceDirection): void; +} + +interface IDynamicTile extends IObjectMovable { + readonly num: number; // 图块数字(决定渲染图像) + readonly layer: IDynamicLayer; // 所属动态图层 + readonly mover: IDynamicMover; // 绑定的移动器(计划式移动) + /** 删除此图块,转发至 layer.deleteDynamic */ + delete(): void; + /** 还原为静态图块,转发至 layer.transferToStatic */ + toStatic(): void; + /** 还原为静态图块,如果当前位置有东西则不转换,转发只 layer.transferToStaticIfSafe */ + toStaticIfSafe(): boolean; + /** + * 单步便捷移动接口,等价于 `mover.step(dir, count); return mover.start();`。 + * 适用于简单移动场景,复杂路径通过 `tile.mover` 访问。 + */ + step(dir: FaceDirection, count?: number): IMoverController | null; +} +``` + +`x`、`y`、`moveDirection`、`faceDirection` 及 `setPos`/`setMoveDirection`/`setFaceDirection` +均由 `IObjectMovable` 提供,`IDynamicTile` 不再重复声明。 +`IObjectMover` 以此接口为泛型约束, +使图块和玩家 mover 共享核心执行逻辑;具体渲染效果通过 `IObjectMoverHooks` 的 `onStepStart`/`onStepEnd` 钩子实现。 + +`DynamicLayer` 内部维护两个结构: + +- `tileSet: Set` — 所有图块的集合,用于迭代与归属判断; +- `posMap: Map>>` — 按坐标索引 + (外层 key = y,内层 key = x,value = 该格点所有图块对象集合), + 图块移动时同步更新,支持越界坐标(见第 4.1 节)。 + +调用方持有 `IDynamicTile` 对象引用即可完成所有操作, +`posMap` 仅供按坐标查询(`getDynamicTilesAt`)使用, +因使用频率低,嵌套 `Map` 的开销完全可以接受。 + +`IDynamicTile` 上的 `moveStep`/`moveWith`/`delete`/`setDirection`/`setPos`/`toStatic` +均为便捷转发方法,内部直接调用 `tile.layer` 对应接口,不修改任何内部状态。 +调用方可直接通过 `tile.xxx()` 操作,无需额外持有 `IDynamicLayer` 引用。 + +### 4.1 越界移动 + +动态图块的坐标不受楼层 `width`/`height` 约束,允许出现负值或超出地图范围的坐标。 +这满足了如「图块飞出屏幕」「过场动画」等临时越界需求。 +`DynamicLayer` 无需感知楼层尺寸,`resizeLayer` 也无需通知 `DynamicLayer`。 + +## 5. IDynamicLayer 挂载在 IMapLayer 上 + +动态图块的存储结构与 `IMapLayer`(Uint32Array)本质不同,独立封装为 `IDynamicLayer`。 +`IMapLayer` 新增 `readonly dynamicLayer: IDynamicLayer` 属性, +调用方通过具体的图层对象操作该层的动态图块,z 层级天然与静态图块一致。 + +`IDynamicLayer` 实现 `IHookable` 以支持渲染端订阅变更事件。 +`IRoleFaceBinder` 通过 `setFaceBinder(binder)` 方法注入(见第 8 节), +不在构造时传入,使多楼层共用同一个 `binder` 实例更灵活。 + +`transferToDynamic(x, y)` 不需要 `layer` 参数, +因为它隶属于某个具体的 `IDynamicLayer`,直接从同级 `IMapLayer` 读写图块即可, +并返回创建的 `IDynamicTile` 引用。 + +## 6. 移动函数的坐标来源 + +`moveDynamicStep(direction, tile)` 与 `moveDynamicWith(steps, tile)` 均不接受 +`ox, oy` 参数,改为直接接受 `IDynamicTile` 引用。当前坐标直接读取 `tile.x`、 +`tile.y`,无需调用方额外传入。 + +内部行为: + +- 直接读取 `tile.x`、`tile.y` 作为出发点; +- **立即**将图块逻辑坐标更新为目标位置(单步 `(tile.x+dx, tile.y+dy)`); +- 同步更新 `posMap`; +- 触发 `onMoveTile` 钩子,收集所有钩子返回的 `Promise | void`; +- `await Promise.all(promises)`—— + 等待所有渲染动画完成后,本步才算兑现,再进入下一步。 + +详细多步路径与计划式移动的执行流程见 +[动态图块移动系统](./dynamic-tile-move.md)。 + +## 7. transferToDynamic 与 transferToStatic + +`transferToDynamic(x, y)` 不需要额外的 `layer` 参数。 +`DynamicLayer` 在构造时持有对所属 `MapLayer` 的引用, +直接调用 `mapLayer.getBlock(x, y)` 读取图块数字,再调用 `mapLayer.setBlock(0, x, y)` 清除, +最后创建对应的动态图块并返回其引用。 +若该位置图块为 0(空白),则发出 logger 警告并仍然创建 `num = 0` 的动态图块。 + +新增 `transferToStaticIfSafe(tile)` 作为安全版本:仅当目标位置静态图块为 0(空白)时才执行还原, +否则不转换并返回 `false`;转换成功返回 `true`。适用于不确定目标格是否已有图块的场景。 + +新增 `transferToStatic(tile)` 作为逆操作:将动态图块还原为静态图块。 +对于「只移动一次就固定」的图块(如推箱子放到指定位置后不再移动), +及时转回静态存储可以降低存档体积、简化渲染订阅。执行流程: + +1. 读取 `tile.x`、`tile.y`、`tile.num`; +2. 若坐标不在所属 `MapLayer` 的合法范围内(即 `x < 0`、`y < 0`、 + `x >= width` 或 `y >= height`),发出 logger 警告并放弃操作; +3. 若 `mapLayer.getBlock(tile.x, tile.y) !== 0`,在开发环境下发出 logger 警告 + (目标格点已有静态图块内容,将被覆盖); + 调用 `mapLayer.setBlock(tile.num, tile.x, tile.y)` 写回静态图块; +4. 从 `tileSet` 和 `posMap` 中移除该图块,触发 `onDeleteTile` 钩子。 + +## 8. 转向逻辑 + +`moveDynamicStep` / `moveDynamicWith` 在每一步移动时自动更新朝向(使用双方向模型, +详见 [动态图块移动系统](./dynamic-tile-move.md)): + +1. 更新 `tile.moveDirection` 为本步实际移动方向; +2. 通过外部注入的 `IRoleFaceBinder` 调用 `getFaceOf(tile.num, direction)` 查询 + 该方向对应的图块数字; +3. 若图块无朝向绑定(返回 `null`),则不修改 `num`,仅更新 `faceDirection`; +4. 若有绑定,将 `tile.num` 与 `tile.faceDirection` 更新为查询结果。 + +`IRoleFaceBinder` 通过 `setFaceBinder(binder: IRoleFaceBinder): void` 方法注入, +不在构造时传入;初始状态视为无朝向绑定(`getFaceOf` 始终返回 `null`)。 +若多个楼层共用同一个 `RoleFaceBinder` 实例,直接对各楼层各图层分别调用 `setFaceBinder` 即可。 + +对于八方向移动,转向查询逻辑扩展如下: + +1. 更新 `tile.moveDirection` 为本步实际移动方向; +2. 调用 `getFaceOf(tile.num, direction)` 查询; +3. 若返回 `null` 且当前方向为斜向(八方向之一), + 调用 `degradeFace(direction)` 降级为四方向后再查询一次; +4. 若仍返回 `null`,不修改 `num`,仅更新 `faceDirection`; +5. 若查询到结果,将 `tile.num` 更新为结果图块数字,并更新 `faceDirection`。 + +手动设置朝向通过独立接口 `setDynamicDirection(tile, direction)` 完成, +逻辑与上述步骤 1–5 相同,但不触发移动。 + +## 9. IDynamicLayerHooks 与 ILayerStateHooks + +`IDynamicLayerHooks` 定义三个钩子: + +- `onCreateTile(tile: IDynamicTile)`:图块被创建(含转换)时触发; +- `onDeleteTile(tile: IDynamicTile)`:图块被删除时触发(传入删除前的快照); +- `onMoveTile(tile: IDynamicTile, fromX: number, fromY: number): Promise | void`: + 图块移动一步时触发,`tile` 为更新后的状态,`fromX`/`fromY` 为移动前坐标。 + 返回 `Promise` 时,移动器将等待其兑现后再进行下一步(配合 `Promise.all` 并行等待所有订阅方)。 + +`ILayerStateHooks` 新增对应的三个转发钩子,额外携带 `layer: IMapLayer` 参数, +与现有的 `onUpdateLayerArea`、`onResizeLayer` 等钩子风格一致: + +- `onCreateDynamicTile(layer: IMapLayer, dynamicLayer: IDynamicLayer, tile: IDynamicTile)` +- `onDeleteDynamicTile(layer: IMapLayer, dynamicLayer: IDynamicLayer, tile: IDynamicTile)` +- `onMoveDynamicTile(layer: IMapLayer, dynamicLayer: IDynamicLayer, tile: IDynamicTile, fromX: number, fromY: number)` + +`LayerState` 在为每个 `MapLayer` 注册 `StateMapLayerHook` 时, +同步订阅该层 `dynamicLayer` 的三个钩子,将事件加上 `layer`、`dynamicLayer` 参数后转发至楼层钩子。 + +--- + +# 涉及文件 + +> 移动相关的接口(`DynamicMoveDir`、`IDynamicMoveStep`、`IMoverController`、`IDynamicMover`) +> 设计详情见 [动态图块移动系统](./dynamic-tile-move.md), +> 同样需要添加至 `types.ts`。 + +## 需要引用的文件 + +- `@motajs/common`:`IHookable`, `IHookBase`, `Hookable`, `logger` +- `@user/data-base/src/common`:`FaceDirection`, `IRoleFaceBinder`, + `getFaceMovement`, `degradeFace` +- `@user/data-base/src/map/types.ts`:`IMapLayer`, `IMapLayerHooks`, + `ILayerState`, `ILayerStateHooks` + +## 需要修改的文件 + +### `@user/data-base/src/map/types.ts` + +- [ ] 新增 `IObjectMovable` 接口: + 含 `x`、`y`、`moveDirection`、`faceDirection` 四个只读属性及 + `setPos`/`setMoveDirection`/`setFaceDirection` 三个方法; + 供 `IObjectMover` 泛型约束使用 +- [ ] 新增 `IDynamicTile extends IObjectMovable` 接口: + 含 `num`、`layer`、`mover` 三个只读属性及 `delete`/`toStatic` 两个便捷方法; + 无 `id` 字段,坐标/方向成员由 `IObjectMovable` 提供 +- [ ] 新增移动相关类型(详见移动文档接口定义汇总,已移至 `move/types.ts`): + `DynamicMoveStepType`、`DynamicMoveStep`、`IMoverController`、 + `IObjectMoverHooks`、`IObjectMover`、`IDynamicMover` +- [ ] 新增 `IDynamicLayerHooks extends IHookBase` 接口: + 含 `onCreateTile`、`onDeleteTile`、`onMoveTile` 三个钩子方法 +- [ ] 新增 `IDynamicLayer extends IHookable` 接口: + - [ ] `createDynamicTile(num, x, y): IDynamicTile`: 在指定位置创建动态图块, + 返回图块引用 + - [ ] `transferToDynamic(x, y): IDynamicTile`: 从所属静态图层读取并清除 + 指定位置图块,创建对应动态图块并返回引用 + - [ ] `transferToStatic(tile: IDynamicTile)`: 将动态图块还原为静态图块; + 坐标越界则警告并放弃,否则写回静态图层并触发 `onDeleteTile` + - [ ] `transferToStaticIfSafe(tile: IDynamicTile): boolean`: 仅当目标位置静态图块为 0 + 时才还原,否则不转换;返回是否转换成功 + - [ ] `deleteDynamicTile(tile: IDynamicTile)`: 删除指定图块,不在此层则警告 + - [ ] `getDynamicTilesAt(x, y)`: 获取指定格点所有动态图块的可迭代对象 + - [ ] `moveDynamicWith` / `moveDynamicStep` 已由 `IDynamicMover` 权其责。 + `IDynamicLayer` 不再提供此两个方法,删除对应条目。 + - [ ] `setDynamicDirection(tile: IDynamicTile, direction)`: 手动设置朝向, + 同步更新 `direction` 与 `num`(若有朝向绑定) + - [ ] `setDynamicPos(tile: IDynamicTile, x: number, y: number)`: 直接设置图块位置, + 同步更新 `posMap`,触发 `onMoveTile` 钩子,不更新朝向 + - [ ] `setFaceBinder(binder: IRoleFaceBinder)`: 注入朝向绑定器 +- [ ] 修改 `IMapLayer`:新增 `readonly dynamicLayer: IDynamicLayer` +- [ ] 修改 `ILayerStateHooks`:新增 `onCreateDynamicTile`、`onDeleteDynamicTile`、 + `onMoveDynamicTile` 三个转发钩子,额外携带 `layer: IMapLayer` 与 + `dynamicLayer: IDynamicLayer` 两个参数 + +### `@user/data-base/src/map/dynamicLayer.ts`(新文件) + +- [ ] 实现 `DynamicLayer extends Hookable` 类, + 实现 `IDynamicLayer` +- [ ] 实现内部类 `DynamicTile implements IDynamicTile`: + 持有 `layer: IDynamicLayer` 引用,`delete`/`toStatic` 转发至 `layer`; + `step(dir, count?)` 封装为便捷方法 +- [ ] `DynamicTile` 构造时同步创建 `readonly mover: DynamicMover`, + 移动调度由 `move/dynamicMover.ts` 中的 `DynamicMover` 类实现 +- [ ] `private mapLayer: IMapLayer`:构造参数,所属静态图层引用, + 供 `transferToDynamic` / `transferToStatic` 读写使用 +- [ ] `private faceBinder: IRoleFaceBinder | null = null`:朝向绑定器, + 通过 `setFaceBinder` 注入 +- [ ] `private tileSet: Set`:所有图块的集合,用于迭代与归属判断 +- [ ] `private posMap: Map>>`: + 按坐标索引(外层 key = y,内层 key = x),支持越界坐标 +- [ ] 实现全部接口方法,移动时同步更新 `tileSet` 与 `posMap` + +### `@user/data-base/src/map/mapLayer.ts` + +- [ ] 新增 `readonly dynamicLayer: DynamicLayer`:构造时以 `this` 为参数创建 + +### `@user/data-base/src/map/layerState.ts` + +- [ ] 修改 `StateMapLayerHook`(或 `addLayer` 中的订阅逻辑): + 在为每个 `MapLayer` 注册钩子时,同时订阅其 `dynamicLayer` 的三个钩子, + 将事件加上 `layer`、`dynamicLayer` 参数后转发至楼层的 `ILayerStateHooks` + +--- + +# 接口定义汇总 + +以下为本次新增与修改的完整接口签名,供实现时参考。 + +移动相关接口(`IObjectMoverHooks`、`IObjectMover`、`IDynamicMover`、`IMoverController`、`DynamicMoveStep` 等) +详见 [dynamic-tile-move.md](./dynamic-tile-move.md) 接口定义汇总,此处不再重复。 + +## 新增接口 + +### IObjectMovable + +```ts +interface IObjectMovable { + readonly x: number; + readonly y: number; + readonly moveDirection: FaceDirection; + readonly faceDirection: FaceDirection; + setPos(x: number, y: number): void; + setMoveDirection(dir: FaceDirection): void; + setFaceDirection(dir: FaceDirection): void; +} +``` + +### IDynamicTile + +```ts +interface IDynamicTile extends IObjectMovable { + readonly num: number; + readonly layer: IDynamicLayer; + readonly mover: IDynamicMover; + delete(): void; + toStatic(): void; + toStaticIfSafe(): boolean; + /** 等价于 mover.step(dir, count); return mover.start(); */ + step(dir: FaceDirection, count?: number): IMoverController | null; +} +``` + +### IDynamicLayerHooks + +```ts +interface IDynamicLayerHooks extends IHookBase { + onCreateTile(tile: IDynamicTile, layer: IDynamicLayer): void; + onDeleteTile(tile: IDynamicTile, layer: IDynamicLayer): void; +} +``` + +### IDynamicLayer + +```ts +interface IDynamicLayer extends IHookable { + createDynamic(num: number, x: number, y: number): IDynamicTile; + transferToDynamic(x: number, y: number): IDynamicTile; + transferToStatic(tile: IDynamicTile): void; + transferToStaticIfSafe(tile: IDynamicTile): boolean; + deleteDynamic(tile: IDynamicTile): void; + getDynamicTilesAt(x: number, y: number): Iterable; + setDynamicDirection(tile: IDynamicTile, direction: FaceDirection): void; + setDynamicPos(tile: IDynamicTile, x: number, y: number): void; + setFaceBinder(binder: IRoleFaceBinder): void; +} +``` + +## 修改接口 + +### IMapLayer(新增属性) + +```ts +interface IMapLayer { + // ...现有成员... + readonly dynamicLayer: IDynamicLayer; +} +``` + +--- + +# 问题 + +1. **`ox, oy` 是否为必要参数?** ✅ 已确定 + + 已确定移除。调用方持有 `IDynamicTile` 引用,坐标直接从 `tile.x`、`tile.y` 读取, + `ox, oy` 为冗余参数,接口简化为 `moveDynamicStep(direction, tile)` 和 + `moveDynamicWith(steps, tile)`。 + +2. **`IRoleFaceBinder` 的注入方式** ✅ 已确定 + + 已确定使用 `setFaceBinder(binder)` 方法注入,不在构造时传入。 + 实际修改 `faceBinder` 的场景极少,接口保持简单。 + +3. **动态图块的存档支持** ⏸ 暂缓 + + 动态图块状态(NPC 当前位置、推箱子位置等)属于游戏核心存档内容, + 长期来看必须纳入存档体系。但当前设计与旧引擎完全不同, + 存档格式需从头设计,建议在动态图块功能稳定后单独立项设计存档方案。 + **本次实现不涉及存档,`IDynamicLayer` 暂不实现 `ISaveableContent`。** + +4. **`IDynamicLayer` 是否需要感知楼层尺寸** ✅ 已确定 + + 已确定不感知。标识方案改为引用,`posMap` 同步改为 + `Map>>` 嵌套结构(外层 key = y,内层 key = x), + 彻底去掉字符串键,天然支持越界坐标,`resizeLayer` 无需通知 `DynamicLayer`。 + `getDynamicTilesAt` 接口保留,使用频率低,嵌套 Map 开销完全可接受。 diff --git a/docs/dev/map-store-improve.md b/docs/dev/map/map-store-improve.md similarity index 100% rename from docs/dev/map-store-improve.md rename to docs/dev/map/map-store-improve.md diff --git a/docs/dev/map-store-save.md b/docs/dev/map/map-store-save.md similarity index 100% rename from docs/dev/map-store-save.md rename to docs/dev/map/map-store-save.md diff --git a/docs/dev/save-system.md b/docs/dev/system/save-system.md similarity index 100% rename from docs/dev/save-system.md rename to docs/dev/system/save-system.md diff --git a/packages-user/data-base/src/common/index.ts b/packages-user/data-base/src/common/index.ts index 5fcbbcb..64a2b6f 100644 --- a/packages-user/data-base/src/common/index.ts +++ b/packages-user/data-base/src/common/index.ts @@ -1,3 +1,4 @@ export * from './face'; +export * from './mover'; export * from './types'; export * from './utils'; diff --git a/packages-user/data-base/src/common/mover.ts b/packages-user/data-base/src/common/mover.ts new file mode 100644 index 0000000..f6eb757 --- /dev/null +++ b/packages-user/data-base/src/common/mover.ts @@ -0,0 +1,579 @@ +import { + Hookable, + HookController, + IHookable, + IHookBase, + IHookController, + ITileLocator +} from '@motajs/common'; +import { FaceDirection } from './types'; + +//#region 对象移动 + +export const enum ObjectMoveStepType { + /** 绝对方向步,同步更新移动方向与朝向 */ + Dir, + /** 绝对方向步,显式指定朝向 */ + DirFace, + /** 速度步 */ + Speed, + /** 纯转向步 */ + Face, + /** 特殊步,如前进或后退 */ + Special, + /** 动画方向步 */ + AnimDir +} + +export const enum ObjectSpecialStep { + /** 前进 */ + Forward, + /** 后退 */ + Backward +} + +export const enum ObjectAnimDirection { + /** 正向播放动画 */ + Forward, + /** 反向播放动画 */ + Backward +} + +export interface IObjectMovable { + /** 当前横坐标 */ + readonly x: number; + /** 当前纵坐标 */ + readonly y: number; + + /** + * 设置对象位置 + * @param x 横坐标 + * @param y 纵坐标 + */ + setPos(x: number, y: number): void; + + /** + * 获取当前朝向 + */ + getCurrentFaceDirection(): FaceDirection; +} + +export interface IObjectMoveStepDir { + /** 步骤类型 */ + type: ObjectMoveStepType.Dir; + /** 本步移动方向 */ + move: FaceDirection; +} + +export interface IObjectMoveStepDirFace { + /** 步骤类型 */ + type: ObjectMoveStepType.DirFace; + /** 本步移动方向 */ + move: FaceDirection; + /** 本步显式朝向 */ + face: FaceDirection; +} + +export interface IObjectMoveStepSpeed { + /** 步骤类型 */ + type: ObjectMoveStepType.Speed; + /** 后续移动的每格耗时,单位为 ms */ + value: number; +} + +export interface IObjectMoveStepFace { + /** 步骤类型 */ + type: ObjectMoveStepType.Face; + /** 要设置的朝向 */ + value: FaceDirection; +} + +export interface IObjectMoveStepSpecial { + /** 步骤类型 */ + type: ObjectMoveStepType.Special; + /** 特殊步方向 */ + direction: ObjectSpecialStep; +} + +export interface IObjectMoveAnimDir { + /** 步骤类型 */ + type: ObjectMoveStepType.AnimDir; + /** 动画播放方向 */ + dir: ObjectAnimDirection; +} + +export type ObjectMoveStep = + | IObjectMoveStepDir + | IObjectMoveStepDirFace + | IObjectMoveStepSpeed + | IObjectMoveStepFace + | IObjectMoveStepSpecial + | IObjectMoveAnimDir; + +export interface IMoverController { + /** 本次移动是否已经全部完成 */ + done: boolean; + /** 当本次移动结束时兑现 */ + onEnd: Promise; + + /** + * 向当前移动队列末尾追加步骤 + * @param steps 要追加的步骤列表 + */ + push(...steps: ObjectMoveStep[]): void; + + /** + * 在当前步移动之后立刻插入指定步,顺序为参数传入的顺序 + * @param steps 要插入的步骤列表 + */ + insert(...steps: ObjectMoveStep[]): void; + + /** + * 停止当前移动,在当前步骤完成后兑现 + */ + stop(): Promise; +} + +export interface IObjectMoverHooks extends IHookBase { + /** + * 当移动开始时触发 + * @param tile 移动器绑定的图块 + * @param mover 当前移动器 + */ + onMoveStart?(tile: T, mover: IObjectMover): Promise; + + /** + * 当移动结束时触发 + * @param tile 移动器绑定的图块 + * @param mover 当前移动器 + */ + onMoveEnd?(tile: T, mover: IObjectMover): Promise; + + /** + * 当单步移动开始前触发,此时对象坐标仍为移动前坐标 + * @param code 当前步移动代码 + * @param step 当前步骤 + * @param tile 移动器绑定的图块 + * @param mover 当前移动器 + */ + onStepStart?( + code: number, + step: ObjectMoveStep, + tile: T, + mover: IObjectMover + ): Promise; + + /** + * 当单步移动结束后触发,此时对象坐标已更新为移动后坐标 + * @param code 当前步移动代码 + * @param step 当前步骤 + * @param tile 移动器绑定的图块 + * @param mover 当前移动器 + */ + onStepEnd?( + code: number, + step: ObjectMoveStep, + tile: T, + mover: IObjectMover + ): Promise; +} + +export interface IObjectMover extends IHookable< + IObjectMoverHooks +> { + /** 当前是否正在移动 */ + readonly moving: boolean; + /** 当前绑定的对象 */ + readonly tile: T; + /** 当前朝向 */ + readonly faceDirection: FaceDirection; + /** 当前移动方向 */ + readonly moveDirection: FaceDirection; + /** 当前动画播放方向 */ + readonly currAnimDir: ObjectAnimDirection; + /** 当前移动速度,单位毫秒 */ + readonly currentSpeed: number; + + /** + * 追加若干个绝对方向步,并同步更新移动方向与朝向 + * @param dir 移动方向 + * @param count 追加次数,默认 1 + */ + step(dir: FaceDirection, count?: number): this; + + /** + * 追加若干个绝对方向步,移动方向与朝向分别指定 + * @param move 移动方向 + * @param face 朝向方向 + * @param count 追加次数,默认 1 + */ + stepFace(move: FaceDirection, face: FaceDirection, count?: number): this; + + /** + * 追加若干个前进步,沿当前移动方向移动 + * @param count 追加次数,默认 1 + */ + forward(count?: number): this; + + /** + * 追加若干个后退步,沿当前移动方向的反方向移动 + * @param count 追加次数,默认 1 + */ + backward(count?: number): this; + + /** + * 设置后续移动速度 + * @param value 每格耗时,单位为 ms + */ + speed(value: number): this; + + /** + * 追加一个纯转向步骤 + * @param dir 目标朝向 + */ + face(dir: FaceDirection): this; + + /** + * 设置后续步骤的动画播放方向 + * @param dir 动画播放方向 + */ + animDir(dir: ObjectAnimDirection): this; + + /** + * 清空尚未执行的步骤队列 + */ + clear(): this; + + /** + * 开始执行当前计划队列 + * @returns 若当前已在移动,则返回 `null` + */ + start(): Readonly | null; +} + +//#endregion + +//#region 移动基类 + +export abstract class ObjectMover + extends Hookable> + implements IObjectMover +{ + abstract readonly tile: T; + + /** 尚未开始执行的移动步骤队列 */ + protected readonly moveQueue: Readonly[] = []; + + /** 当前是否正在移动 */ + moving: boolean = false; + /** 当前朝向 */ + faceDirection: FaceDirection = FaceDirection.Unknown; + /** 当前移动方向 */ + moveDirection: FaceDirection = FaceDirection.Unknown; + /** 当前动画播放方向 */ + currAnimDir: ObjectAnimDirection = ObjectAnimDirection.Forward; + /** 当前移动速度,单位毫秒 */ + currentSpeed: number = 100; + + /** 是否调用了 `IMoverController.stop` 接口 */ + private shouldStop: boolean = false; + + protected createController( + hook: Partial> + ): IHookController> { + return new HookController(this, hook); + } + + /** + * 当移动开始时执行 + * @param tile 移动图块 + * @param controller 移动控制器 + */ + protected abstract onMoveStart( + tile: T, + controller: Readonly + ): Promise; + + /** + * 当移动结束时触发 + * @param tile 移动图块 + * @param controller 移动控制器 + */ + protected abstract onMoveEnd( + tile: T, + controller: Readonly + ): Promise; + + /** + * 当单步移动开始时触发,返回移动代码,此移动代码将会传递至 {@link onStepEnd} + * @param step 当前移动步对象 + * @param tile 移动图块 + * @param controller 移动控制器 + */ + protected abstract onStepStart( + step: ObjectMoveStep, + tile: T, + controller: Readonly + ): Promise; + + /** + * 当单步移动结束时触发,返回坐标对象代表这一步移动结果 + * @param code 移动代码,由 {@link onStepStart} 返回值传递而来 + * @param step 当前移动步对象 + * @param tile 移动图块 + * @param controller 移动控制器 + */ + protected abstract onStepEnd( + code: number, + step: ObjectMoveStep, + tile: T, + controller: Readonly + ): Promise; + + /** + * 向计划队列末尾追加一个步骤 + * @param step 要追加的步骤 + */ + protected pushStep(step: Readonly): void { + this.moveQueue.push(step); + } + + /** + * 获取当前应当作为相对移动基准的方向 + */ + private getCurrentDirection(): FaceDirection { + if (this.moveDirection !== FaceDirection.Unknown) { + return this.moveDirection; + } else { + return this.faceDirection; + } + } + + // TODO: 需要做一个朝向系统以解决朝向难以处理的问题 + /** + * 获取指定方向的反方向 + * @param dir 当前方向 + */ + private getOppositeDirection(dir: FaceDirection): FaceDirection { + switch (dir) { + case FaceDirection.Left: + return FaceDirection.Right; + case FaceDirection.Up: + return FaceDirection.Down; + case FaceDirection.Right: + return FaceDirection.Left; + case FaceDirection.Down: + return FaceDirection.Up; + case FaceDirection.LeftUp: + return FaceDirection.RightDown; + case FaceDirection.RightUp: + return FaceDirection.LeftDown; + case FaceDirection.LeftDown: + return FaceDirection.RightUp; + case FaceDirection.RightDown: + return FaceDirection.LeftUp; + case FaceDirection.Unknown: + return FaceDirection.Unknown; + } + } + + /** + * 根据步骤内容预先同步移动器内部状态 + * @param step 当前步骤 + */ + private prepareStep(step: ObjectMoveStep): void { + switch (step.type) { + case ObjectMoveStepType.Dir: + this.moveDirection = step.move; + this.faceDirection = step.move; + break; + case ObjectMoveStepType.DirFace: + this.moveDirection = step.move; + this.faceDirection = step.face; + break; + case ObjectMoveStepType.Face: + this.faceDirection = step.value; + break; + case ObjectMoveStepType.Special: { + const dir = this.getCurrentDirection(); + if (step.direction === ObjectSpecialStep.Backward) { + const opposite = this.getOppositeDirection(dir); + this.moveDirection = opposite; + this.faceDirection = opposite; + } else { + this.moveDirection = dir; + this.faceDirection = dir; + } + break; + } + case ObjectMoveStepType.AnimDir: + this.currAnimDir = step.dir; + break; + case ObjectMoveStepType.Speed: + this.currentSpeed = step.value; + break; + } + } + + step(dir: FaceDirection, count: number = 1): this { + for (let i = 0; i < count; i++) { + this.pushStep({ + type: ObjectMoveStepType.Dir, + move: dir + }); + } + return this; + } + + stepFace( + move: FaceDirection, + face: FaceDirection, + count: number = 1 + ): this { + for (let i = 0; i < count; i++) { + this.pushStep({ + type: ObjectMoveStepType.DirFace, + move, + face + }); + } + return this; + } + + forward(count: number = 1): this { + for (let i = 0; i < count; i++) { + this.pushStep({ + type: ObjectMoveStepType.Special, + direction: ObjectSpecialStep.Forward + }); + } + return this; + } + + backward(count: number = 1): this { + for (let i = 0; i < count; i++) { + this.pushStep({ + type: ObjectMoveStepType.Special, + direction: ObjectSpecialStep.Backward + }); + } + return this; + } + + speed(value: number): this { + this.pushStep({ + type: ObjectMoveStepType.Speed, + value + }); + return this; + } + + face(dir: FaceDirection): this { + this.pushStep({ + type: ObjectMoveStepType.Face, + value: dir + }); + return this; + } + + animDir(dir: ObjectAnimDirection): this { + this.pushStep({ + type: ObjectMoveStepType.AnimDir, + dir + }); + return this; + } + + clear(): this { + this.moveQueue.length = 0; + return this; + } + + /** + * 开始移动流程 + * @param queue 移动队列 + */ + private async moveProgress( + queue: ObjectMoveStep[], + controller: Readonly + ) { + // 移动开始 + await this.onMoveStart(this.tile, controller); + await Promise.all( + this.forEachHook(hook => { + return hook.onMoveStart?.(this.tile, this); + }) + ); + + // 移动流程 + while (queue.length > 0) { + const step = queue.shift(); + if (!step || !this.moving || this.shouldStop) break; + this.prepareStep(step); + const code = await this.onStepStart(step, this.tile, controller); + const stepStartHooks = this.forEachHook(hook => + hook.onStepStart?.(code, step, this.tile, this) + ); + await Promise.all(stepStartHooks); + const loc = await this.onStepEnd(code, step, this.tile, controller); + this.tile.setPos(loc.x, loc.y); + const stepEndHooks = this.forEachHook(hook => + hook.onStepEnd?.(code, step, this.tile, this) + ); + await Promise.all(stepEndHooks); + } + + // 移动结束 + await this.onMoveEnd(this.tile, controller); + const moveEndHooks = this.forEachHook(hook => + hook.onMoveEnd?.(this.tile, this) + ); + await Promise.all(moveEndHooks); + } + + start(): IMoverController | null { + if (this.moving) return null; + + const queue = this.moveQueue.slice(); + this.clear(); + this.shouldStop = false; + + this.faceDirection = this.tile.getCurrentFaceDirection(); + this.moveDirection = FaceDirection.Unknown; + + const { promise, resolve } = Promise.withResolvers(); + + const controller: IMoverController = { + done: false, + onEnd: promise, + push: (...steps: ObjectMoveStep[]) => { + if (!this.moving || this.shouldStop || controller.done) { + return; + } + queue.push(...steps); + }, + insert: (...steps: ObjectMoveStep[]) => { + if (!this.moving || this.shouldStop || controller.done) { + return; + } + queue.unshift(...steps); + }, + stop: () => { + this.shouldStop = true; + return controller.onEnd; + } + }; + + this.moving = true; + const moving = this.moveProgress(queue, controller); + moving.then(() => { + this.moving = false; + controller.done = true; + resolve(); + }); + + return controller; + } +} + +//#endregion diff --git a/packages-user/data-base/src/map/dynamicLayer.ts b/packages-user/data-base/src/map/dynamicLayer.ts new file mode 100644 index 0000000..31a4026 --- /dev/null +++ b/packages-user/data-base/src/map/dynamicLayer.ts @@ -0,0 +1,142 @@ +import { + HookController, + Hookable, + IHookController, + ITileLocator, + logger +} from '@motajs/common'; +import { + IDynamicLayer, + IDynamicLayerHooks, + IDynamicTile, + IMapLayer +} from './types'; +import { FaceDirection, degradeFace } from '../common'; +import { DynamicTile } from './dynamicTile'; + +export class DynamicLayer + extends Hookable + implements IDynamicLayer +{ + /** 坐标到动态图块集合的映射,外层 key = y,内层 key = x,不使用 index 是为了支持地图外图块 */ + private readonly tilePosMap: Map>> = + new Map(); + /** 动态图块到其当前坐标的映射 */ + private readonly posTileMap: Map = new Map(); + + constructor(public readonly layer: IMapLayer) { + super(); + } + + protected createController( + hook: Partial + ): IHookController { + return new HookController(this, hook); + } + + createDynamic(num: number, x: number, y: number): IDynamicTile { + const tile = new DynamicTile(num, x, y, this); + this.addTileToPosMap(tile, x, y); + this.posTileMap.set(tile, { x, y }); + this.forEachHook(hook => hook.onCreateTile?.(tile, this)); + return tile; + } + + transferToDynamic(x: number, y: number): IDynamicTile { + const num = this.layer.getBlock(x, y); + if (num === 0) { + logger.warn(127, x.toString(), y.toString()); + } + this.layer.setBlock(0, x, y); + return this.createDynamic(num, x, y); + } + + transferToStatic(tile: IDynamicTile): void { + const { x, y } = tile; + const { width, height } = this.layer; + if (x < 0 || y < 0 || x >= width || y >= height) { + logger.warn(128, x.toString(), y.toString()); + return; + } + if (this.layer.getBlock(x, y) !== 0) { + logger.warn(129, x.toString(), y.toString()); + } + this.layer.setBlock(tile.num, x, y); + this.removeTile(tile); + this.forEachHook(hook => { + void hook.onDeleteTile?.(tile, this); + }); + } + + transferToStaticIfSafe(tile: IDynamicTile): boolean { + if (this.layer.getBlock(tile.x, tile.y) !== 0) return false; + this.layer.setBlock(tile.num, tile.x, tile.y); + this.deleteDynamic(tile); + return true; + } + + async deleteDynamic(tile: IDynamicTile): Promise { + if (!this.posTileMap.has(tile)) { + logger.warn(130); + return; + } + this.removeTile(tile); + const hooks = this.forEachHook(hook => hook.onDeleteTile?.(tile, this)); + await Promise.all(hooks); + } + + getDynamicTilesAt(x: number, y: number): Iterable { + return this.tilePosMap.get(y)?.get(x) ?? new Set(); + } + + iterateDynamicTiles(): Iterable { + return this.posTileMap.keys(); + } + + setDynamicDirection(tile: IDynamicTile, direction: FaceDirection): void { + const numBefore = tile.num; + tile.setFaceDirection(direction); + if (tile.num !== numBefore) return; + const degraded = degradeFace(direction); + if (degraded !== direction) { + tile.setFaceDirection(degraded); + } + } + + updateDynamicTile(tile: IDynamicTile): void { + const oldPos = this.posTileMap.get(tile); + if (oldPos) { + this.removeTileFromPosMap(tile, oldPos.x, oldPos.y); + oldPos.x = tile.x; + oldPos.y = tile.y; + this.addTileToPosMap(tile, tile.x, tile.y); + } else { + this.addTileToPosMap(tile, tile.x, tile.y); + this.posTileMap.set(tile, { x: tile.x, y: tile.y }); + } + this.forEachHook(hook => hook.onUpdateTilePosition?.(tile, this)); + } + + private addTileToPosMap(tile: IDynamicTile, x: number, y: number): void { + const xMap = this.tilePosMap.getOrInsertComputed(y, () => new Map()); + const set = xMap.getOrInsertComputed(x, () => new Set()); + set.add(tile); + } + + private removeTileFromPosMap( + tile: IDynamicTile, + x: number, + y: number + ): void { + this.tilePosMap.get(y)?.get(x)?.delete(tile); + } + + /** 从两个内部映射中移除图块记录 */ + private removeTile(tile: IDynamicTile): void { + const pos = this.posTileMap.get(tile); + if (pos) { + this.removeTileFromPosMap(tile, pos.x, pos.y); + } + this.posTileMap.delete(tile); + } +} diff --git a/packages-user/data-base/src/map/dynamicTile.ts b/packages-user/data-base/src/map/dynamicTile.ts new file mode 100644 index 0000000..f4702ed --- /dev/null +++ b/packages-user/data-base/src/map/dynamicTile.ts @@ -0,0 +1,72 @@ +import { isNil } from 'lodash-es'; +import { + FaceDirection, + IMoverController, + IObjectMover, + IRoleFaceBinder +} from '../common'; +import { IDynamicLayer, IDynamicTile } from './types'; +import { DynamicTileMover } from './mover'; + +export class DynamicTile implements IDynamicTile { + readonly mover: IObjectMover; + + /** 当前的朝向绑定对象 */ + private face: IRoleFaceBinder | null = null; + + constructor( + public num: number, + public x: number, + public y: number, + public readonly layer: IDynamicLayer + ) { + this.mover = new DynamicTileMover(this); + } + + setFaceBinder(binder: IRoleFaceBinder | null): void { + this.face = binder; + } + + setFaceDirection(direction: FaceDirection): number { + if (!this.face) return this.num; + const next = this.face.getFaceOf(this.num, direction); + if (next) { + this.num = next.identifier; + } + return this.num; + } + + delete(): Promise { + return this.layer.deleteDynamic(this); + } + + toStatic(): void { + this.layer.transferToStatic(this); + } + + toStaticIfSafe(): boolean { + return this.layer.transferToStaticIfSafe(this); + } + + step(dir: FaceDirection, count?: number): IMoverController | null { + if (this.mover.moving) return null; + this.mover.step(dir, count); + return this.mover.start(); + } + + setPos(x: number, y: number): void { + this.x = x; + this.y = y; + this.layer.updateDynamicTile(this); + } + + getCurrentFaceDirection(): FaceDirection { + if (this.face) { + const face = this.face.getFaceDirection(this.num); + if (isNil(face)) return FaceDirection.Unknown; + else return face; + } else { + return FaceDirection.Down; + } + } +} diff --git a/packages-user/data-base/src/map/index.ts b/packages-user/data-base/src/map/index.ts index 8a6081a..55e9fdb 100644 --- a/packages-user/data-base/src/map/index.ts +++ b/packages-user/data-base/src/map/index.ts @@ -1,4 +1,5 @@ export * from './layerState'; export * from './mapLayer'; export * from './mapStore'; +export * from './mover'; export * from './types'; diff --git a/packages-user/data-base/src/map/mapLayer.ts b/packages-user/data-base/src/map/mapLayer.ts index 326c4cf..372d468 100644 --- a/packages-user/data-base/src/map/mapLayer.ts +++ b/packages-user/data-base/src/map/mapLayer.ts @@ -1,11 +1,13 @@ import { isNil } from 'lodash-es'; import { + IDynamicLayer, IMapLayer, IMapLayerData, IMapLayerHookController, IMapLayerHooks } from './types'; import { Hookable, HookController, logger } from '@motajs/common'; +import { DynamicLayer } from './dynamicLayer'; // todo: 提供 core.setBlock 等方法的替代方法,同时添加 setBlockList,以及前景背景的接口 @@ -23,6 +25,8 @@ export class MapLayer /** 地图数据引用 */ private mapData: IMapLayerData; + readonly dynamicLayer: IDynamicLayer; + constructor(array: Uint32Array, width: number, height: number) { super(); this.width = width; @@ -35,6 +39,7 @@ export class MapLayer expired: false, array: this.mapArray }; + this.dynamicLayer = new DynamicLayer(this); } resize(width: number, height: number): void { diff --git a/packages-user/data-base/src/map/mover.ts b/packages-user/data-base/src/map/mover.ts new file mode 100644 index 0000000..c6cd03a --- /dev/null +++ b/packages-user/data-base/src/map/mover.ts @@ -0,0 +1,78 @@ +import { ITileLocator, logger } from '@motajs/common'; +import { + getFaceMovement, + ObjectMover, + ObjectMoveStep, + ObjectMoveStepType +} from '../common'; +import { IDynamicTile } from './types'; + +//#region 动态图块 + +const enum DynamicMoveCode { + /** 正常执行 */ + Success +} + +export class DynamicTileMover extends ObjectMover { + constructor(public readonly tile: IDynamicTile) { + super(); + } + + protected onMoveStart(): Promise { + return Promise.resolve(); + } + + protected onMoveEnd(): Promise { + return Promise.resolve(); + } + + protected onStepStart(): Promise { + return Promise.resolve(DynamicMoveCode.Success); + } + + protected onStepEnd( + code: number, + step: ObjectMoveStep, + tile: IDynamicTile + ): Promise { + if (code !== DynamicMoveCode.Success) { + logger.warn(126, 'DynamicMoveCode.Success (0)', code.toString()); + return Promise.resolve({ x: tile.x, y: tile.y }); + } + const locator: ITileLocator = { + x: tile.x, + y: tile.y + }; + switch (step.type) { + case ObjectMoveStepType.Dir: { + const { x, y } = getFaceMovement(step.move); + tile.setFaceDirection(step.move); + locator.x += x; + locator.y += y; + break; + } + case ObjectMoveStepType.DirFace: { + const { x, y } = getFaceMovement(step.move); + tile.setFaceDirection(step.face); + locator.x += x; + locator.y += y; + break; + } + case ObjectMoveStepType.Face: { + tile.setFaceDirection(step.value); + break; + } + case ObjectMoveStepType.Special: { + const { x, y } = getFaceMovement(this.moveDirection); + tile.setFaceDirection(this.faceDirection); + locator.x += x; + locator.y += y; + break; + } + } + return Promise.resolve(locator); + } +} + +//#endregion diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index 47f0bfc..49e6da5 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -1,5 +1,14 @@ import { IHookable, IHookBase, IHookController } from '@motajs/common'; -import { ISaveableContent } from '../common'; +import { + FaceDirection, + IMoverController, + IObjectMovable, + IObjectMover, + IRoleFaceBinder, + ISaveableContent +} from '../common'; + +//#region 静态图层 export interface IMapLayerData { /** 当前引用是否过期,当地图图层内部的地图数组引用更新时,此项会变为 `true` */ @@ -75,6 +84,9 @@ export interface IMapLayer extends IHookable< /** 图层纵深 */ readonly zIndex: number; + /** 此图层对应的动态图块图层,z 层级与静态图块一致 */ + readonly dynamicLayer: IDynamicLayer; + /** * 设置某一点的图块 * @param block 图块数字 @@ -154,6 +166,10 @@ export interface IMapLayer extends IHookable< setMapRef(array: Uint32Array): void; } +//#endregion + +//#region 图层管理 + export interface ILayerStateHooks extends IHookBase { /** * 当设置背景图块时执行,如果设置的背景图块与原先一样,则不会执行 @@ -288,6 +304,10 @@ export interface ILayerState extends IHookable { setDirty(dirty: boolean): void; } +//#endregion + +//#region 楼层管理 + /** 单个 MapLayer 的存档数据 */ export interface IMapLayerSave { readonly width: number; @@ -428,3 +448,149 @@ export interface IMapStore extends ISaveableContent { */ notifyEnterFloor(id: string): void; } + +//#endregion + +//#region 动态图块 + +export interface IDynamicLayerHooks extends IHookBase { + /** + * 当图块被创建(含从静态图块转换)时触发 + * @param tile 被创建的动态图块 + * @param layer 所属的动态图层 + */ + onCreateTile(tile: IDynamicTile, layer: IDynamicLayer): void; + + /** + * 当图块被删除时触发 + * @param tile 被删除的动态图块 + * @param layer 所属的动态图层 + */ + onDeleteTile(tile: IDynamicTile, layer: IDynamicLayer): Promise; + + /** + * 当更新动态图块的位置时触发(包括使用 `mover` 触发的移动) + * @param tile 更新位置的图块 + * @param layer 所属的动态图层 + */ + onUpdateTilePosition(tile: IDynamicTile, layer: IDynamicLayer): void; +} + +export interface IDynamicLayer extends IHookable { + /** 当前动态图层所属的静态图层 */ + readonly layer: IMapLayer; + + /** + * 在指定位置创建一个动态图块 + * @param num 图块数字 + * @param x 横坐标 + * @param y 纵坐标 + * @returns 创建的动态图块引用 + */ + createDynamic(num: number, x: number, y: number): IDynamicTile; + + /** + * 从所属静态图层读取并清除指定位置的图块,创建对应动态图块并返回引用。 + * 若该位置图块为 0,则发出警告并仍然创建 `num = 0` 的动态图块 + * @param x 横坐标 + * @param y 纵坐标 + * @returns 创建的动态图块引用 + */ + transferToDynamic(x: number, y: number): IDynamicTile; + + /** + * 将动态图块还原为静态图块。坐标越界则警告并放弃, + * 否则写回静态图层并触发 {@link IDynamicLayerHooks.onDeleteTile} + * @param tile 要还原的动态图块 + */ + transferToStatic(tile: IDynamicTile): void; + + /** + * 仅当目标位置静态图块为 0(空白)时才还原为静态图块,否则不转换 + * @param tile 要还原的动态图块 + * @returns 是否转换成功 + */ + transferToStaticIfSafe(tile: IDynamicTile): boolean; + + /** + * 删除指定动态图块,触发 {@link IDynamicLayerHooks.onDeleteTile} 钩子。 + * 若图块不属于此层则发出警告 + * @param tile 要删除的动态图块 + */ + deleteDynamic(tile: IDynamicTile): Promise; + + /** + * 获取指定格点上所有动态图块的可迭代对象 + * @param x 横坐标 + * @param y 纵坐标 + */ + getDynamicTilesAt(x: number, y: number): Iterable; + + /** + * 迭代所有的动态图块 + */ + iterateDynamicTiles(): Iterable; + + /** + * 手动设置动态图块的朝向,更新 `tile.num`(若有朝向绑定)。 + * 转向逻辑与移动时的转向逻辑相同,但不触发移动 + * @param tile 要设置朝向的动态图块 + * @param direction 目标朝向 + */ + setDynamicDirection(tile: IDynamicTile, direction: FaceDirection): void; + + /** + * 更新图块内部存储位置 + * @param tile 动态图块 + */ + updateDynamicTile(tile: IDynamicTile): void; +} + +export interface IDynamicTile extends IObjectMovable { + /** 当前图块数字 */ + readonly num: number; + /** 当前图块所属的动态图层 */ + readonly layer: IDynamicLayer; + /** 当前动态图块的移动器 */ + readonly mover: IObjectMover; + + /** + * 设置图块朝向,会一并修改 {@link num},返回设置后的当前图块数字 + * @param direction 图块朝向 + */ + setFaceDirection(direction: FaceDirection): number; + + /** + * 直接删除此图块 + */ + delete(): Promise; + + /** + * 将当前图块还原为静态图块 + */ + toStatic(): void; + + /** + * 还原为静态图块,如果当前位置有东西则不转换 + */ + toStaticIfSafe(): boolean; + + /** + * 单步便捷移动接口,适用于简单移动场景,复杂路径通过 `tile.mover` 访问。 + * 等价于: + * + * ```ts + * mover.step(dir, count); + * return mover.start(); + * ``` + */ + step(dir: FaceDirection, count?: number): IMoverController | null; + + /** + * 注入朝向绑定器,初始状态视为无朝向绑定 + * @param binder 朝向绑定器 + */ + setFaceBinder(binder: IRoleFaceBinder | null): void; +} + +//#endregion diff --git a/packages-user/data-state/src/enemy/calculator.ts b/packages-user/data-state/src/enemy/calculator.ts index 364ba32..4831ba6 100644 --- a/packages-user/data-state/src/enemy/calculator.ts +++ b/packages-user/data-state/src/enemy/calculator.ts @@ -16,10 +16,6 @@ export class MainDamageCalculator implements IDamageCalculator< /** 当前是否正在计算支援怪的伤害 */ private inGuard: boolean = false; - /** - * 计算战斗伤害信息 - * @param handler 信息对象 - */ calculate( handler: IReadonlyEnemyHandler ): IEnemyDamageInfo { @@ -153,11 +149,6 @@ export class MainDamageCalculator implements IDamageCalculator< }; } - /** - * 获取临界计算的上界 - * @param handler 信息对象 - * @param attribute 目标属性名 - */ getCriticalLimit( handler: IReadonlyEnemyHandler, attribute: CriticalableHeroStatus diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 20fe5f9..571c3b9 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -183,6 +183,11 @@ "123": "MapLayer.setMapRef: array length $1 does not match expected size $2, setMapRef will be ignored.", "124": "MapStore.loadState: floor '$1' or its layer(s) not found in current reference data, skipping.", "125": "Expected sorted floor id array has a same floor id set, but an array with a different floor id set is returned.", + "126": "Only move code '$1' is expected, but got '$2'.", + "127": "Block at $1,$2 is 0, the dynamic tile will have num 0.", + "128": "Position $1,$2 is out of map bounds, operation cancelled.", + "129": "Position $1,$2 is not empty, existing block will be overwritten.", + "130": "The given tile is not managed by this dynamic layer.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } diff --git a/prompt.md b/prompt.md index 1d7a51f..f0bd64b 100644 --- a/prompt.md +++ b/prompt.md @@ -2,11 +2,12 @@ 以下规则必须时刻遵守,任何情况下都不允许违反。 -1. **不擅自修改已有代码**:将我已经写好的代码视为绝对正确。除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。若认为我的代码存在逻辑错误,应在对话中提出,而不是直接修改。 +1. **不擅自修改已有代码**:将我已经写好的代码视为绝对正确。除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。若认为我的代码存在逻辑错误,应在对话中提出,而不是直接修改,不要做任何“顺手”的事。 2. **不恢复我的修改**:我做的任何代码修改都是有原因的。若我在两次对话期间新增、删除或修改了部分代码,不要将其恢复。 3. **以目的驱动,而非以接口驱动**:实现前先想清楚我为什么要这样设计接口、这个接口设计的目的是什么,而不是单纯地以将接口填满为目标。 4. **遇到歧义立即提问**:若思考或实现时遇到任何问题——例如描述模糊、接口不清晰、某些地方存在歧义等——应立即向我提问,而不是按自己的想法去写。 -5. **按我说的方式重构**:若目标是重构某个接口,按照我指定的方式执行: +5. **接口缺失时停止并提问**:若完成需求所需的接口尚不存在,应立即停止实现,向我提出疑问,而不是擅自新增接口来推进。 +6. **按我说的方式重构**:若目标是重构某个接口,按照我指定的方式执行: - **彻底性重构**(新旧接口完全没有重合):按正常方式全新实现,旧代码仅作逻辑与思路上的参考。 - **结构性重构**(新旧接口基本一致,细节有差距):将旧代码搬移到新接口上后进行微调。**不要**擅自新增任何参数、方法或接口,**不要**仅通过新增兼容层的方式应对重构。 @@ -17,6 +18,8 @@ 1. **合理参考建议**:我有时会在对话中给出实现建议,应合理参考,切忌滥用。 2. **以类型标注为参考依据**:实现与类型标注有冲突时,以类型标注(一般是 `types.ts`)中的内容为准。 3. **发现接口问题时提问**:若认为类型标注中的接口设计有问题,或在实现中发现缺少某些接口,应向我提问是否添加,经我同意后方可添加。 +4. **接口设计兼顾合理性与便捷性**:设计接口时不仅要考虑合理性,还要考虑使用便捷性。罕见场景应当被支持,但不应与常见场景共用同一接口——这只会增加常见场景的使用难度。 +5. **避免多余的非空判断与类型守卫**:若某个类型已满足目标的类型约束,不应再对其添加任何判断或过滤操作。典型例子:`Promise.all` 对数组元素类型没有任何限制,传入 `(Promise | void)[]` 完全合法,无需多此一举地写成 `Promise.all(arr.filter(v => !!v))`。 **时刻谨记上述要求,避免一个需求反复修改仍无法满足预期。** @@ -29,7 +32,7 @@ ## 示例文档 -大致按照以下格式编写,如某部分需要详细描述,可单独开设标题。我会使用引用块的形式在文档中提出建议或回答。 +大致按照以下格式编写,如某部分需要详细描述,可单独开设标题;若某个接口内容较多,也可以在文档中为其单独开一个章节进行讲述。我会使用引用块的形式在文档中提出建议或回答。Markdown 文档不需要刻意换行,我的编辑器有自动换行功能,正常写没有问题。 ```md # 需求综述 From 8ea0c12024065d11af4855b587fbdb7a553f6bc6 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Tue, 12 May 2026 15:20:50 +0800 Subject: [PATCH 10/26] =?UTF-8?q?refactor:=20=E6=96=B0=E5=A2=9E=E6=9C=9D?= =?UTF-8?q?=E5=90=91=E7=B3=BB=E7=BB=9F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/common/face-manager.md | 85 ++++++ .../data-base/src/common/faceManager.ts | 282 ++++++++++++++++++ packages-user/data-base/src/common/index.ts | 1 + packages-user/data-base/src/types.ts | 4 +- packages-user/data-state/src/core.ts | 19 +- 5 files changed, 388 insertions(+), 3 deletions(-) create mode 100644 docs/dev/common/face-manager.md create mode 100644 packages-user/data-base/src/common/faceManager.ts diff --git a/docs/dev/common/face-manager.md b/docs/dev/common/face-manager.md new file mode 100644 index 0000000..a22c7a3 --- /dev/null +++ b/docs/dev/common/face-manager.md @@ -0,0 +1,85 @@ +# 需求综述 + +动态图块移动功能完成后,发现 `FaceDirection` 朝向相关操作(位移、反方向、旋转方向、降级)分散在独立工具函数中(`getFaceMovement`、`nextFaceDirection`、`degradeFace` 等),缺乏统一抽象,导致调用点分散、扩展性不足(例如:四方向与八方向切换时需要手动处理,不同移动场景难以共享同一套逻辑)。 + +目标是设计一套统一的朝向管理接口:`IFaceHandler` 代表一组朝向并提供相应操作,`IFaceManager` 作为注册中心管理多个 handler,同时内置两个 handler 分别对应四方向和八方向。新接口位于 `@user/data-base/src/common/`,与 `FaceDirection` 同包,同时取代现有的 `DirectionMapper`。 + +# 实现思路 + +## 1. 设计 IFaceHandler 接口 + +`IFaceHandler` 代表**一组朝向**,泛型 `T` 表示本组的朝向类型(通常为 `FaceDirection`,也可以是自定义枚举以支持拓展)。内部隐含一个该组支持的方向集合,通过 `directions` 成员暴露。对于不在集合内的输入方向,通过 `degrade` 方法将其映射到集合内最合适的方向,其余操作方法在调用时**均先执行 degrade**。 + +`mapDirection` 同时取代 `DirectionMapper.map()` 的功能,不再需要单独维护 `DirectionMapper`。 + +主要成员与方法: + +- `degrade(dir: number): T`:将任意朝向值(含其他枚举类型或 `FaceDirection`)降级为本组支持的方向。对于无法合理降级的方向(包括 `Unknown`),返回 `FaceDirection.Unknown`(数值 `0`,兼容所有 `T`)。 + +- `movement(dir: number): IFaceDescriptor`:获取指定方向的坐标偏移量,输入先经过 `degrade`,`Unknown` 返回 `{ x: 0, y: 0 }`。 + +- `move(dir: number, count: number): IFaceDescriptor`:获取指定方向走 `count` 步的坐标偏移量,等价于 `movement * count`。`count` 允许为负数,表示反向位移。输入先经过 `degrade`。 + +- `opposite(dir: number): T`:获取本组内的反方向,输入先经过 `degrade`,`Unknown` 返回 `Unknown`。 + +- `next(dir: number, anticlockwise?: boolean): T`:在本组方向集合内,顺时针(默认)或逆时针旋转一步,输入先经过 `degrade`,`Unknown` 返回 `Unknown`。 + +- `mapDirection(): Iterable`:迭代本组支持的所有朝向,包含 `Unknown`(其与其他方向一视同仁,不作特例处理)。 + +- `mapMovement(): Iterable<[T, IFaceDescriptor]>`:迭代本组所有朝向及其对应的坐标描述器,包含 `Unknown`(对应 `{ x: 0, y: 0 }`)。 + +## 2. 设计 IFaceManager 接口 + +`IFaceManager` 是 handler 的注册中心,同时支持数字 key 与字符串 id 两种注册与查找方式。数字 key 适合内置组的高频调用,字符串 id 适合使用频率较低的自定义场景: + +- `register(group: number, handler: IFaceHandler): void`:以数字 key 注册一个 handler。 +- `registerById(id: string, handler: IFaceHandler): void`:以字符串 id 注册一个 handler。 +- `get(group: number): IFaceHandler | null`:按数字 key 查找 handler,未找到返回 `null`。 +- `getById(id: string): IFaceHandler | null`:按字符串 id 查找 handler,未找到返回 `null`。 + +内置的数字 key 组用新增的 `InternalFaceGroup` 枚举标识(与现有的 `InternalDirectionGroup` 风格一致)。 + +## 3. 内置 Handler 实现 + +### Dir8FaceHandler(八方向) + +- `directions`:包含全部八个有效方向与 `Unknown`,共九个成员。 +- `degrade`:直接返回输入(转为 `T`),无需降级。 +- `next`:`Unknown` 返回 `Unknown`;按 45° 步进,顺时针顺序:Up → RightUp → Right → RightDown → Down → LeftDown → Left → LeftUp → Up。 +- `opposite`:`Unknown` 返回 `Unknown`;Up↔Down,Left↔Right,LeftUp↔RightDown,RightUp↔LeftDown。 +- `movement`:与现有 `getFaceMovement` 一致。 + +### Dir4FaceHandler(四方向) + +- `directions`:包含 Up、Down、Left、Right 四个方向与 `Unknown`,共五个成员。 +- `degrade`:四方向不变;斜向降级为水平分量(LeftUp/LeftDown → Left,RightUp/RightDown → Right);`Unknown` → `Unknown`。与现有 `degradeFace` 行为一致。 +- `next`:先 degrade,`Unknown` 返回 `Unknown`;再按 90° 步进,顺时针:Up → Right → Down → Left → Up。 +- `opposite`:先 degrade,`Unknown` 返回 `Unknown`;Up↔Down,Left↔Right。 +- `movement`:先 degrade,再返回偏移量。 + +## 4. 实现 FaceManager 类 + +实现 `IFaceManager`,不导出全局单例,应将实例挂载到游戏实例下。两个内置 handler(`Dir8FaceHandler` 与 `Dir4FaceHandler`)不在构造时注册,而在游戏实例初始化阶段注册,key 分别为 `InternalFaceGroup.Dir8` 和 `InternalFaceGroup.Dir4`。 + +## 5. 现有代码处理 + +- 现有 `getFaceMovement`、`nextFaceDirection`、`degradeFace`、`fromDirectionString` 等工具函数**暂时保留**,不做删改;新代码直接使用新接口,旧代码的迁移视后续情况另行处理。 +- `@motajs/common` 中的 `DirectionMapper` 及 `IDirectionMapper` 接口将被废弃,其调用方(如 `range.ts`)的迁移视后续情况另行处理。 + +# 涉及文件 + +## 需要修改的文件 + +### `@user/data-base/src/common/faceManager.ts`(新增文件) + +- [ ] 新增 `InternalFaceGroup` 枚举:包含 `Dir4` 与 `Dir8` 两个成员,作为 `IFaceManager` 的内置数字 key +- [ ] 新增 `IFaceDescriptor` 接口:描述一个方向的坐标增量,包含 `x` 与 `y` 两个只读成员 +- [ ] 新增 `IFaceHandler` 接口:包含 `degrade`、`movement`、`move`、`opposite`、`next`、`mapDirection`、`mapMovement` 七个成员 +- [ ] 新增 `IFaceManager` 接口:包含 `register`、`registerById`、`get`、`getById` 四个方法 +- [ ] 实现 `Dir8FaceHandler` 类(`implements IFaceHandler`) +- [ ] 实现 `Dir4FaceHandler` 类(`implements IFaceHandler`) +- [ ] 实现 `FaceManager` 类(`implements IFaceManager`) + +### `@user/data-base/src/common/index.ts` + +- [ ] 导出新增的枚举、接口与类 diff --git a/packages-user/data-base/src/common/faceManager.ts b/packages-user/data-base/src/common/faceManager.ts new file mode 100644 index 0000000..8736d3a --- /dev/null +++ b/packages-user/data-base/src/common/faceManager.ts @@ -0,0 +1,282 @@ +import { FaceDirection } from './types'; + +//#region 接口与枚举 + +export const enum InternalFaceGroup { + /** 四方向(上下左右) */ + Dir4, + /** 八方向(上下左右+斜向) */ + Dir8 +} + +export interface IFaceDescriptor { + /** 横坐标增量 */ + readonly x: number; + /** 纵坐标增量 */ + readonly y: number; +} + +export interface IFaceHandler { + /** + * 将任意朝向值降级为本组支持的方向。 + * 对于无法合理降级的方向(包括 `Unknown`),返回 `FaceDirection.Unknown` + * @param dir 任意朝向值 + */ + degrade(dir: number): T; + + /** + * 获取指定方向的单步坐标偏移量,输入先经过 `degrade` + * @param dir 朝向 + */ + movement(dir: number): IFaceDescriptor; + + /** + * 获取指定方向走 `count` 步的坐标偏移量,等价于 `movement * count`。 + * `count` 允许为负数,表示反向位移,输入先经过 `degrade` + * @param dir 朝向 + * @param count 步数,允许为负 + */ + move(dir: number, count: number): IFaceDescriptor; + + /** + * 获取本组内的反方向,输入先经过 `degrade`,`Unknown` 返回 `Unknown` + * @param dir 朝向 + */ + opposite(dir: number): T; + + /** + * 在本组方向集合内顺时针(默认)或逆时针旋转一步,输入先经过 `degrade`, + * `Unknown` 返回 `Unknown` + * @param dir 朝向 + * @param anticlockwise 是否逆时针,默认顺时针 + */ + next(dir: number, anticlockwise?: boolean): T; + + /** + * 迭代本组支持的所有朝向,包含 `Unknown` + */ + mapDirection(): Iterable; + + /** + * 迭代本组所有朝向及其对应的坐标描述器,包含 `Unknown`(对应 `{ x: 0, y: 0 }`) + */ + mapMovement(): Iterable<[T, IFaceDescriptor]>; +} + +export interface IFaceManager { + /** + * 以数字 key 注册一个 handler + * @param group 数字 key + * @param handler 朝向处理器 + */ + register(group: number, handler: IFaceHandler): void; + + /** + * 以字符串 id 注册一个 handler + * @param id 字符串 id + * @param handler 朝向处理器 + */ + registerById(id: string, handler: IFaceHandler): void; + + /** + * 按数字 key 查找 handler,未找到返回 `null` + * @param group 数字 key + */ + get(group: number): IFaceHandler | null; + + /** + * 按字符串 id 查找 handler,未找到返回 `null` + * @param id 字符串 id + */ + getById(id: string): IFaceHandler | null; +} + +//#endregion + +//#region 内置 Handler + +const ZERO_DESCRIPTOR: IFaceDescriptor = { x: 0, y: 0 }; + +const DIR8_MOVEMENTS: ReadonlyMap = new Map([ + [FaceDirection.Unknown, ZERO_DESCRIPTOR], + [FaceDirection.Left, { x: -1, y: 0 }], + [FaceDirection.Up, { x: 0, y: -1 }], + [FaceDirection.Right, { x: 1, y: 0 }], + [FaceDirection.Down, { x: 0, y: 1 }], + [FaceDirection.LeftUp, { x: -1, y: -1 }], + [FaceDirection.RightUp, { x: 1, y: -1 }], + [FaceDirection.LeftDown, { x: -1, y: 1 }], + [FaceDirection.RightDown, { x: 1, y: 1 }] +]); + +/** 顺时针旋转顺序(不含 Unknown) */ +const DIR8_CW: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.RightUp], + [FaceDirection.RightUp, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.RightDown], + [FaceDirection.RightDown, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.LeftDown], + [FaceDirection.LeftDown, FaceDirection.Left], + [FaceDirection.Left, FaceDirection.LeftUp], + [FaceDirection.LeftUp, FaceDirection.Up] +]); + +/** 逆时针旋转顺序(不含 Unknown) */ +const DIR8_CCW: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.LeftUp], + [FaceDirection.LeftUp, FaceDirection.Left], + [FaceDirection.Left, FaceDirection.LeftDown], + [FaceDirection.LeftDown, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.RightDown], + [FaceDirection.RightDown, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.RightUp], + [FaceDirection.RightUp, FaceDirection.Up] +]); + +const DIR8_OPPOSITE: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.Up], + [FaceDirection.Left, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.Left], + [FaceDirection.LeftUp, FaceDirection.RightDown], + [FaceDirection.RightDown, FaceDirection.LeftUp], + [FaceDirection.RightUp, FaceDirection.LeftDown], + [FaceDirection.LeftDown, FaceDirection.RightUp] +]); + +export class Dir8FaceHandler implements IFaceHandler { + degrade(dir: number): FaceDirection { + return dir as FaceDirection; + } + + movement(dir: number): IFaceDescriptor { + return DIR8_MOVEMENTS.get(this.degrade(dir)) ?? ZERO_DESCRIPTOR; + } + + move(dir: number, count: number): IFaceDescriptor { + const { x, y } = this.movement(dir); + return { x: x * count, y: y * count }; + } + + opposite(dir: number): FaceDirection { + const degraded = this.degrade(dir); + return DIR8_OPPOSITE.get(degraded) ?? FaceDirection.Unknown; + } + + next(dir: number, anticlockwise: boolean = false): FaceDirection { + const degraded = this.degrade(dir); + if (degraded === FaceDirection.Unknown) return FaceDirection.Unknown; + const map = anticlockwise ? DIR8_CCW : DIR8_CW; + return map.get(degraded) ?? FaceDirection.Unknown; + } + + mapDirection(): Iterable { + return DIR8_MOVEMENTS.keys(); + } + + mapMovement(): Iterable<[FaceDirection, IFaceDescriptor]> { + return DIR8_MOVEMENTS.entries(); + } +} + +const DIR4_DEGRADE: ReadonlyMap = new Map([ + [FaceDirection.Left, FaceDirection.Left], + [FaceDirection.Up, FaceDirection.Up], + [FaceDirection.Right, FaceDirection.Right], + [FaceDirection.Down, FaceDirection.Down], + [FaceDirection.LeftUp, FaceDirection.Left], + [FaceDirection.LeftDown, FaceDirection.Left], + [FaceDirection.RightUp, FaceDirection.Right], + [FaceDirection.RightDown, FaceDirection.Right] +]); + +const DIR4_MOVEMENTS: ReadonlyMap = new Map([ + [FaceDirection.Unknown, ZERO_DESCRIPTOR], + [FaceDirection.Left, { x: -1, y: 0 }], + [FaceDirection.Up, { x: 0, y: -1 }], + [FaceDirection.Right, { x: 1, y: 0 }], + [FaceDirection.Down, { x: 0, y: 1 }] +]); + +const DIR4_CW: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.Left], + [FaceDirection.Left, FaceDirection.Up] +]); + +const DIR4_CCW: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.Left], + [FaceDirection.Left, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.Up] +]); + +const DIR4_OPPOSITE: ReadonlyMap = new Map([ + [FaceDirection.Up, FaceDirection.Down], + [FaceDirection.Down, FaceDirection.Up], + [FaceDirection.Left, FaceDirection.Right], + [FaceDirection.Right, FaceDirection.Left] +]); + +export class Dir4FaceHandler implements IFaceHandler { + degrade(dir: number): FaceDirection { + return DIR4_DEGRADE.get(dir as FaceDirection) ?? FaceDirection.Unknown; + } + + movement(dir: number): IFaceDescriptor { + return DIR4_MOVEMENTS.get(this.degrade(dir)) ?? ZERO_DESCRIPTOR; + } + + move(dir: number, count: number): IFaceDescriptor { + const { x, y } = this.movement(dir); + return { x: x * count, y: y * count }; + } + + opposite(dir: number): FaceDirection { + const degraded = this.degrade(dir); + return DIR4_OPPOSITE.get(degraded) ?? FaceDirection.Unknown; + } + + next(dir: number, anticlockwise: boolean = false): FaceDirection { + const degraded = this.degrade(dir); + if (degraded === FaceDirection.Unknown) return FaceDirection.Unknown; + const map = anticlockwise ? DIR4_CCW : DIR4_CW; + return map.get(degraded) ?? FaceDirection.Unknown; + } + + mapDirection(): Iterable { + return DIR4_MOVEMENTS.keys(); + } + + mapMovement(): Iterable<[FaceDirection, IFaceDescriptor]> { + return DIR4_MOVEMENTS.entries(); + } +} + +//#endregion + +//#region FaceManager + +export class FaceManager implements IFaceManager { + private readonly byGroup: Map> = new Map(); + private readonly byId: Map> = new Map(); + + register(group: number, handler: IFaceHandler): void { + this.byGroup.set(group, handler); + } + + registerById(id: string, handler: IFaceHandler): void { + this.byId.set(id, handler); + } + + get(group: number): IFaceHandler | null { + return (this.byGroup.get(group) as IFaceHandler) ?? null; + } + + getById(id: string): IFaceHandler | null { + return (this.byId.get(id) as IFaceHandler) ?? null; + } +} + +//#endregion diff --git a/packages-user/data-base/src/common/index.ts b/packages-user/data-base/src/common/index.ts index 64a2b6f..c528977 100644 --- a/packages-user/data-base/src/common/index.ts +++ b/packages-user/data-base/src/common/index.ts @@ -1,4 +1,5 @@ export * from './face'; +export * from './faceManager'; export * from './mover'; export * from './types'; export * from './utils'; diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index 673f5f4..b733dbc 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -1,7 +1,7 @@ import { IHeroFollower, IHeroState } from './hero'; import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; -import { IRoleFaceBinder, ISaveableContent } from './common'; +import { IFaceManager, IRoleFaceBinder, ISaveableContent } from './common'; import { IMapStore } from './map'; export interface IStateSaveData { @@ -12,6 +12,8 @@ export interface IStateSaveData { export interface IStateBase { /** 朝向绑定 */ readonly roleFace: IRoleFaceBinder; + /** 朝向管理 */ + readonly faceManager: IFaceManager; /** id 到图块数字的映射 */ readonly idNumberMap: Map; /** 图块数字到 id 的映射 */ diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 87bb0c5..970ef08 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -22,7 +22,12 @@ import { SaveCompression, IReadonlyEnemy, IMapStore, - MapStore + MapStore, + IFaceManager, + FaceManager, + InternalFaceGroup, + Dir4FaceHandler, + Dir8FaceHandler } from '@user/data-base'; import { CommonAuraConverter, @@ -55,6 +60,7 @@ import { ISaveSystem, SaveSystem } from './save'; export class CoreState implements ICoreState { // 全局内容 readonly roleFace: IRoleFaceBinder; + readonly faceManager: IFaceManager; readonly idNumberMap: Map; readonly numberIdMap: Map; @@ -82,7 +88,6 @@ export class CoreState implements ICoreState { constructor() { this.maps = new MapStore(); - this.roleFace = new RoleFaceBinder(); this.idNumberMap = new Map(); this.numberIdMap = new Map(); @@ -151,6 +156,16 @@ export class CoreState implements ICoreState { //#region 其他初始化 + // 朝向 + this.roleFace = new RoleFaceBinder(); + this.faceManager = new FaceManager(); + const dir4 = new Dir4FaceHandler(); + const dir8 = new Dir8FaceHandler(); + this.faceManager.register(InternalFaceGroup.Dir4, dir4); + this.faceManager.registerById('dir4', dir4); + this.faceManager.register(InternalFaceGroup.Dir8, dir8); + this.faceManager.registerById('dir8', dir8); + this.flags = new FlagSystem(); // 加载先使用兼容层实现 From 0da19e16971daa7432277d6d9726a4ac440a9499 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Tue, 12 May 2026 17:11:33 +0800 Subject: [PATCH 11/26] =?UTF-8?q?refactor:=20=E6=88=98=E6=96=97=E7=B3=BB?= =?UTF-8?q?=E7=BB=9F=E6=96=87=E4=BB=B6=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/enemy/enemy-types-restructure.md | 54 ++ .../src/{enemy => combat}/context.ts | 12 +- .../data-base/src/{enemy => combat}/damage.ts | 6 +- packages-user/data-base/src/combat/enemy.ts | 42 + packages-user/data-base/src/combat/index.ts | 5 + .../src/{enemy => combat}/mapDamage.ts | 6 +- packages-user/data-base/src/combat/types.ts | 688 +++++++++++++++++ packages-user/data-base/src/common/indexer.ts | 61 ++ packages-user/data-base/src/enemy/enemy.ts | 49 +- packages-user/data-base/src/enemy/index.ts | 4 - packages-user/data-base/src/enemy/types.ts | 715 ------------------ packages-user/data-base/src/enemy/utils.ts | 25 - packages-user/data-base/src/index.ts | 1 + 13 files changed, 863 insertions(+), 805 deletions(-) create mode 100644 docs/dev/enemy/enemy-types-restructure.md rename packages-user/data-base/src/{enemy => combat}/context.ts (99%) rename packages-user/data-base/src/{enemy => combat}/damage.ts (99%) create mode 100644 packages-user/data-base/src/combat/enemy.ts create mode 100644 packages-user/data-base/src/combat/index.ts rename packages-user/data-base/src/{enemy => combat}/mapDamage.ts (99%) create mode 100644 packages-user/data-base/src/combat/types.ts create mode 100644 packages-user/data-base/src/common/indexer.ts delete mode 100644 packages-user/data-base/src/enemy/utils.ts diff --git a/docs/dev/enemy/enemy-types-restructure.md b/docs/dev/enemy/enemy-types-restructure.md new file mode 100644 index 0000000..e84256c --- /dev/null +++ b/docs/dev/enemy/enemy-types-restructure.md @@ -0,0 +1,54 @@ +# 怪物系统文件结构重构 + +**目的:** 使 `IEnemyHandler` 能持有 `IStateBase` 引用而不产生循环引用。 + +**循环根源:** `enemy/types.ts` 混写了两层接口,`data-base/src/types.ts` 经由 `./enemy` index 引入 `IEnemyManager`,导致无法反向引用。 + +## 接口归属 + +**`enemy/types.ts`(Layer 1 — 存档/管理层,保留)** + +只保留以下接口,其余全部迁出: + +- `IEnemySaveState`、`IEnemyManagerSaveState`、`IEnemyComparer` +- `ISpecial`、`IReadonlyEnemy`、`IEnemy` +- `SpecialCreation`、`IEnemyLegacyBridge`、`IEnemyManager` + +只允许引用 `@motajs/common`、`../common`,不得引用 `../types`。 + +**`enemy/utils.ts`(Layer 0 — 工具层,与实现类并列)** + +从 `enemy/types.ts` 迁出以下接口(实现类 `MapLocIndexer` 已在此文件): + +- `IMapLocHelper`、`IMapLocIndexer` + +**`combat/types.ts`(Layer 2 — 战斗/上下文层,现为空文件)** + +从 `enemy/types.ts` 迁入以下接口: + +- `IEnemyHandler`、`IReadonlyEnemyHandler`、`IEnemyView` +- `IEnemySpecialModifier`、`IAuraView`、`IEnemyAuraView`、`IAuraConverter` +- `IEnemySpecialQueryModifier`、`IEnemySpecialQueryEffect`、`IEnemyCommonQueryEffect`、`IEnemyFinalEffect` +- `IMapDamageInfoExtra`、`IMapDamageInfo`、`IMapDamageView`、`IMapDamageConverter`、`IMapDamageReducer`、`IMapDamage` +- `IEnemyDamageInfo`、`IEnemyCritical`、`CriticalableHeroStatus`、`IDamageCalculator`、`IDamageContext`、`IDamageSystem` +- `IEnemyContext` + +需引用 `../enemy/types`(Layer 1)、`../enemy/utils`(Layer 0)、`../types`(`IStateBase`,现在无循环)。在 `IEnemyHandler` 和 `IReadonlyEnemyHandler` 中新增 `readonly state: IStateBase`。 + +## 文件修改清单 + +| 文件 | 操作 | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| `combat/types.ts` | 迁入所有 Layer 2 接口;新增三条 import(`../enemy/types`、`../enemy/utils`、`../types`);`IEnemyHandler` 系列加 `state` 字段 | +| `combat/context.ts` | 从 `enemy/context.ts` **移动**;import 路径改为从 `./types`、`../enemy/types`、`../enemy/utils` 引入 | +| `combat/damage.ts` | 从 `enemy/damage.ts` **移动**;import 路径同上 | +| `combat/mapDamage.ts` | 从 `enemy/mapDamage.ts` **移动**;import 路径同上 | +| `combat/index.ts` | 新建,`export * from './types/context/damage/mapDamage'` | +| `enemy/types.ts` | 删除所有 Layer 2 接口(迁出后仅剩 Layer 1 内容) | +| `enemy/utils.ts` | 新增 `IMapLocHelper`、`IMapLocIndexer` 接口定义 | +| `enemy/index.ts` | 删除对 `context`、`damage`、`mapDamage` 的导出 | +| `data-base/src/index.ts` | 新增 `export * from './combat'` | +| `data-base/src/types.ts` | `import { IEnemyManager }` 改从 `./enemy/types` 直接引入(`enemy/types.ts` 不再引用 `../types`,无循环) | +| `enemy/enemy.ts` | import 路径无需改动(`IEnemy` 等仍在 `./types`) | +| `enemy/manager.ts` | import 路径无需改动(全部 Layer 1 接口仍在 `./types`) | +| `enemy/special.ts` | import 路径无需改动 | diff --git a/packages-user/data-base/src/enemy/context.ts b/packages-user/data-base/src/combat/context.ts similarity index 99% rename from packages-user/data-base/src/enemy/context.ts rename to packages-user/data-base/src/combat/context.ts index a5206a1..165a7b9 100644 --- a/packages-user/data-base/src/enemy/context.ts +++ b/packages-user/data-base/src/combat/context.ts @@ -3,7 +3,6 @@ import { IAuraConverter, IAuraView, IDamageSystem, - IEnemy, IEnemyAuraView, IEnemyCommonQueryEffect, IEnemyContext, @@ -13,13 +12,12 @@ import { IEnemySpecialQueryEffect, IEnemyView, IMapDamage, - IReadonlyEnemy, - IReadonlyEnemyHandler, - ISpecial + IReadonlyEnemyHandler } from './types'; -import { EnemyView } from './enemy'; -import { MapLocIndexer } from './utils'; import { IReadonlyHeroAttribute } from '../hero'; +import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; +import { EnemyView } from './enemy'; +import { ILocationIndexer, MapLocIndexer } from '../common/indexer'; export class EnemyContext implements IEnemyContext { /** 坐标索引 -> 怪物视图 */ @@ -82,7 +80,7 @@ export class EnemyContext implements IEnemyContext { private damageSystem: IDamageSystem | null = null; /** 索引工具 */ - readonly indexer: MapLocIndexer = new MapLocIndexer(); + readonly indexer: ILocationIndexer = new MapLocIndexer(); /** 当前是否需要全量刷新 */ private needUpdate: boolean = true; diff --git a/packages-user/data-base/src/enemy/damage.ts b/packages-user/data-base/src/combat/damage.ts similarity index 99% rename from packages-user/data-base/src/enemy/damage.ts rename to packages-user/data-base/src/combat/damage.ts index 72c667c..10842af 100644 --- a/packages-user/data-base/src/enemy/damage.ts +++ b/packages-user/data-base/src/combat/damage.ts @@ -1,3 +1,4 @@ +import { clamp } from 'lodash-es'; import { ITileLocator, logger } from '@motajs/common'; import { CriticalableHeroStatus, @@ -8,11 +9,10 @@ import { IEnemyCritical, IEnemyDamageInfo, IReadonlyEnemyHandler, - IEnemyView, - IReadonlyEnemy + IEnemyView } from './types'; import { IHeroAttribute, IReadonlyHeroAttribute } from '../hero'; -import { clamp } from 'lodash-es'; +import { IReadonlyEnemy } from '../enemy'; interface ICriticalSearchResult { /** 此临界点的属性值 */ diff --git a/packages-user/data-base/src/combat/enemy.ts b/packages-user/data-base/src/combat/enemy.ts new file mode 100644 index 0000000..94a8a60 --- /dev/null +++ b/packages-user/data-base/src/combat/enemy.ts @@ -0,0 +1,42 @@ +import { IEnemy, IReadonlyEnemy } from '../enemy'; +import { IEnemyView, IEnemyContext } from './types'; + +export class EnemyView implements IEnemyView { + /** 计算后怪物 */ + private readonly computedEnemy: IEnemy; + + constructor( + readonly baseEnemy: IEnemy, + readonly context: IEnemyContext + ) { + this.computedEnemy = baseEnemy.clone(); + } + + reset(): void { + this.computedEnemy.copyFrom(this.baseEnemy); + } + + getBaseEnemy(): IReadonlyEnemy { + return this.baseEnemy; + } + + getComputedEnemy(): IReadonlyEnemy { + this.context.requestRefresh(this); + return this.computedEnemy; + } + + /** + * 获取计算中怪物对象,这个接口不对外暴露,仅在系统内部的 EnemyContext 中使用。 + */ + getComputingEnemy(): IEnemy { + return this.computedEnemy; + } + + getModifiableEnemy(): IEnemy { + return this.baseEnemy; + } + + markDirty(): void { + this.context.markDirty(this); + } +} diff --git a/packages-user/data-base/src/combat/index.ts b/packages-user/data-base/src/combat/index.ts new file mode 100644 index 0000000..a893526 --- /dev/null +++ b/packages-user/data-base/src/combat/index.ts @@ -0,0 +1,5 @@ +export * from './context'; +export * from './damage'; +export * from './enemy'; +export * from './mapDamage'; +export * from './types'; diff --git a/packages-user/data-base/src/enemy/mapDamage.ts b/packages-user/data-base/src/combat/mapDamage.ts similarity index 99% rename from packages-user/data-base/src/enemy/mapDamage.ts rename to packages-user/data-base/src/combat/mapDamage.ts index be665c4..5d3d576 100644 --- a/packages-user/data-base/src/enemy/mapDamage.ts +++ b/packages-user/data-base/src/combat/mapDamage.ts @@ -7,9 +7,9 @@ import { IMapDamageConverter, IMapDamageInfo, IMapDamageReducer, - IMapDamageView, - IMapLocIndexer + IMapDamageView } from './types'; +import { ILocationHelper } from '../common/indexer'; interface IPointInfo { /** 该点所有的地图伤害 */ @@ -61,7 +61,7 @@ export class MapDamage implements IMapDamage { private readonly reducedCache: Map = new Map(); /** 坐标索引对象 */ - private readonly indexer: IMapLocIndexer; + private readonly indexer: ILocationHelper; constructor(readonly context: IEnemyContext) { this.indexer = context.indexer; diff --git a/packages-user/data-base/src/combat/types.ts b/packages-user/data-base/src/combat/types.ts new file mode 100644 index 0000000..b3ae7f5 --- /dev/null +++ b/packages-user/data-base/src/combat/types.ts @@ -0,0 +1,688 @@ +import { ITileLocator, IRange } from '@motajs/common'; +import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; +import { IReadonlyHeroAttribute, IHeroAttribute } from '../hero'; +import { ILocationHelper } from '../common/indexer'; + +//#region 辅助接口 + +export interface IEnemyHandler { + /** 怪物属性信息 */ + readonly enemy: IEnemy; + /** 怪物定位符 */ + readonly locator: ITileLocator; + /** 勇士属性信息 */ + readonly hero: IReadonlyHeroAttribute; +} + +export interface IReadonlyEnemyHandler { + /** 怪物属性信息 */ + readonly enemy: IReadonlyEnemy; + /** 怪物定位符 */ + readonly locator: ITileLocator; + /** 勇士属性信息 */ + readonly hero: IReadonlyHeroAttribute; +} + +//#endregion + +//#region 怪物对象 + +export interface IEnemyView { + /** 怪物视图所属的上下文 */ + readonly context: IEnemyContext; + + /** + * 重置此怪物视图的状态,将计算后怪物对象恢复至初始状态 + */ + reset(): void; + + /** + * 获取基本怪物对象 + */ + getBaseEnemy(): IReadonlyEnemy; + + /** + * 获取计算后的怪物对象,返回的怪物对象同引用 + */ + getComputedEnemy(): IReadonlyEnemy; + + /** + * 获取可修改的怪物对象。如果修改此方法获取的怪物对象,那么怪物的真实信息是不会刷新的, + * 需要手动调用 markDirty 方法来刷新。 + */ + getModifiableEnemy(): IEnemy; + + /** + * 将此怪物标记为脏,需要更新 + */ + markDirty(): void; +} + +//#endregion + +//#region 光环与查询 + +export interface IEnemySpecialModifier { + /** + * 获取要添加到指定怪物身上的特殊属性 + * @param handler 信息对象 + */ + add(handler: IReadonlyEnemyHandler): ISpecial[]; + + /** + * 获取制定怪物身上要删除的特殊属性 + * @param handler 信息对象 + */ + delete(handler: IReadonlyEnemyHandler): ISpecial[]; + + /** + * 修改一个怪物的特殊属性,如果真正进行了修改则返回 true,否则返回 false + * @param handler 信息对象 + * @param special 要修改的怪物特殊属性 + */ + modify( + handler: IEnemyHandler, + special: ISpecial + ): boolean; +} + +export interface IAuraView { + /** 此光环视图的优先级 */ + readonly priority: number; + /** 此光环视图的影响范围 */ + readonly range: IRange; + + /** 这个光环视图是否有可能修改怪物的基本属性 */ + readonly couldApplyBase: boolean; + /** 这个光环视图是否有可能修改怪物的特殊属性 */ + readonly couldApplySpecial: boolean; + + /** + * 获取范围扫描参数 + */ + getRangeParam(): T; + + /** + * 对指定怪物对象施加修饰器 + * @param handler 信息对象 + * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 + */ + apply( + handler: IEnemyHandler, + baseEnemy: IReadonlyEnemy + ): void; + + /** + * 对指定怪物对象添加特殊属性修饰器 + * @param handler 信息对象 + * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 + */ + applySpecial( + handler: IEnemyHandler, + baseEnemy: IReadonlyEnemy + ): IEnemySpecialModifier | null; +} + +export interface IEnemyAuraView extends IAuraView { + /** 此光环视图所属的怪物 */ + readonly enemy: IReadonlyEnemy; + /** 此光环视图所属的特殊属性 */ + readonly special: ISpecial; + /** 此光环视图所属怪物的定位符 */ + readonly locator: ITileLocator; +} + +export interface IAuraConverter { + /** + * 判断一个特殊属性是否应该被当前光环转换器执行转换 + * @param special 要转换的特殊属性 + * @param handler 信息对象 + */ + shouldConvert( + special: ISpecial, + handler: IReadonlyEnemyHandler + ): boolean; + + /** + * 将一个特殊属性转换为光环视图 + */ + convert( + special: ISpecial, + handler: IReadonlyEnemyHandler, + context: IEnemyContext + ): IEnemyAuraView; +} + +export interface IEnemySpecialQueryModifier< + TAttr, + THero +> extends IEnemySpecialModifier { + /** + * 判断一个怪物是否应该查询外部状态 + */ + shouldQuery(handler: IReadonlyEnemyHandler): boolean; +} + +export interface IEnemySpecialQueryEffect { + /** 效果优先级,与光环属性共用 */ + readonly priority: number; + + /** + * 根据传入的怪物上下文,获取对应的怪物特殊属性修饰器 + */ + for( + ctx: IEnemyContext + ): IEnemySpecialQueryModifier; +} + +export interface IEnemyCommonQueryEffect { + /** 优先级,越高的越先执行 */ + readonly priority: number; + + /** + * 对怪物的某个特殊属性施加常规查询效果 + */ + apply( + handler: IEnemyHandler, + special: ISpecial, + query: () => IEnemyContext + ): void; +} + +export interface IEnemyFinalEffect { + /** 效果优先级,越高会越先被执行 */ + readonly priority: number; + + /** + * 向怪物施加最终修饰效果 + */ + apply(handler: IEnemyHandler): void; +} + +//#endregion + +//#region 地图伤害 + +export interface IMapDamageInfoExtra { + /** 捕捉怪物信息 */ + catch: Set; + /** 阻击怪物信息 */ + repulse: Set; +} + +export interface IMapDamageInfo { + /** 伤害值 */ + damage: number; + /** 伤害类型 */ + type: number; + /** 地图伤害额外信息 */ + extra: IMapDamageInfoExtra; +} + +export interface IMapDamageView { + /** + * 获取地图伤害影响范围 + */ + getRange(): IRange; + + /** + * 获取范围参数 + */ + getRangeParam(): T; + + /** + * 获取指定位置的地图伤害,会对坐标进行判断 + * @param locator 伤害位置 + */ + getDamageAt(locator: ITileLocator): Readonly | null; + + /** + * 获取指定位置的地图伤害,会对坐标进行判断 + * @param locator 伤害位置 + */ + getDamageWithoutCheck( + locator: ITileLocator + ): Readonly | null; +} + +export interface IMapDamageConverter { + /** + * 转换地图伤害视图 + */ + convert( + handler: IReadonlyEnemyHandler, + context: IEnemyContext + ): IMapDamageView[]; +} + +export interface IMapDamageReducer { + /** + * 对伤害信息进行合并 + */ + reduce( + info: Iterable>, + locator: ITileLocator + ): Readonly; +} + +export interface IMapDamage { + /** 当前绑定的怪物上下文 */ + readonly context: IEnemyContext; + + /** + * 设置地图伤害转换器,并基于当前上下文重建所有地图伤害视图 + * @param converter 地图伤害转换器 + */ + useConverter(converter: IMapDamageConverter): void; + + /** + * 设置地图伤害合并器 + * @param reducer 地图伤害合并器 + */ + useReducer(reducer: IMapDamageReducer): void; + + /** + * 在指定位置添加一条无来源地图伤害 + * @param locator 地图定位符 + * @param info 地图伤害信息 + */ + addMapDamage(locator: ITileLocator, info: IMapDamageInfo): void; + + /** + * 在指定位置删除一条无来源地图伤害 + * @param locator 地图定位符 + * @param info 地图伤害信息 + */ + deleteMapDamage(locator: ITileLocator, info: IMapDamageInfo): void; + + /** + * 将指定位置标记为脏,后续访问时会重新计算该点的有来源伤害 + * @param locator 地图定位符 + */ + markDirty(locator: ITileLocator): void; + + /** + * 将指定怪物对应的地图伤害标记为脏并刷新 + * @param view 怪物视图 + */ + markEnemyDirty(view: IEnemyView): void; + + /** + * 基于当前上下文重新刷新全部有来源地图伤害 + */ + refreshAll(): void; + + /** + * 删除指定怪物带来的全部地图伤害来源 + * @param view 怪物视图 + */ + deleteEnemy(view: IEnemyView): void; + + /** + * 获取指定位置合并后的地图伤害 + * @param locator 地图定位符 + */ + getReducedDamage(locator: ITileLocator): Readonly | null; + + /** + * 获取指定位置未合并的地图伤害列表 + * @param locator 地图定位符 + */ + getSeparatedDamage( + locator: ITileLocator + ): Iterable>; +} + +//#endregion + +//#region 伤害系统 + +export interface IEnemyDamageInfo { + /** 战斗伤害值 */ + readonly damage: number; + /** 战斗回合数 */ + readonly turn: number; +} + +export interface IEnemyCritical { + /** 此临界点中指定勇士属性的值 */ + readonly nextValue: number; + /** 当前勇士指定属性的值 */ + readonly baseValue: number; + /** 此临界点中指定勇士数值的值与当前值的差,即 `nextValue - baseValue` */ + readonly nextDiff: number; + /** 当前状态下怪物的伤害信息 */ + readonly baseInfo: IEnemyDamageInfo; + /** 此临界点下怪物的伤害信息 */ + readonly info: IEnemyDamageInfo; + /** 此临界点的伤害值与当前伤害值的差 */ + readonly damageDiff: number; +} + +export type CriticalableHeroStatus = keyof { + [P in keyof THero as THero[P] extends number ? P : never]: number; +}; + +export interface IDamageCalculator { + /** + * 计算战斗伤害信息 + * @param handler 信息对象 + */ + calculate(handler: IReadonlyEnemyHandler): IEnemyDamageInfo; + + /** + * 获取临界计算的上界 + * @param handler 信息对象 + * @param attribute 勇士的临界属性 + */ + getCriticalLimit( + handler: IReadonlyEnemyHandler, + attribute: CriticalableHeroStatus + ): number; +} + +export interface IDamageContext { + /** + * 获取战斗伤害信息 + * @param enemy 怪物视图 + */ + getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null; + + /** + * 根据怪物对象获取战斗伤害信息 + * @param enemy 怪物对象 + */ + getDamageInfoByComputed( + enemy: IReadonlyEnemy + ): IEnemyDamageInfo | null; + + /** + * 计算怪物在指定勇士属性下的临界 + * @param enemy 怪物视图 + * @param attribute 计算临界的目标勇士属性,比如计算攻击临界、自定义属性的临界等等 + * @param precision 临界计算精度,表示会进行多少次二分计算,一般填写 `12-16` 之间的数即可,默认是 12 + */ + calculateCritical( + enemy: IEnemyView, + attribute: CriticalableHeroStatus, + precision?: number + ): Generator; +} + +export interface IDamageSystem extends IDamageContext< + TAttr, + THero +> { + /** 伤害系统所属的上下文 */ + readonly context: IEnemyContext; + + /** + * 设置当前伤害计算系统使用的伤害计算器 + * @param calculator 伤害计算器 + */ + useCalculator(calculator: IDamageCalculator): void; + + /** + * 获取当前使用的伤害计算器 + */ + getCalculator(): IDamageCalculator | null; + + /** + * 绑定勇士信息 + * @param hero 勇士信息 + */ + bindHeroStatus(hero: IReadonlyHeroAttribute | null): void; + + /** + * 将指定的怪物标记为脏 + * @param enemy 怪物视图 + */ + markDirty(enemy: IEnemyView): void; + + /** + * 删除指定的怪物 + * @param enemy 怪物视图 + */ + deleteEnemy(enemy: IEnemyView): void; + + /** + * 将所有怪物标记为脏 + */ + markAllDirty(): void; + + /** + * 修改勇士属性,然后返回修改后勇士属性所组成的计算对象,不影响当前伤害系统的状态 + * @param modify 勇士修改函数 + */ + with(hero: IHeroAttribute): IDamageContext; +} + +//#endregion + +//#region 上下文 + +export interface IEnemyContext { + /** 怪物上下文宽度 */ + readonly width: number; + /** 怪物上下文高度 */ + readonly height: number; + /** 此上下文使用的索引对象 */ + readonly indexer: ILocationHelper; + + /** + * 调整上下文尺寸,并清空当前上下文中的所有怪物与状态 + * @param width 地图宽度 + * @param height 地图高度 + */ + resize(width: number, height: number): void; + + /** + * 注册一个光环转换器 + * @param converter 光环转换器 + */ + registerAuraConverter(converter: IAuraConverter): void; + + /** + * 注销一个光环转换器 + * @param converter 光环转换器 + */ + unregisterAuraConverter(converter: IAuraConverter): void; + + /** + * 设置光环转换器的启用状态 + * @param converter 光环转换器 + * @param enabled 是否启用 + */ + setAuraConverterEnabled( + converter: IAuraConverter, + enabled: boolean + ): void; + + /** + * 注册一个特殊属性查询效果 + * @param effect 特殊属性查询效果 + */ + registerSpecialQueryEffect( + effect: IEnemySpecialQueryEffect + ): void; + + /** + * 注销一个特殊属性查询效果 + * @param effect 特殊属性查询效果 + */ + unregisterSpecialQueryEffect( + effect: IEnemySpecialQueryEffect + ): void; + + /** + * 为指定特殊属性代码注册常规查询效果 + * @param code 特殊属性代码 + * @param effect 常规查询效果 + */ + registerCommonQueryEffect( + code: number, + effect: IEnemyCommonQueryEffect + ): void; + + /** + * 注销指定特殊属性代码上的常规查询效果 + * @param code 特殊属性代码 + * @param effect 常规查询效果 + */ + unregisterCommonQueryEffect( + code: number, + effect: IEnemyCommonQueryEffect + ): void; + + /** + * 注册一个最终效果 + * @param effect 最终效果 + */ + registerFinalEffect(effect: IEnemyFinalEffect): void; + + /** + * 注销一个最终效果 + * @param effect 最终效果 + */ + unregisterFinalEffect(effect: IEnemyFinalEffect): void; + + /** + * 绑定勇士对象 + * @param hero 勇士属性对象 + */ + bindHero(hero: IReadonlyHeroAttribute | null): void; + + /** + * 获取当前绑定的勇士属性对象 + */ + getBindedHero(): IReadonlyHeroAttribute | null; + + /** + * 获取指定怪物对象当前所在位置 + * @param enemy 怪物对象 + */ + getEnemyLocator(enemy: IEnemy): Readonly | null; + + /** + * 获取指定怪物视图当前所在位置 + * @param view 怪物视图 + */ + getEnemyLocatorByView( + view: IEnemyView + ): Readonly | null; + + /** + * 根据定位符获取怪物视图 + * @param locator 地图定位符 + */ + getEnemyByLocator(locator: ITileLocator): IEnemyView | null; + + /** + * 根据坐标获取怪物视图 + * @param x 横坐标 + * @param y 纵坐标 + */ + getEnemyByLoc(x: number, y: number): IEnemyView | null; + + /** + * 根据计算后怪物对象反查怪物视图 + * @param enemy 计算后怪物对象 + */ + getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; + + /** + * 在指定位置放置一个怪物对象 + * @param locator 地图定位符 + * @param enemy 怪物对象 + */ + setEnemyAt(locator: ITileLocator, enemy: IEnemy): void; + + /** + * 删除指定位置的怪物 + * @param locator 地图定位符 + */ + deleteEnemy(locator: ITileLocator): void; + + /** + * 扫描指定范围内的怪物视图 + * @param range 范围对象 + * @param param 范围参数 + */ + scanRange( + range: IRange, + param: T + ): Iterable<[ITileLocator, IEnemyView]>; + + /** + * 迭代上下文中的全部怪物 + */ + iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; + + /** + * 添加一个全局光环视图 + * @param aura 光环视图 + */ + addAura(aura: IAuraView): void; + + /** + * 删除一个全局光环视图 + * @param aura 光环视图 + */ + deleteAura(aura: IAuraView): void; + + /** + * 绑定地图伤害管理器 + * @param damage 地图伤害管理器 + */ + attachMapDamage(damage: IMapDamage | null): void; + + /** + * 获取当前绑定的地图伤害管理器 + */ + getMapDamage(): IMapDamage | null; + + /** + * 绑定伤害计算系统 + * @param system 伤害系统 + */ + attachDamageSystem(system: IDamageSystem | null): void; + + /** + * 获取当前绑定的伤害计算系统 + */ + getDamageSystem(): IDamageSystem | null; + + /** + * 重建当前上下文中的全部怪物计算结果 + * + * 1. 对所有光环及特殊查询进行构建操作,这一步中会决定每个怪物所拥有的特殊属性,后续不会变动 + * 2. 执行所有的普通光环效果,修改怪物的基础属性 + * 3. 执行常规查询效果,允许查询上下文状态并修改怪物自身的基础属性 + * 4. 执行最终效果,不允许查询上下文状态,仅允许修改怪物自身的基础属性 + */ + buildup(): void; + + /** + * 将指定怪物视图标记为脏 + * @param view 怪物视图 + */ + markDirty(view: IEnemyView): void; + + /** + * 申请刷新指定怪物视图 + * @param view 怪物视图 + */ + requestRefresh(view: IEnemyView): void; + + /** + * 清空当前上下文中的所有对象与运行状态 + */ + clear(): void; + + /** + * 销毁当前上下文 + */ + destroy(): void; +} + +//#endregion diff --git a/packages-user/data-base/src/common/indexer.ts b/packages-user/data-base/src/common/indexer.ts new file mode 100644 index 0000000..c5532f3 --- /dev/null +++ b/packages-user/data-base/src/common/indexer.ts @@ -0,0 +1,61 @@ +import { ITileLocator } from '@motajs/common'; + +//#region 接口定义 + +export interface ILocationHelper { + /** + * 坐标 -> 索引 + * @param x 横坐标 + * @param y 纵坐标 + */ + locToIndex(x: number, y: number): number; + + /** + * 定位符 -> 索引 + * @param locator 定位符 + */ + locaterToIndex(locator: ITileLocator): number; + + /** + * 索引 -> 定位符 + * @param index 索引 + */ + indexToLocator(index: number): ITileLocator; +} + +export interface ILocationIndexer extends ILocationHelper { + /** + * 设置地图宽度 + * @param width 地图宽度 + */ + setWidth(width: number): void; +} + +//#endregion + +//#region 默认实现 + +export class MapLocIndexer implements ILocationIndexer { + private width: number = 0; + + setWidth(width: number): void { + this.width = width; + } + + locToIndex(x: number, y: number): number { + return y * this.width + x; + } + + locaterToIndex(locator: ITileLocator): number { + return locator.y * this.width + locator.x; + } + + indexToLocator(index: number): ITileLocator { + return { + x: index % this.width, + y: Math.floor(index / this.width) + }; + } +} + +//#endregion diff --git a/packages-user/data-base/src/enemy/enemy.ts b/packages-user/data-base/src/enemy/enemy.ts index 189e2f1..36a0fd0 100644 --- a/packages-user/data-base/src/enemy/enemy.ts +++ b/packages-user/data-base/src/enemy/enemy.ts @@ -1,12 +1,5 @@ import { logger } from '@motajs/common'; -import { - IEnemy, - IEnemyContext, - IEnemySaveState, - IReadonlyEnemy, - ISpecial, - IEnemyView -} from './types'; +import { IEnemy, IEnemySaveState, IReadonlyEnemy, ISpecial } from './types'; import { SaveCompression } from '../common/types'; export class Enemy implements IEnemy { @@ -113,43 +106,3 @@ export class Enemy implements IEnemy { } } } - -export class EnemyView implements IEnemyView { - /** 计算后怪物 */ - private readonly computedEnemy: IEnemy; - - constructor( - readonly baseEnemy: IEnemy, - readonly context: IEnemyContext - ) { - this.computedEnemy = baseEnemy.clone(); - } - - reset(): void { - this.computedEnemy.copyFrom(this.baseEnemy); - } - - getBaseEnemy(): IReadonlyEnemy { - return this.baseEnemy; - } - - getComputedEnemy(): IReadonlyEnemy { - this.context.requestRefresh(this); - return this.computedEnemy; - } - - /** - * 获取计算中怪物对象,这个接口不对外暴露,仅在系统内部的 EnemyContext 中使用。 - */ - getComputingEnemy(): IEnemy { - return this.computedEnemy; - } - - getModifiableEnemy(): IEnemy { - return this.baseEnemy; - } - - markDirty(): void { - this.context.markDirty(this); - } -} diff --git a/packages-user/data-base/src/enemy/index.ts b/packages-user/data-base/src/enemy/index.ts index cc09d68..ba2afa4 100644 --- a/packages-user/data-base/src/enemy/index.ts +++ b/packages-user/data-base/src/enemy/index.ts @@ -1,8 +1,4 @@ export * from './enemy'; -export * from './context'; -export * from './damage'; -export * from './mapDamage'; export * from './manager'; export * from './special'; export * from './types'; -export * from './utils'; diff --git a/packages-user/data-base/src/enemy/types.ts b/packages-user/data-base/src/enemy/types.ts index 849a7a2..94251ad 100644 --- a/packages-user/data-base/src/enemy/types.ts +++ b/packages-user/data-base/src/enemy/types.ts @@ -1,5 +1,3 @@ -import { IRange, ITileLocator } from '@motajs/common'; -import { IHeroAttribute, IReadonlyHeroAttribute } from '../hero'; import { ISaveableContent } from '../common/types'; //#region 怪物基础 @@ -288,716 +286,3 @@ export interface IEnemyManager extends ISaveableContent< } //#endregion - -//#region 辅助接口 - -export interface IMapLocHelper { - /** - * 坐标 -> 索引 - * @param x 横坐标 - * @param y 纵坐标 - */ - locToIndex(x: number, y: number): number; - - /** - * 定位符 -> 索引 - * @param locator 定位符 - */ - locaterToIndex(locator: ITileLocator): number; - - /** - * 索引 -> 定位符 - * @param index 索引 - */ - indexToLocator(index: number): ITileLocator; -} - -export interface IMapLocIndexer extends IMapLocHelper { - /** - * 设置地图宽度 - * @param width 地图宽度 - */ - setWidth(width: number): void; -} - -export interface IEnemyHandler { - /** 怪物属性信息 */ - readonly enemy: IEnemy; - /** 怪物定位符 */ - readonly locator: ITileLocator; - /** 勇士属性信息 */ - readonly hero: IReadonlyHeroAttribute; -} - -export interface IReadonlyEnemyHandler { - /** 怪物属性信息 */ - readonly enemy: IReadonlyEnemy; - /** 怪物定位符 */ - readonly locator: ITileLocator; - /** 勇士属性信息 */ - readonly hero: IReadonlyHeroAttribute; -} - -//#endregion - -//#region 怪物对象 - -export interface IEnemyView { - /** 怪物视图所属的上下文 */ - readonly context: IEnemyContext; - - /** - * 重置此怪物视图的状态,将计算后怪物对象恢复至初始状态 - */ - reset(): void; - - /** - * 获取基本怪物对象 - */ - getBaseEnemy(): IReadonlyEnemy; - - /** - * 获取计算后的怪物对象,返回的怪物对象同引用 - */ - getComputedEnemy(): IReadonlyEnemy; - - /** - * 获取可修改的怪物对象。如果修改此方法获取的怪物对象,那么怪物的真实信息是不会刷新的, - * 需要手动调用 markDirty 方法来刷新。 - */ - getModifiableEnemy(): IEnemy; - - /** - * 将此怪物标记为脏,需要更新 - */ - markDirty(): void; -} - -//#endregion - -//#region 光环与查询 - -export interface IEnemySpecialModifier { - /** - * 获取要添加到指定怪物身上的特殊属性 - * @param handler 信息对象 - */ - add(handler: IReadonlyEnemyHandler): ISpecial[]; - - /** - * 获取制定怪物身上要删除的特殊属性 - * @param handler 信息对象 - */ - delete(handler: IReadonlyEnemyHandler): ISpecial[]; - - /** - * 修改一个怪物的特殊属性,如果真正进行了修改则返回 true,否则返回 false - * @param handler 信息对象 - * @param special 要修改的怪物特殊属性 - */ - modify( - handler: IEnemyHandler, - special: ISpecial - ): boolean; -} - -export interface IAuraView { - /** 此光环视图的优先级 */ - readonly priority: number; - /** 此光环视图的影响范围 */ - readonly range: IRange; - - /** 这个光环视图是否有可能修改怪物的基本属性 */ - readonly couldApplyBase: boolean; - /** 这个光环视图是否有可能修改怪物的特殊属性 */ - readonly couldApplySpecial: boolean; - - /** - * 获取范围扫描参数 - */ - getRangeParam(): T; - - /** - * 对指定怪物对象施加修饰器 - * @param handler 信息对象 - * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 - */ - apply( - handler: IEnemyHandler, - baseEnemy: IReadonlyEnemy - ): void; - - /** - * 对指定怪物对象添加特殊属性修饰器 - * @param handler 信息对象 - * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 - */ - applySpecial( - handler: IEnemyHandler, - baseEnemy: IReadonlyEnemy - ): IEnemySpecialModifier | null; -} - -export interface IEnemyAuraView extends IAuraView { - /** 此光环视图所属的怪物 */ - readonly enemy: IReadonlyEnemy; - /** 此光环视图所属的特殊属性 */ - readonly special: ISpecial; - /** 此光环视图所属怪物的定位符 */ - readonly locator: ITileLocator; -} - -export interface IAuraConverter { - /** - * 判断一个特殊属性是否应该被当前光环转换器执行转换 - * @param special 要转换的特殊属性 - * @param handler 信息对象 - */ - shouldConvert( - special: ISpecial, - handler: IReadonlyEnemyHandler - ): boolean; - - /** - * 将一个特殊属性转换为光环视图 - */ - convert( - special: ISpecial, - handler: IReadonlyEnemyHandler, - context: IEnemyContext - ): IEnemyAuraView; -} - -export interface IEnemySpecialQueryModifier< - TAttr, - THero -> extends IEnemySpecialModifier { - /** - * 判断一个怪物是否应该查询外部状态 - */ - shouldQuery(handler: IReadonlyEnemyHandler): boolean; -} - -export interface IEnemySpecialQueryEffect { - /** 效果优先级,与光环属性共用 */ - readonly priority: number; - - /** - * 根据传入的怪物上下文,获取对应的怪物特殊属性修饰器 - */ - for( - ctx: IEnemyContext - ): IEnemySpecialQueryModifier; -} - -export interface IEnemyCommonQueryEffect { - /** 优先级,越高的越先执行 */ - readonly priority: number; - - /** - * 对怪物的某个特殊属性施加常规查询效果 - */ - apply( - handler: IEnemyHandler, - special: ISpecial, - query: () => IEnemyContext - ): void; -} - -export interface IEnemyFinalEffect { - /** 效果优先级,越高会越先被执行 */ - readonly priority: number; - - /** - * 向怪物施加最终修饰效果 - */ - apply(handler: IEnemyHandler): void; -} - -//#endregion - -//#region 地图伤害 - -export interface IMapDamageInfoExtra { - /** 捕捉怪物信息 */ - catch: Set; - /** 阻击怪物信息 */ - repulse: Set; -} - -export interface IMapDamageInfo { - /** 伤害值 */ - damage: number; - /** 伤害类型 */ - type: number; - /** 地图伤害额外信息 */ - extra: IMapDamageInfoExtra; -} - -export interface IMapDamageView { - /** - * 获取地图伤害影响范围 - */ - getRange(): IRange; - - /** - * 获取范围参数 - */ - getRangeParam(): T; - - /** - * 获取指定位置的地图伤害,会对坐标进行判断 - * @param locator 伤害位置 - */ - getDamageAt(locator: ITileLocator): Readonly | null; - - /** - * 获取指定位置的地图伤害,会对坐标进行判断 - * @param locator 伤害位置 - */ - getDamageWithoutCheck( - locator: ITileLocator - ): Readonly | null; -} - -export interface IMapDamageConverter { - /** - * 转换地图伤害视图 - */ - convert( - handler: IReadonlyEnemyHandler, - context: IEnemyContext - ): IMapDamageView[]; -} - -export interface IMapDamageReducer { - /** - * 对伤害信息进行合并 - */ - reduce( - info: Iterable>, - locator: ITileLocator - ): Readonly; -} - -export interface IMapDamage { - /** 当前绑定的怪物上下文 */ - readonly context: IEnemyContext; - - /** - * 设置地图伤害转换器,并基于当前上下文重建所有地图伤害视图 - * @param converter 地图伤害转换器 - */ - useConverter(converter: IMapDamageConverter): void; - - /** - * 设置地图伤害合并器 - * @param reducer 地图伤害合并器 - */ - useReducer(reducer: IMapDamageReducer): void; - - /** - * 在指定位置添加一条无来源地图伤害 - * @param locator 地图定位符 - * @param info 地图伤害信息 - */ - addMapDamage(locator: ITileLocator, info: IMapDamageInfo): void; - - /** - * 在指定位置删除一条无来源地图伤害 - * @param locator 地图定位符 - * @param info 地图伤害信息 - */ - deleteMapDamage(locator: ITileLocator, info: IMapDamageInfo): void; - - /** - * 将指定位置标记为脏,后续访问时会重新计算该点的有来源伤害 - * @param locator 地图定位符 - */ - markDirty(locator: ITileLocator): void; - - /** - * 将指定怪物对应的地图伤害标记为脏并刷新 - * @param view 怪物视图 - */ - markEnemyDirty(view: IEnemyView): void; - - /** - * 基于当前上下文重新刷新全部有来源地图伤害 - */ - refreshAll(): void; - - /** - * 删除指定怪物带来的全部地图伤害来源 - * @param view 怪物视图 - */ - deleteEnemy(view: IEnemyView): void; - - /** - * 获取指定位置合并后的地图伤害 - * @param locator 地图定位符 - */ - getReducedDamage(locator: ITileLocator): Readonly | null; - - /** - * 获取指定位置未合并的地图伤害列表 - * @param locator 地图定位符 - */ - getSeparatedDamage( - locator: ITileLocator - ): Iterable>; -} - -//#endregion - -//#region 伤害系统 - -export interface IEnemyDamageInfo { - /** 战斗伤害值 */ - readonly damage: number; - /** 战斗回合数 */ - readonly turn: number; -} - -export interface IEnemyCritical { - /** 此临界点中指定勇士属性的值 */ - readonly nextValue: number; - /** 当前勇士指定属性的值 */ - readonly baseValue: number; - /** 此临界点中指定勇士数值的值与当前值的差,即 `nextValue - baseValue` */ - readonly nextDiff: number; - /** 当前状态下怪物的伤害信息 */ - readonly baseInfo: IEnemyDamageInfo; - /** 此临界点下怪物的伤害信息 */ - readonly info: IEnemyDamageInfo; - /** 此临界点的伤害值与当前伤害值的差 */ - readonly damageDiff: number; -} - -export type CriticalableHeroStatus = keyof { - [P in keyof THero as THero[P] extends number ? P : never]: number; -}; - -export interface IDamageCalculator { - /** - * 计算战斗伤害信息 - * @param handler 信息对象 - */ - calculate(handler: IReadonlyEnemyHandler): IEnemyDamageInfo; - - /** - * 获取临界计算的上界 - * @param handler 信息对象 - * @param attribute 勇士的临界属性 - */ - getCriticalLimit( - handler: IReadonlyEnemyHandler, - attribute: CriticalableHeroStatus - ): number; -} - -export interface IDamageContext { - /** - * 获取战斗伤害信息 - * @param enemy 怪物视图 - */ - getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null; - - /** - * 根据怪物对象获取战斗伤害信息 - * @param enemy 怪物对象 - */ - getDamageInfoByComputed( - enemy: IReadonlyEnemy - ): IEnemyDamageInfo | null; - - /** - * 计算怪物在指定勇士属性下的临界 - * @param enemy 怪物视图 - * @param attribute 计算临界的目标勇士属性,比如计算攻击临界、自定义属性的临界等等 - * @param precision 临界计算精度,表示会进行多少次二分计算,一般填写 `12-16` 之间的数即可,默认是 12 - */ - calculateCritical( - enemy: IEnemyView, - attribute: CriticalableHeroStatus, - precision?: number - ): Generator; -} - -export interface IDamageSystem extends IDamageContext< - TAttr, - THero -> { - /** 伤害系统所属的上下文 */ - readonly context: IEnemyContext; - - /** - * 设置当前伤害计算系统使用的伤害计算器 - * @param calculator 伤害计算器 - */ - useCalculator(calculator: IDamageCalculator): void; - - /** - * 获取当前使用的伤害计算器 - */ - getCalculator(): IDamageCalculator | null; - - /** - * 绑定勇士信息 - * @param hero 勇士信息 - */ - bindHeroStatus(hero: IReadonlyHeroAttribute | null): void; - - /** - * 将指定的怪物标记为脏 - * @param enemy 怪物视图 - */ - markDirty(enemy: IEnemyView): void; - - /** - * 删除指定的怪物 - * @param enemy 怪物视图 - */ - deleteEnemy(enemy: IEnemyView): void; - - /** - * 将所有怪物标记为脏 - */ - markAllDirty(): void; - - /** - * 修改勇士属性,然后返回修改后勇士属性所组成的计算对象,不影响当前伤害系统的状态 - * @param modify 勇士修改函数 - */ - with(hero: IHeroAttribute): IDamageContext; -} - -//#endregion - -//#region 上下文 - -export interface IEnemyContext { - /** 怪物上下文宽度 */ - readonly width: number; - /** 怪物上下文高度 */ - readonly height: number; - /** 此上下文使用的索引对象 */ - readonly indexer: IMapLocIndexer; - - /** - * 调整上下文尺寸,并清空当前上下文中的所有怪物与状态 - * @param width 地图宽度 - * @param height 地图高度 - */ - resize(width: number, height: number): void; - - /** - * 注册一个光环转换器 - * @param converter 光环转换器 - */ - registerAuraConverter(converter: IAuraConverter): void; - - /** - * 注销一个光环转换器 - * @param converter 光环转换器 - */ - unregisterAuraConverter(converter: IAuraConverter): void; - - /** - * 设置光环转换器的启用状态 - * @param converter 光环转换器 - * @param enabled 是否启用 - */ - setAuraConverterEnabled( - converter: IAuraConverter, - enabled: boolean - ): void; - - /** - * 注册一个特殊属性查询效果 - * @param effect 特殊属性查询效果 - */ - registerSpecialQueryEffect( - effect: IEnemySpecialQueryEffect - ): void; - - /** - * 注销一个特殊属性查询效果 - * @param effect 特殊属性查询效果 - */ - unregisterSpecialQueryEffect( - effect: IEnemySpecialQueryEffect - ): void; - - /** - * 为指定特殊属性代码注册常规查询效果 - * @param code 特殊属性代码 - * @param effect 常规查询效果 - */ - registerCommonQueryEffect( - code: number, - effect: IEnemyCommonQueryEffect - ): void; - - /** - * 注销指定特殊属性代码上的常规查询效果 - * @param code 特殊属性代码 - * @param effect 常规查询效果 - */ - unregisterCommonQueryEffect( - code: number, - effect: IEnemyCommonQueryEffect - ): void; - - /** - * 注册一个最终效果 - * @param effect 最终效果 - */ - registerFinalEffect(effect: IEnemyFinalEffect): void; - - /** - * 注销一个最终效果 - * @param effect 最终效果 - */ - unregisterFinalEffect(effect: IEnemyFinalEffect): void; - - /** - * 绑定勇士对象 - * @param hero 勇士属性对象 - */ - bindHero(hero: IReadonlyHeroAttribute | null): void; - - /** - * 获取当前绑定的勇士属性对象 - */ - getBindedHero(): IReadonlyHeroAttribute | null; - - /** - * 获取指定怪物对象当前所在位置 - * @param enemy 怪物对象 - */ - getEnemyLocator(enemy: IEnemy): Readonly | null; - - /** - * 获取指定怪物视图当前所在位置 - * @param view 怪物视图 - */ - getEnemyLocatorByView( - view: IEnemyView - ): Readonly | null; - - /** - * 根据定位符获取怪物视图 - * @param locator 地图定位符 - */ - getEnemyByLocator(locator: ITileLocator): IEnemyView | null; - - /** - * 根据坐标获取怪物视图 - * @param x 横坐标 - * @param y 纵坐标 - */ - getEnemyByLoc(x: number, y: number): IEnemyView | null; - - /** - * 根据计算后怪物对象反查怪物视图 - * @param enemy 计算后怪物对象 - */ - getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; - - /** - * 在指定位置放置一个怪物对象 - * @param locator 地图定位符 - * @param enemy 怪物对象 - */ - setEnemyAt(locator: ITileLocator, enemy: IEnemy): void; - - /** - * 删除指定位置的怪物 - * @param locator 地图定位符 - */ - deleteEnemy(locator: ITileLocator): void; - - /** - * 扫描指定范围内的怪物视图 - * @param range 范围对象 - * @param param 范围参数 - */ - scanRange( - range: IRange, - param: T - ): Iterable<[ITileLocator, IEnemyView]>; - - /** - * 迭代上下文中的全部怪物 - */ - iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; - - /** - * 添加一个全局光环视图 - * @param aura 光环视图 - */ - addAura(aura: IAuraView): void; - - /** - * 删除一个全局光环视图 - * @param aura 光环视图 - */ - deleteAura(aura: IAuraView): void; - - /** - * 绑定地图伤害管理器 - * @param damage 地图伤害管理器 - */ - attachMapDamage(damage: IMapDamage | null): void; - - /** - * 获取当前绑定的地图伤害管理器 - */ - getMapDamage(): IMapDamage | null; - - /** - * 绑定伤害计算系统 - * @param system 伤害系统 - */ - attachDamageSystem(system: IDamageSystem | null): void; - - /** - * 获取当前绑定的伤害计算系统 - */ - getDamageSystem(): IDamageSystem | null; - - /** - * 重建当前上下文中的全部怪物计算结果 - * - * 1. 对所有光环及特殊查询进行构建操作,这一步中会决定每个怪物所拥有的特殊属性,后续不会变动 - * 2. 执行所有的普通光环效果,修改怪物的基础属性 - * 3. 执行常规查询效果,允许查询上下文状态并修改怪物自身的基础属性 - * 4. 执行最终效果,不允许查询上下文状态,仅允许修改怪物自身的基础属性 - */ - buildup(): void; - - /** - * 将指定怪物视图标记为脏 - * @param view 怪物视图 - */ - markDirty(view: IEnemyView): void; - - /** - * 申请刷新指定怪物视图 - * @param view 怪物视图 - */ - requestRefresh(view: IEnemyView): void; - - /** - * 清空当前上下文中的所有对象与运行状态 - */ - clear(): void; - - /** - * 销毁当前上下文 - */ - destroy(): void; -} - -//#endregion diff --git a/packages-user/data-base/src/enemy/utils.ts b/packages-user/data-base/src/enemy/utils.ts deleted file mode 100644 index 088d186..0000000 --- a/packages-user/data-base/src/enemy/utils.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { ITileLocator } from '@motajs/common'; -import { IMapLocIndexer } from './types'; - -export class MapLocIndexer implements IMapLocIndexer { - private width: number = 0; - - setWidth(width: number): void { - this.width = width; - } - - locToIndex(x: number, y: number): number { - return y * this.width + x; - } - - locaterToIndex(locator: ITileLocator): number { - return locator.y * this.width + locator.x; - } - - indexToLocator(index: number): ITileLocator { - return { - x: index % this.width, - y: Math.floor(index / this.width) - }; - } -} diff --git a/packages-user/data-base/src/index.ts b/packages-user/data-base/src/index.ts index 0be7276..f71b3b5 100644 --- a/packages-user/data-base/src/index.ts +++ b/packages-user/data-base/src/index.ts @@ -1,3 +1,4 @@ +export * from './combat'; export * from './common'; export * from './enemy'; export * from './flag'; From 43ad3fd83e93b776120384f13d366d8900f173db Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Tue, 12 May 2026 17:26:57 +0800 Subject: [PATCH 12/26] =?UTF-8?q?feat:=20IEnemyHandler=20=E5=BC=95?= =?UTF-8?q?=E5=85=A5=20IStateBase=20=E6=88=90=E5=91=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/data-base/src/combat/context.ts | 143 +++++++------ packages-user/data-base/src/combat/damage.ts | 52 ++--- .../data-base/src/combat/mapDamage.ts | 35 ++-- packages-user/data-base/src/combat/types.ts | 193 ++++++++++-------- packages-user/data-base/src/enemy/enemy.ts | 2 +- packages-user/data-base/src/enemy/special.ts | 2 +- packages-user/data-base/src/enemy/types.ts | 2 +- 7 files changed, 232 insertions(+), 197 deletions(-) diff --git a/packages-user/data-base/src/combat/context.ts b/packages-user/data-base/src/combat/context.ts index 165a7b9..2a6287f 100644 --- a/packages-user/data-base/src/combat/context.ts +++ b/packages-user/data-base/src/combat/context.ts @@ -18,66 +18,73 @@ import { IReadonlyHeroAttribute } from '../hero'; import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; import { EnemyView } from './enemy'; import { ILocationIndexer, MapLocIndexer } from '../common/indexer'; +import { IStateBase } from '../types'; -export class EnemyContext implements IEnemyContext { +export class EnemyContext implements IEnemyContext< + TEnemy, + THero +> { /** 坐标索引 -> 怪物视图 */ - private readonly enemyViewMap: Map> = new Map(); + private readonly enemyViewMap: Map> = new Map(); /** 坐标索引 -> 计算前怪物对象 */ - private readonly enemyMap: Map> = new Map(); + private readonly enemyMap: Map> = new Map(); /** 怪物视图 -> 坐标索引 */ - private readonly locatorViewMap: Map, number> = new Map(); + private readonly locatorViewMap: Map, number> = + new Map(); /** 计算前怪物对象 -> 坐标索引 */ - private readonly locatorEnemyMap: Map, number> = new Map(); + private readonly locatorEnemyMap: Map, number> = new Map(); /** 计算后怪物对象 -> 怪物视图 */ private readonly computedToView: Map< - IReadonlyEnemy, - EnemyView + IReadonlyEnemy, + EnemyView > = new Map(); /** 当前已注册的光环转换器 */ - private readonly auraConverter: Set> = + private readonly auraConverter: Set> = new Set(); /** 光环转换器是否启用 */ private readonly converterStatus: Map< - IAuraConverter, + IAuraConverter, boolean > = new Map(); /** 所有已被转换的光环 */ - private readonly convertedAura: Map, IAuraView> = + private readonly convertedAura: Map, IAuraView> = new Map(); /** 普通查询效果注册,特殊属性 -> 此特殊属性的查询效果列表,按照优先级从高到低排序 */ private readonly commonQueryMap: Map< number, - IEnemyCommonQueryEffect[] + IEnemyCommonQueryEffect[] > = new Map(); /** 特殊查询效果注册,特殊属性 -> 此特殊属性的特殊查询效果列表,按照优先级从高到低排序 */ private readonly specialQueryEffects: Map< number, - IEnemySpecialQueryEffect[] + IEnemySpecialQueryEffect[] > = new Map(); /** 最终效果列表,按照优先级从高到低排列 */ - private readonly finalEffects: IEnemyFinalEffect[] = []; + private readonly finalEffects: IEnemyFinalEffect[] = []; /** 添加的无来源全局光环列表 */ - private readonly globalAuraList: Set> = new Set(); + private readonly globalAuraList: Set> = new Set(); /** 排序后的光环视图,视图优先级 -> 光环视图列表 */ - private readonly sortedAura: Map>> = new Map(); + private readonly sortedAura: Map>> = + new Map(); /** 当怪物更新后,需要对上下文进行全量刷新的怪物列表 */ - private readonly needTotallyRefresh: Set> = new Set(); + private readonly needTotallyRefresh: Set> = new Set(); /** 所有实际查询了上下文的常规查询效果,这些怪物需要在上下文或其他怪物刷新时一并刷新 */ - private readonly requestedCommonContext: Set> = new Set(); + private readonly requestedCommonContext: Set> = + new Set(); /** 所有需要被标记为脏的怪物 */ - private readonly dirtyEnemy: Set> = new Set(); + private readonly dirtyEnemy: Set> = new Set(); /** 当前绑定的勇士属性对象 */ private bindedHero: IReadonlyHeroAttribute | null = null; /** 地图伤害对象 */ - private mapDamage: IMapDamage | null = null; + private mapDamage: IMapDamage | null = null; /** 伤害系统对象 */ - private damageSystem: IDamageSystem | null = null; + private damageSystem: IDamageSystem | null = null; /** 索引工具 */ readonly indexer: ILocationIndexer = new MapLocIndexer(); @@ -89,6 +96,8 @@ export class EnemyContext implements IEnemyContext { width: number = 0; height: number = 0; + constructor(readonly dataState: IStateBase) {} + resize(width: number, height: number): void { this.clear(); this.width = width; @@ -97,20 +106,20 @@ export class EnemyContext implements IEnemyContext { this.needUpdate = true; } - registerAuraConverter(converter: IAuraConverter): void { + registerAuraConverter(converter: IAuraConverter): void { this.auraConverter.add(converter); this.converterStatus.set(converter, true); this.needUpdate = true; } - unregisterAuraConverter(converter: IAuraConverter): void { + unregisterAuraConverter(converter: IAuraConverter): void { this.auraConverter.delete(converter); this.converterStatus.delete(converter); this.needUpdate = true; } setAuraConverterEnabled( - converter: IAuraConverter, + converter: IAuraConverter, enabled: boolean ): void { if (!this.auraConverter.has(converter)) return; @@ -120,7 +129,7 @@ export class EnemyContext implements IEnemyContext { registerCommonQueryEffect( code: number, - effect: IEnemyCommonQueryEffect + effect: IEnemyCommonQueryEffect ): void { const array = this.commonQueryMap.getOrInsert(code, []); array.push(effect); @@ -130,7 +139,7 @@ export class EnemyContext implements IEnemyContext { unregisterCommonQueryEffect( code: number, - effect: IEnemyCommonQueryEffect + effect: IEnemyCommonQueryEffect ): void { const array = this.commonQueryMap.get(code); if (!array) return; @@ -141,7 +150,7 @@ export class EnemyContext implements IEnemyContext { } registerSpecialQueryEffect( - effect: IEnemySpecialQueryEffect + effect: IEnemySpecialQueryEffect ): void { const list = this.specialQueryEffects.getOrInsert(effect.priority, []); list.push(effect); @@ -149,7 +158,7 @@ export class EnemyContext implements IEnemyContext { } unregisterSpecialQueryEffect( - effect: IEnemySpecialQueryEffect + effect: IEnemySpecialQueryEffect ): void { const list = this.specialQueryEffects.get(effect.priority); if (!list) return; @@ -163,13 +172,13 @@ export class EnemyContext implements IEnemyContext { this.needUpdate = true; } - registerFinalEffect(effect: IEnemyFinalEffect): void { + registerFinalEffect(effect: IEnemyFinalEffect): void { this.finalEffects.push(effect); this.finalEffects.sort((a, b) => b.priority - a.priority); this.needUpdate = true; } - unregisterFinalEffect(effect: IEnemyFinalEffect): void { + unregisterFinalEffect(effect: IEnemyFinalEffect): void { const index = this.finalEffects.indexOf(effect); if (index !== -1) { this.finalEffects.splice(index, 1); @@ -194,37 +203,39 @@ export class EnemyContext implements IEnemyContext { * @param locator 怪物位置 */ private createHandler( - enemy: IEnemy, + enemy: IEnemy, locator: ITileLocator - ): IEnemyHandler { - return { enemy, locator, hero: this.bindedHero! }; + ): IEnemyHandler { + return { enemy, locator, hero: this.bindedHero!, data: this.dataState }; } - getEnemyLocator(enemy: IEnemy): Readonly | null { + getEnemyLocator(enemy: IEnemy): Readonly | null { const index = this.locatorEnemyMap.get(enemy); if (index === undefined) return null; return this.indexer.indexToLocator(index); } getEnemyLocatorByView( - view: IEnemyView + view: IEnemyView ): Readonly | null { const index = this.locatorViewMap.get(view); if (index === undefined) return null; return this.indexer.indexToLocator(index); } - getEnemyByLocator(locator: ITileLocator): IEnemyView | null { + getEnemyByLocator(locator: ITileLocator): IEnemyView | null { const index = this.indexer.locToIndex(locator.x, locator.y); return this.enemyViewMap.get(index) ?? null; } - getEnemyByLoc(x: number, y: number): IEnemyView | null { + getEnemyByLoc(x: number, y: number): IEnemyView | null { const index = this.indexer.locToIndex(x, y); return this.enemyViewMap.get(index) ?? null; } - getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null { + getViewByComputed( + enemy: IReadonlyEnemy + ): IEnemyView | null { return this.computedToView.get(enemy) ?? null; } @@ -256,11 +267,11 @@ export class EnemyContext implements IEnemyContext { this.locatorEnemyMap.delete(enemy); } - setEnemyAt(locator: ITileLocator, enemy: IEnemy): void { + setEnemyAt(locator: ITileLocator, enemy: IEnemy): void { const index = this.indexer.locToIndex(locator.x, locator.y); this.deleteEnemyAt(index); - const view = new EnemyView(enemy, this); + const view = new EnemyView(enemy, this); this.enemyMap.set(index, enemy); this.enemyViewMap.set(index, view); this.locatorEnemyMap.set(enemy, index); @@ -290,7 +301,7 @@ export class EnemyContext implements IEnemyContext { private *internalScanRange( range: IRange, param: T - ): Iterable<[ITileLocator, EnemyView]> { + ): Iterable<[ITileLocator, EnemyView]> { range.bindHost(this); const keys = new Set(this.enemyViewMap.keys()); const matched = range.autoDetect(keys, param); @@ -307,46 +318,46 @@ export class EnemyContext implements IEnemyContext { scanRange( range: IRange, param: T - ): Iterable<[ITileLocator, IEnemyView]> { + ): Iterable<[ITileLocator, IEnemyView]> { return this.internalScanRange(range, param); } - *iterateEnemy(): Iterable<[ITileLocator, IEnemyView]> { + *iterateEnemy(): Iterable<[ITileLocator, IEnemyView]> { for (const [index, view] of this.enemyViewMap) { const locator = this.indexer.indexToLocator(index); yield [locator, view]; } } - addAura(aura: IAuraView): void { + addAura(aura: IAuraView): void { this.globalAuraList.add(aura); this.needUpdate = true; } - deleteAura(aura: IAuraView): void { + deleteAura(aura: IAuraView): void { this.globalAuraList.delete(aura); this.needUpdate = true; } - attachMapDamage(damage: IMapDamage | null): void { + attachMapDamage(damage: IMapDamage | null): void { this.mapDamage = damage; if (damage) { damage.refreshAll(); } } - getMapDamage(): IMapDamage | null { + getMapDamage(): IMapDamage | null { return this.mapDamage; } - attachDamageSystem(system: IDamageSystem | null): void { + attachDamageSystem(system: IDamageSystem | null): void { this.damageSystem = system; if (system) { system.bindHeroStatus(this.bindedHero); } } - getDamageSystem(): IDamageSystem | null { + getDamageSystem(): IDamageSystem | null { return this.damageSystem; } @@ -358,9 +369,9 @@ export class EnemyContext implements IEnemyContext { */ private convertSpecial( special: ISpecial, - handler: IReadonlyEnemyHandler - ): IEnemyAuraView | null { - let matched: IAuraConverter | null = null; + handler: IReadonlyEnemyHandler + ): IEnemyAuraView | null { + let matched: IAuraConverter | null = null; for (const converter of this.auraConverter) { if (!this.converterStatus.get(converter)) continue; if (converter.shouldConvert(special, handler)) { @@ -380,7 +391,7 @@ export class EnemyContext implements IEnemyContext { * 将光环按优先级插入到有序表中 * @param aura 光环视图 */ - private insertIntoSortedAura(aura: IAuraView): void { + private insertIntoSortedAura(aura: IAuraView): void { const set = this.sortedAura.getOrInsertComputed( aura.priority, () => new Set() @@ -392,7 +403,7 @@ export class EnemyContext implements IEnemyContext { * 从优先级表中移除一个光环 * @param aura 光环视图 */ - private removeFromSortedAura(aura: IAuraView): void { + private removeFromSortedAura(aura: IAuraView): void { const set = this.sortedAura.get(aura.priority); if (set) { set.delete(aura); @@ -410,12 +421,12 @@ export class EnemyContext implements IEnemyContext { * @param currentPriority 当前处理的优先级 */ private processSpecialModifier( - modifier: IEnemySpecialModifier, - handler: IEnemyHandler, + modifier: IEnemySpecialModifier, + handler: IEnemyHandler, currentPriority: number - ): Set> { + ): Set> { const enemy = handler.enemy; - const affectedAuras = new Set>(); + const affectedAuras = new Set>(); const toAdd = modifier.add(handler); const toDelete = modifier.delete(handler); @@ -487,7 +498,7 @@ export class EnemyContext implements IEnemyContext { * @param currentPriority 当前处理的优先级 */ private processSpecialQuery( - effect: IEnemySpecialQueryEffect, + effect: IEnemySpecialQueryEffect, currentPriority: number ): void { const modifier = effect.for(this); @@ -519,7 +530,7 @@ export class EnemyContext implements IEnemyContext { * @param currentPriority 当前处理的优先级 */ private processAuraSpecial( - aura: IAuraView, + aura: IAuraView, currentPriority: number ): void { const param = aura.getRangeParam(); @@ -694,7 +705,7 @@ export class EnemyContext implements IEnemyContext { } } - markDirty(view: IEnemyView): void { + markDirty(view: IEnemyView): void { if (!this.locatorViewMap.has(view)) return; this.dirtyEnemy.add(view); if (this.damageSystem) { @@ -709,8 +720,8 @@ export class EnemyContext implements IEnemyContext { * @param locator 怪物位置 */ private refreshSpecialModifier( - modifier: IEnemySpecialModifier, - handler: IEnemyHandler + modifier: IEnemySpecialModifier, + handler: IEnemyHandler ): void { const enemy = handler.enemy; const toAdd = modifier.add(handler); @@ -756,7 +767,7 @@ export class EnemyContext implements IEnemyContext { * 刷新单个怪物视图的计算结果 * @param view 怪物视图 */ - private refreshEnemy(view: EnemyView): void { + private refreshEnemy(view: EnemyView): void { const locator = this.getEnemyLocatorByView(view); if (!locator) return; @@ -851,7 +862,7 @@ export class EnemyContext implements IEnemyContext { } } - requestRefresh(view: IEnemyView): void { + requestRefresh(view: IEnemyView): void { if (!this.dirtyEnemy.has(view)) return; if (this.needTotallyRefresh.has(view)) { this.needUpdate = true; @@ -861,11 +872,11 @@ export class EnemyContext implements IEnemyContext { return; } - this.refreshEnemy(view as EnemyView); + this.refreshEnemy(view as EnemyView); for (const requestedView of this.requestedCommonContext) { if (requestedView === view) continue; - this.refreshEnemy(requestedView as EnemyView); + this.refreshEnemy(requestedView as EnemyView); } } diff --git a/packages-user/data-base/src/combat/damage.ts b/packages-user/data-base/src/combat/damage.ts index 10842af..ce70711 100644 --- a/packages-user/data-base/src/combat/damage.ts +++ b/packages-user/data-base/src/combat/damage.ts @@ -13,6 +13,7 @@ import { } from './types'; import { IHeroAttribute, IReadonlyHeroAttribute } from '../hero'; import { IReadonlyEnemy } from '../enemy'; +import { IStateBase } from '../types'; interface ICriticalSearchResult { /** 此临界点的属性值 */ @@ -21,20 +22,23 @@ interface ICriticalSearchResult { readonly info: IEnemyDamageInfo; } -export class DamageContext implements IDamageContext< - TAttr, +export class DamageContext implements IDamageContext< + TEnemy, THero > { /** 当前正在使用的计算器 */ - protected calculator: IDamageCalculator | null; + protected calculator: IDamageCalculator | null; /** 当前勇士属性 */ protected heroStatus: IReadonlyHeroAttribute | null; + readonly dataState: IStateBase; + constructor( - readonly context: IEnemyContext, - calculator: IDamageCalculator | null = null, + readonly context: IEnemyContext, + calculator: IDamageCalculator | null = null, heroStatus: IReadonlyHeroAttribute | null = null ) { + this.dataState = context.dataState; this.calculator = calculator; this.heroStatus = heroStatus; } @@ -46,14 +50,14 @@ export class DamageContext implements IDamageContext< * @param hero 勇士属性对象 */ private createReadonlyHandler( - enemy: IReadonlyEnemy, + enemy: IReadonlyEnemy, locator: ITileLocator, hero: IReadonlyHeroAttribute - ): IReadonlyEnemyHandler { - return { enemy, locator, hero }; + ): IReadonlyEnemyHandler { + return { enemy, locator, hero, data: this.dataState }; } - getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null { + getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null { if (!this.heroStatus) { logger.warn(107); return null; @@ -73,7 +77,7 @@ export class DamageContext implements IDamageContext< } getDamageInfoByComputed( - enemy: IReadonlyEnemy + enemy: IReadonlyEnemy ): IEnemyDamageInfo | null { if (!this.heroStatus) { logger.warn(107); @@ -96,7 +100,7 @@ export class DamageContext implements IDamageContext< } *calculateCritical( - view: IEnemyView, + view: IEnemyView, attribute: CriticalableHeroStatus, precision: number = 12 ): Generator { @@ -168,7 +172,7 @@ export class DamageContext implements IDamageContext< * @param maxIterations 最大迭代数量 */ private findNextCritical( - handler: IReadonlyEnemyHandler, + handler: IReadonlyEnemyHandler, hero: IHeroAttribute, attribute: CriticalableHeroStatus, currentValue: number, @@ -206,24 +210,24 @@ export class DamageContext implements IDamageContext< } } -export class DamageSystem - extends DamageContext - implements IDamageSystem +export class DamageSystem + extends DamageContext + implements IDamageSystem { /** 怪物伤害缓存 */ - private readonly cache: Map, IEnemyDamageInfo> = + private readonly cache: Map, IEnemyDamageInfo> = new Map(); - constructor(context: IEnemyContext) { + constructor(context: IEnemyContext) { super(context); } - useCalculator(calculator: IDamageCalculator): void { + useCalculator(calculator: IDamageCalculator): void { this.calculator = calculator; this.markAllDirty(); } - getCalculator(): IDamageCalculator | null { + getCalculator(): IDamageCalculator | null { return this.calculator; } @@ -232,7 +236,7 @@ export class DamageSystem this.markAllDirty(); } - getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null { + getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null { const cached = this.cache.get(enemy); if (cached) { return cached; @@ -246,7 +250,7 @@ export class DamageSystem } getDamageInfoByComputed( - enemy: IReadonlyEnemy + enemy: IReadonlyEnemy ): IEnemyDamageInfo | null { const view = this.context.getViewByComputed(enemy); if (view) { @@ -264,11 +268,11 @@ export class DamageSystem return info; } - markDirty(enemy: IEnemyView): void { + markDirty(enemy: IEnemyView): void { this.cache.delete(enemy); } - deleteEnemy(enemy: IEnemyView): void { + deleteEnemy(enemy: IEnemyView): void { this.cache.delete(enemy); } @@ -276,7 +280,7 @@ export class DamageSystem this.cache.clear(); } - with(hero: IHeroAttribute): IDamageContext { + with(hero: IHeroAttribute): IDamageContext { return new DamageContext(this.context, this.calculator, hero); } } diff --git a/packages-user/data-base/src/combat/mapDamage.ts b/packages-user/data-base/src/combat/mapDamage.ts index 5d3d576..2fd36e3 100644 --- a/packages-user/data-base/src/combat/mapDamage.ts +++ b/packages-user/data-base/src/combat/mapDamage.ts @@ -10,6 +10,7 @@ import { IMapDamageView } from './types'; import { ILocationHelper } from '../common/indexer'; +import { IStateBase } from '../types'; interface IPointInfo { /** 该点所有的地图伤害 */ @@ -34,9 +35,9 @@ interface IDamageStore { readonly index: number; } -export class MapDamage implements IMapDamage { +export class MapDamage implements IMapDamage { /** 当前使用的地图伤害转换器 */ - private converter: IMapDamageConverter | null = null; + private converter: IMapDamageConverter | null = null; /** 当前使用的地图伤害合并器 */ private reducer: IMapDamageReducer | null = null; @@ -45,14 +46,14 @@ export class MapDamage implements IMapDamage { /** 有来源地图伤害,坐标 -> 点伤害信息 */ private readonly sourcedDamage: Map = new Map(); /** 地图伤害视图 -> 其信息对象 */ - private readonly viewStore: Map, IViewStore> = + private readonly viewStore: Map, IViewStore> = new Map(); /** 地图伤害信息 -> 其信息对象 */ - private readonly damageStore: Map> = + private readonly damageStore: Map> = new Map(); /** 怪物视图 -> 其影响对象 */ private readonly enemyStore: Map< - IEnemyView, + IEnemyView, Set> > = new Map(); /** 需要延迟刷新的坐标索引 */ @@ -63,11 +64,14 @@ export class MapDamage implements IMapDamage { /** 坐标索引对象 */ private readonly indexer: ILocationHelper; - constructor(readonly context: IEnemyContext) { + readonly dataState: IStateBase; + + constructor(readonly context: IEnemyContext) { this.indexer = context.indexer; + this.dataState = context.dataState; } - useConverter(converter: IMapDamageConverter): void { + useConverter(converter: IMapDamageConverter): void { this.converter = converter; this.refreshAll(); } @@ -78,15 +82,16 @@ export class MapDamage implements IMapDamage { * @param locator 怪物位置 */ private createReadonlyHandler( - view: IEnemyView, + view: IEnemyView, locator: ITileLocator - ): IReadonlyEnemyHandler | null { + ): IReadonlyEnemyHandler | null { const hero = this.context.getBindedHero(); if (!hero) return null; return { enemy: view.getComputedEnemy(), locator, - hero + hero, + data: this.context.dataState }; } @@ -126,7 +131,7 @@ export class MapDamage implements IMapDamage { this.markDirtyIndex(this.indexer.locaterToIndex(locator)); } - markEnemyDirty(view: IEnemyView): void { + markEnemyDirty(view: IEnemyView): void { const store = this.enemyStore.get(view); const locator = this.context.getEnemyLocatorByView(view); if (!store) { @@ -141,7 +146,7 @@ export class MapDamage implements IMapDamage { this.refreshEnemyAndClearCache(view, locator); } - deleteEnemy(view: IEnemyView): void { + deleteEnemy(view: IEnemyView): void { const store = this.enemyStore.get(view); if (!store) return; const collection = new Set(); @@ -231,7 +236,7 @@ export class MapDamage implements IMapDamage { * 移除指定怪物所产生的地图伤害 * @param view 怪物视图 */ - private removeEnemyAffecting(view: IEnemyView) { + private removeEnemyAffecting(view: IEnemyView) { const views = this.enemyStore.get(view); if (!views) return; views.forEach(viewItem => { @@ -253,7 +258,7 @@ export class MapDamage implements IMapDamage { * 刷新指定位置的怪物地图伤害,并执行刷新缓存的操作 */ private refreshEnemyAndClearCache( - view: IEnemyView, + view: IEnemyView, locator: ITileLocator ) { this.removeEnemyAffecting(view); @@ -295,7 +300,7 @@ export class MapDamage implements IMapDamage { /** * 刷新指定位置的怪物地图伤害 */ - private refreshEnemy(view: IEnemyView, locator: ITileLocator) { + private refreshEnemy(view: IEnemyView, locator: ITileLocator) { this.removeEnemyAffecting(view); if (!this.converter) return; const handler = this.createReadonlyHandler(view, locator); diff --git a/packages-user/data-base/src/combat/types.ts b/packages-user/data-base/src/combat/types.ts index b3ae7f5..6f6b584 100644 --- a/packages-user/data-base/src/combat/types.ts +++ b/packages-user/data-base/src/combat/types.ts @@ -2,34 +2,39 @@ import { ITileLocator, IRange } from '@motajs/common'; import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; import { IReadonlyHeroAttribute, IHeroAttribute } from '../hero'; import { ILocationHelper } from '../common/indexer'; +import { IStateBase } from '../types'; //#region 辅助接口 -export interface IEnemyHandler { +export interface IEnemyHandler { /** 怪物属性信息 */ - readonly enemy: IEnemy; + readonly enemy: IEnemy; /** 怪物定位符 */ readonly locator: ITileLocator; /** 勇士属性信息 */ readonly hero: IReadonlyHeroAttribute; + /** 当前全局状态对象 */ + readonly data: IStateBase; } -export interface IReadonlyEnemyHandler { +export interface IReadonlyEnemyHandler { /** 怪物属性信息 */ - readonly enemy: IReadonlyEnemy; + readonly enemy: IReadonlyEnemy; /** 怪物定位符 */ readonly locator: ITileLocator; /** 勇士属性信息 */ readonly hero: IReadonlyHeroAttribute; + /** 当前全局状态对象 */ + readonly data: IStateBase; } //#endregion //#region 怪物对象 -export interface IEnemyView { +export interface IEnemyView { /** 怪物视图所属的上下文 */ - readonly context: IEnemyContext; + readonly context: IEnemyContext; /** * 重置此怪物视图的状态,将计算后怪物对象恢复至初始状态 @@ -39,18 +44,18 @@ export interface IEnemyView { /** * 获取基本怪物对象 */ - getBaseEnemy(): IReadonlyEnemy; + getBaseEnemy(): IReadonlyEnemy; /** * 获取计算后的怪物对象,返回的怪物对象同引用 */ - getComputedEnemy(): IReadonlyEnemy; + getComputedEnemy(): IReadonlyEnemy; /** * 获取可修改的怪物对象。如果修改此方法获取的怪物对象,那么怪物的真实信息是不会刷新的, * 需要手动调用 markDirty 方法来刷新。 */ - getModifiableEnemy(): IEnemy; + getModifiableEnemy(): IEnemy; /** * 将此怪物标记为脏,需要更新 @@ -62,18 +67,18 @@ export interface IEnemyView { //#region 光环与查询 -export interface IEnemySpecialModifier { +export interface IEnemySpecialModifier { /** * 获取要添加到指定怪物身上的特殊属性 * @param handler 信息对象 */ - add(handler: IReadonlyEnemyHandler): ISpecial[]; + add(handler: IReadonlyEnemyHandler): ISpecial[]; /** * 获取制定怪物身上要删除的特殊属性 * @param handler 信息对象 */ - delete(handler: IReadonlyEnemyHandler): ISpecial[]; + delete(handler: IReadonlyEnemyHandler): ISpecial[]; /** * 修改一个怪物的特殊属性,如果真正进行了修改则返回 true,否则返回 false @@ -81,16 +86,16 @@ export interface IEnemySpecialModifier { * @param special 要修改的怪物特殊属性 */ modify( - handler: IEnemyHandler, + handler: IEnemyHandler, special: ISpecial ): boolean; } -export interface IAuraView { +export interface IAuraView { /** 此光环视图的优先级 */ readonly priority: number; /** 此光环视图的影响范围 */ - readonly range: IRange; + readonly range: IRange; /** 这个光环视图是否有可能修改怪物的基本属性 */ readonly couldApplyBase: boolean; @@ -100,7 +105,7 @@ export interface IAuraView { /** * 获取范围扫描参数 */ - getRangeParam(): T; + getRangeParam(): TRange; /** * 对指定怪物对象施加修饰器 @@ -108,8 +113,8 @@ export interface IAuraView { * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 */ apply( - handler: IEnemyHandler, - baseEnemy: IReadonlyEnemy + handler: IEnemyHandler, + baseEnemy: IReadonlyEnemy ): void; /** @@ -118,21 +123,24 @@ export interface IAuraView { * @param baseEnemy 原始怪物对象,即未进行任何修改的怪物对象 */ applySpecial( - handler: IEnemyHandler, - baseEnemy: IReadonlyEnemy - ): IEnemySpecialModifier | null; + handler: IEnemyHandler, + baseEnemy: IReadonlyEnemy + ): IEnemySpecialModifier | null; } -export interface IEnemyAuraView extends IAuraView { +export interface IEnemyAuraView extends IAuraView< + TEnemy, + TRange +> { /** 此光环视图所属的怪物 */ - readonly enemy: IReadonlyEnemy; + readonly enemy: IReadonlyEnemy; /** 此光环视图所属的特殊属性 */ - readonly special: ISpecial; + readonly special: ISpecial; /** 此光环视图所属怪物的定位符 */ readonly locator: ITileLocator; } -export interface IAuraConverter { +export interface IAuraConverter { /** * 判断一个特殊属性是否应该被当前光环转换器执行转换 * @param special 要转换的特殊属性 @@ -140,7 +148,7 @@ export interface IAuraConverter { */ shouldConvert( special: ISpecial, - handler: IReadonlyEnemyHandler + handler: IReadonlyEnemyHandler ): boolean; /** @@ -148,22 +156,22 @@ export interface IAuraConverter { */ convert( special: ISpecial, - handler: IReadonlyEnemyHandler, - context: IEnemyContext - ): IEnemyAuraView; + handler: IReadonlyEnemyHandler, + context: IEnemyContext + ): IEnemyAuraView; } export interface IEnemySpecialQueryModifier< - TAttr, + TEnemy, THero -> extends IEnemySpecialModifier { +> extends IEnemySpecialModifier { /** * 判断一个怪物是否应该查询外部状态 */ - shouldQuery(handler: IReadonlyEnemyHandler): boolean; + shouldQuery(handler: IReadonlyEnemyHandler): boolean; } -export interface IEnemySpecialQueryEffect { +export interface IEnemySpecialQueryEffect { /** 效果优先级,与光环属性共用 */ readonly priority: number; @@ -171,11 +179,11 @@ export interface IEnemySpecialQueryEffect { * 根据传入的怪物上下文,获取对应的怪物特殊属性修饰器 */ for( - ctx: IEnemyContext - ): IEnemySpecialQueryModifier; + ctx: IEnemyContext + ): IEnemySpecialQueryModifier; } -export interface IEnemyCommonQueryEffect { +export interface IEnemyCommonQueryEffect { /** 优先级,越高的越先执行 */ readonly priority: number; @@ -183,20 +191,20 @@ export interface IEnemyCommonQueryEffect { * 对怪物的某个特殊属性施加常规查询效果 */ apply( - handler: IEnemyHandler, + handler: IEnemyHandler, special: ISpecial, - query: () => IEnemyContext + query: () => IEnemyContext ): void; } -export interface IEnemyFinalEffect { +export interface IEnemyFinalEffect { /** 效果优先级,越高会越先被执行 */ readonly priority: number; /** * 向怪物施加最终修饰效果 */ - apply(handler: IEnemyHandler): void; + apply(handler: IEnemyHandler): void; } //#endregion @@ -245,13 +253,13 @@ export interface IMapDamageView { ): Readonly | null; } -export interface IMapDamageConverter { +export interface IMapDamageConverter { /** * 转换地图伤害视图 */ convert( - handler: IReadonlyEnemyHandler, - context: IEnemyContext + handler: IReadonlyEnemyHandler, + context: IEnemyContext ): IMapDamageView[]; } @@ -265,15 +273,17 @@ export interface IMapDamageReducer { ): Readonly; } -export interface IMapDamage { +export interface IMapDamage { /** 当前绑定的怪物上下文 */ - readonly context: IEnemyContext; + readonly context: IEnemyContext; + /** 地图伤害系统绑定的全局状态对象 */ + readonly dataState: IStateBase; /** * 设置地图伤害转换器,并基于当前上下文重建所有地图伤害视图 * @param converter 地图伤害转换器 */ - useConverter(converter: IMapDamageConverter): void; + useConverter(converter: IMapDamageConverter): void; /** * 设置地图伤害合并器 @@ -305,7 +315,7 @@ export interface IMapDamage { * 将指定怪物对应的地图伤害标记为脏并刷新 * @param view 怪物视图 */ - markEnemyDirty(view: IEnemyView): void; + markEnemyDirty(view: IEnemyView): void; /** * 基于当前上下文重新刷新全部有来源地图伤害 @@ -316,7 +326,7 @@ export interface IMapDamage { * 删除指定怪物带来的全部地图伤害来源 * @param view 怪物视图 */ - deleteEnemy(view: IEnemyView): void; + deleteEnemy(view: IEnemyView): void; /** * 获取指定位置合并后的地图伤害 @@ -363,12 +373,12 @@ export type CriticalableHeroStatus = keyof { [P in keyof THero as THero[P] extends number ? P : never]: number; }; -export interface IDamageCalculator { +export interface IDamageCalculator { /** * 计算战斗伤害信息 * @param handler 信息对象 */ - calculate(handler: IReadonlyEnemyHandler): IEnemyDamageInfo; + calculate(handler: IReadonlyEnemyHandler): IEnemyDamageInfo; /** * 获取临界计算的上界 @@ -376,24 +386,27 @@ export interface IDamageCalculator { * @param attribute 勇士的临界属性 */ getCriticalLimit( - handler: IReadonlyEnemyHandler, + handler: IReadonlyEnemyHandler, attribute: CriticalableHeroStatus ): number; } -export interface IDamageContext { +export interface IDamageContext { + /** 伤害上下文所属的全局状态对象 */ + readonly dataState: IStateBase; + /** * 获取战斗伤害信息 * @param enemy 怪物视图 */ - getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null; + getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null; /** * 根据怪物对象获取战斗伤害信息 * @param enemy 怪物对象 */ getDamageInfoByComputed( - enemy: IReadonlyEnemy + enemy: IReadonlyEnemy ): IEnemyDamageInfo | null; /** @@ -403,29 +416,29 @@ export interface IDamageContext { * @param precision 临界计算精度,表示会进行多少次二分计算,一般填写 `12-16` 之间的数即可,默认是 12 */ calculateCritical( - enemy: IEnemyView, + enemy: IEnemyView, attribute: CriticalableHeroStatus, precision?: number ): Generator; } -export interface IDamageSystem extends IDamageContext< - TAttr, +export interface IDamageSystem extends IDamageContext< + TEnemy, THero > { /** 伤害系统所属的上下文 */ - readonly context: IEnemyContext; + readonly context: IEnemyContext; /** * 设置当前伤害计算系统使用的伤害计算器 * @param calculator 伤害计算器 */ - useCalculator(calculator: IDamageCalculator): void; + useCalculator(calculator: IDamageCalculator): void; /** * 获取当前使用的伤害计算器 */ - getCalculator(): IDamageCalculator | null; + getCalculator(): IDamageCalculator | null; /** * 绑定勇士信息 @@ -437,13 +450,13 @@ export interface IDamageSystem extends IDamageContext< * 将指定的怪物标记为脏 * @param enemy 怪物视图 */ - markDirty(enemy: IEnemyView): void; + markDirty(enemy: IEnemyView): void; /** * 删除指定的怪物 * @param enemy 怪物视图 */ - deleteEnemy(enemy: IEnemyView): void; + deleteEnemy(enemy: IEnemyView): void; /** * 将所有怪物标记为脏 @@ -454,20 +467,22 @@ export interface IDamageSystem extends IDamageContext< * 修改勇士属性,然后返回修改后勇士属性所组成的计算对象,不影响当前伤害系统的状态 * @param modify 勇士修改函数 */ - with(hero: IHeroAttribute): IDamageContext; + with(hero: IHeroAttribute): IDamageContext; } //#endregion //#region 上下文 -export interface IEnemyContext { +export interface IEnemyContext { /** 怪物上下文宽度 */ readonly width: number; /** 怪物上下文高度 */ readonly height: number; /** 此上下文使用的索引对象 */ readonly indexer: ILocationHelper; + /** 当前怪物上下文绑定的全局状态对象 */ + readonly dataState: IStateBase; /** * 调整上下文尺寸,并清空当前上下文中的所有怪物与状态 @@ -480,13 +495,13 @@ export interface IEnemyContext { * 注册一个光环转换器 * @param converter 光环转换器 */ - registerAuraConverter(converter: IAuraConverter): void; + registerAuraConverter(converter: IAuraConverter): void; /** * 注销一个光环转换器 * @param converter 光环转换器 */ - unregisterAuraConverter(converter: IAuraConverter): void; + unregisterAuraConverter(converter: IAuraConverter): void; /** * 设置光环转换器的启用状态 @@ -494,7 +509,7 @@ export interface IEnemyContext { * @param enabled 是否启用 */ setAuraConverterEnabled( - converter: IAuraConverter, + converter: IAuraConverter, enabled: boolean ): void; @@ -503,7 +518,7 @@ export interface IEnemyContext { * @param effect 特殊属性查询效果 */ registerSpecialQueryEffect( - effect: IEnemySpecialQueryEffect + effect: IEnemySpecialQueryEffect ): void; /** @@ -511,7 +526,7 @@ export interface IEnemyContext { * @param effect 特殊属性查询效果 */ unregisterSpecialQueryEffect( - effect: IEnemySpecialQueryEffect + effect: IEnemySpecialQueryEffect ): void; /** @@ -521,7 +536,7 @@ export interface IEnemyContext { */ registerCommonQueryEffect( code: number, - effect: IEnemyCommonQueryEffect + effect: IEnemyCommonQueryEffect ): void; /** @@ -531,20 +546,20 @@ export interface IEnemyContext { */ unregisterCommonQueryEffect( code: number, - effect: IEnemyCommonQueryEffect + effect: IEnemyCommonQueryEffect ): void; /** * 注册一个最终效果 * @param effect 最终效果 */ - registerFinalEffect(effect: IEnemyFinalEffect): void; + registerFinalEffect(effect: IEnemyFinalEffect): void; /** * 注销一个最终效果 * @param effect 最终效果 */ - unregisterFinalEffect(effect: IEnemyFinalEffect): void; + unregisterFinalEffect(effect: IEnemyFinalEffect): void; /** * 绑定勇士对象 @@ -561,41 +576,41 @@ export interface IEnemyContext { * 获取指定怪物对象当前所在位置 * @param enemy 怪物对象 */ - getEnemyLocator(enemy: IEnemy): Readonly | null; + getEnemyLocator(enemy: IEnemy): Readonly | null; /** * 获取指定怪物视图当前所在位置 * @param view 怪物视图 */ getEnemyLocatorByView( - view: IEnemyView + view: IEnemyView ): Readonly | null; /** * 根据定位符获取怪物视图 * @param locator 地图定位符 */ - getEnemyByLocator(locator: ITileLocator): IEnemyView | null; + getEnemyByLocator(locator: ITileLocator): IEnemyView | null; /** * 根据坐标获取怪物视图 * @param x 横坐标 * @param y 纵坐标 */ - getEnemyByLoc(x: number, y: number): IEnemyView | null; + getEnemyByLoc(x: number, y: number): IEnemyView | null; /** * 根据计算后怪物对象反查怪物视图 * @param enemy 计算后怪物对象 */ - getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; + getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; /** * 在指定位置放置一个怪物对象 * @param locator 地图定位符 * @param enemy 怪物对象 */ - setEnemyAt(locator: ITileLocator, enemy: IEnemy): void; + setEnemyAt(locator: ITileLocator, enemy: IEnemy): void; /** * 删除指定位置的怪物 @@ -611,46 +626,46 @@ export interface IEnemyContext { scanRange( range: IRange, param: T - ): Iterable<[ITileLocator, IEnemyView]>; + ): Iterable<[ITileLocator, IEnemyView]>; /** * 迭代上下文中的全部怪物 */ - iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; + iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; /** * 添加一个全局光环视图 * @param aura 光环视图 */ - addAura(aura: IAuraView): void; + addAura(aura: IAuraView): void; /** * 删除一个全局光环视图 * @param aura 光环视图 */ - deleteAura(aura: IAuraView): void; + deleteAura(aura: IAuraView): void; /** * 绑定地图伤害管理器 * @param damage 地图伤害管理器 */ - attachMapDamage(damage: IMapDamage | null): void; + attachMapDamage(damage: IMapDamage | null): void; /** * 获取当前绑定的地图伤害管理器 */ - getMapDamage(): IMapDamage | null; + getMapDamage(): IMapDamage | null; /** * 绑定伤害计算系统 * @param system 伤害系统 */ - attachDamageSystem(system: IDamageSystem | null): void; + attachDamageSystem(system: IDamageSystem | null): void; /** * 获取当前绑定的伤害计算系统 */ - getDamageSystem(): IDamageSystem | null; + getDamageSystem(): IDamageSystem | null; /** * 重建当前上下文中的全部怪物计算结果 @@ -666,13 +681,13 @@ export interface IEnemyContext { * 将指定怪物视图标记为脏 * @param view 怪物视图 */ - markDirty(view: IEnemyView): void; + markDirty(view: IEnemyView): void; /** * 申请刷新指定怪物视图 * @param view 怪物视图 */ - requestRefresh(view: IEnemyView): void; + requestRefresh(view: IEnemyView): void; /** * 清空当前上下文中的所有对象与运行状态 diff --git a/packages-user/data-base/src/enemy/enemy.ts b/packages-user/data-base/src/enemy/enemy.ts index 36a0fd0..369ae39 100644 --- a/packages-user/data-base/src/enemy/enemy.ts +++ b/packages-user/data-base/src/enemy/enemy.ts @@ -1,6 +1,6 @@ import { logger } from '@motajs/common'; +import { SaveCompression } from '../common'; import { IEnemy, IEnemySaveState, IReadonlyEnemy, ISpecial } from './types'; -import { SaveCompression } from '../common/types'; export class Enemy implements IEnemy { /** 怪物身上的特殊属性列表 */ diff --git a/packages-user/data-base/src/enemy/special.ts b/packages-user/data-base/src/enemy/special.ts index 59c1083..6f53661 100644 --- a/packages-user/data-base/src/enemy/special.ts +++ b/packages-user/data-base/src/enemy/special.ts @@ -1,5 +1,5 @@ import { isEqual } from 'lodash-es'; -import { SaveCompression } from '../common/types'; +import { SaveCompression } from '../common'; import { ISpecial, SpecialCreation } from './types'; // TODO: 颜色参数 diff --git a/packages-user/data-base/src/enemy/types.ts b/packages-user/data-base/src/enemy/types.ts index 94251ad..61d6ba8 100644 --- a/packages-user/data-base/src/enemy/types.ts +++ b/packages-user/data-base/src/enemy/types.ts @@ -1,4 +1,4 @@ -import { ISaveableContent } from '../common/types'; +import { ISaveableContent } from '../common'; //#region 怪物基础 From 93b534924858fb49353fcaf8c1da595a254dddd0 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Tue, 12 May 2026 19:59:10 +0800 Subject: [PATCH 13/26] =?UTF-8?q?refactor:=20=E6=BF=80=E5=85=89=E5=9C=B0?= =?UTF-8?q?=E5=9B=BE=E4=BC=A4=E5=AE=B3=E6=8D=A2=E7=94=A8=E6=96=B0=20IFaceM?= =?UTF-8?q?anager=20=E6=8E=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/data-base/src/combat/types.ts | 2 +- packages-user/data-base/src/common/mover.ts | 39 +++++-------------- .../data-state/src/enemy/mapDamage.ts | 24 ++++++------ 3 files changed, 24 insertions(+), 41 deletions(-) diff --git a/packages-user/data-base/src/combat/types.ts b/packages-user/data-base/src/combat/types.ts index 6f6b584..28d84cc 100644 --- a/packages-user/data-base/src/combat/types.ts +++ b/packages-user/data-base/src/combat/types.ts @@ -245,7 +245,7 @@ export interface IMapDamageView { getDamageAt(locator: ITileLocator): Readonly | null; /** - * 获取指定位置的地图伤害,会对坐标进行判断 + * 获取指定位置的地图伤害,不会对坐标进行判断 * @param locator 伤害位置 */ getDamageWithoutCheck( diff --git a/packages-user/data-base/src/common/mover.ts b/packages-user/data-base/src/common/mover.ts index f6eb757..eeba89d 100644 --- a/packages-user/data-base/src/common/mover.ts +++ b/packages-user/data-base/src/common/mover.ts @@ -7,6 +7,7 @@ import { ITileLocator } from '@motajs/common'; import { FaceDirection } from './types'; +import { IFaceHandler } from './faceManager'; //#region 对象移动 @@ -278,6 +279,14 @@ export abstract class ObjectMover /** 是否调用了 `IMoverController.stop` 接口 */ private shouldStop: boolean = false; + /** 朝向处理 */ + private readonly faceHandler: IFaceHandler; + + constructor(faceHandler: IFaceHandler) { + super(); + this.faceHandler = faceHandler; + } + protected createController( hook: Partial> ): IHookController> { @@ -349,34 +358,6 @@ export abstract class ObjectMover } } - // TODO: 需要做一个朝向系统以解决朝向难以处理的问题 - /** - * 获取指定方向的反方向 - * @param dir 当前方向 - */ - private getOppositeDirection(dir: FaceDirection): FaceDirection { - switch (dir) { - case FaceDirection.Left: - return FaceDirection.Right; - case FaceDirection.Up: - return FaceDirection.Down; - case FaceDirection.Right: - return FaceDirection.Left; - case FaceDirection.Down: - return FaceDirection.Up; - case FaceDirection.LeftUp: - return FaceDirection.RightDown; - case FaceDirection.RightUp: - return FaceDirection.LeftDown; - case FaceDirection.LeftDown: - return FaceDirection.RightUp; - case FaceDirection.RightDown: - return FaceDirection.LeftUp; - case FaceDirection.Unknown: - return FaceDirection.Unknown; - } - } - /** * 根据步骤内容预先同步移动器内部状态 * @param step 当前步骤 @@ -397,7 +378,7 @@ export abstract class ObjectMover case ObjectMoveStepType.Special: { const dir = this.getCurrentDirection(); if (step.direction === ObjectSpecialStep.Backward) { - const opposite = this.getOppositeDirection(dir); + const opposite = this.faceHandler.opposite(dir); this.moveDirection = opposite; this.faceDirection = opposite; } else { diff --git a/packages-user/data-state/src/enemy/mapDamage.ts b/packages-user/data-state/src/enemy/mapDamage.ts index 26bea1e..bea8256 100644 --- a/packages-user/data-state/src/enemy/mapDamage.ts +++ b/packages-user/data-state/src/enemy/mapDamage.ts @@ -1,7 +1,4 @@ import { - DirectionMapper, - IDirectionDescriptor, - InternalDirectionGroup, IManhattanRangeParam, IRange, IRayRangeParam, @@ -9,7 +6,8 @@ import { ManhattanRange, RayRange, RectRange, - ITileLocator + ITileLocator, + IDirectionDescriptor } from '@motajs/common'; import { IEnemyContext, @@ -21,7 +19,9 @@ import { ISpecial, IMapDamageView, IReadonlyHeroAttribute, - IReadonlyEnemy + IReadonlyEnemy, + IFaceHandler, + InternalFaceGroup } from '@user/data-base'; import { IZoneValue } from './special'; import { IEnemyAttr, MapDamageType } from './types'; @@ -31,9 +31,6 @@ const RECT_RANGE = new RectRange(); const MANHATTAN_RANGE = new ManhattanRange(); const RAY_RANGE = new RayRange(); -const DIRECTION_MAPPER = new DirectionMapper(); -const DIR4 = [...DIRECTION_MAPPER.map(InternalDirectionGroup.Dir4)]; - //#region 地图伤害 abstract class BaseMapDamageView implements IMapDamageView { @@ -154,13 +151,17 @@ export class RepulseDamageView extends BaseMapDamageView { } export class LaserDamageView extends BaseMapDamageView { + /** 激光方向列表 */ + private readonly dirs: IDirectionDescriptor[]; + constructor( context: IEnemyContext, private readonly locator: Readonly, private readonly special: Readonly>, - private readonly dir: IDirectionDescriptor[] = DIR4 + dir: IFaceHandler ) { super(context); + this.dirs = [...dir.mapMovement()].map(v => v[1]); } getRange(): IRange { @@ -171,7 +172,7 @@ export class LaserDamageView extends BaseMapDamageView { return { cx: this.locator.x, cy: this.locator.y, - dir: this.dir + dir: this.dirs }; } @@ -309,7 +310,8 @@ export class MainMapDamageConverter implements IMapDamageConverter< const laser = enemy.getSpecial(24); if (laser) { - views.push(new LaserDamageView(context, locator, laser)); + const face = handler.data.faceManager.get(InternalFaceGroup.Dir4)!; + views.push(new LaserDamageView(context, locator, laser, face)); } if (enemy.hasSpecial(27)) { From 80b73938b4790771f9f28a2af82db4e4f90ec406 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Wed, 13 May 2026 21:04:14 +0800 Subject: [PATCH 14/26] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=20AI=20Agent?= =?UTF-8?q?=20=E6=8F=90=E7=A4=BA=E8=AF=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 6 ++++-- prompt.md | 13 +++++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/dev.md b/dev.md index de5e670..ac11cd8 100644 --- a/dev.md +++ b/dev.md @@ -52,6 +52,8 @@ | 专有名词缩写(如 `HTTP`、`URI`) | 全大写 | | 需被 `implements` 的接口 | 大写 `I` 开头 | | HTML/CSS 中的 `id`、`class` 等 | 连字符命名法 | +| 代码文件名 | 小驼峰 | +| Markdown 文档文件名 | 连字符命名法 | 不使用下划线命名法。 @@ -63,7 +65,7 @@ - 长文件可使用 `#region` / `#endregion` 分段以支持折叠。 - TODO 使用 `// TODO:` 或 `// todo:` 格式。 - 单行注释的 `//` 与注释内容之间留一个空格;不允许出现非 jsDoc 的多行注释,如需多行注释,使用多个单行注释代替。 -- 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不允许在句中换行;参数注释换行后保持对齐。 +- 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不要频繁换行,每行长度应差不多,不允许在句中换行;参数注释换行后保持对齐。 - 单行注释结尾不加句号;较长的多行注释结尾可加句号。 - 一般不建议给接口(`inteface` 本身)、类型别名或类本身写注释(不好看),特殊情况除外。 @@ -74,7 +76,7 @@ - 无法避免类型错误时,使用 `// @ts-expect-error` 标记并说明原因。 - 未使用的变量或方法以下划线开头命名。 - 合理使用 `readonly`、`protected`、`private` 关键字。 -- 可选参数过多时,考虑改用对象参数。 +- 可选参数过多时(大于两个),考虑改用对象参数。 - 尽量避免 `as` 类型断言,除非必要。 ### 其他要求 diff --git a/prompt.md b/prompt.md index f0bd64b..240cbfe 100644 --- a/prompt.md +++ b/prompt.md @@ -2,7 +2,7 @@ 以下规则必须时刻遵守,任何情况下都不允许违反。 -1. **不擅自修改已有代码**:将我已经写好的代码视为绝对正确。除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。若认为我的代码存在逻辑错误,应在对话中提出,而不是直接修改,不要做任何“顺手”的事。 +1. **不擅自修改已有代码**:将我已经写好的代码视为绝对正确。除非我**明确允许**,否则**不允许任何修改**,哪怕因为接口变化或其他原因导致其中出现类型错误。若认为我的代码存在错误,应在对话中提出,而不是直接修改。 2. **不恢复我的修改**:我做的任何代码修改都是有原因的。若我在两次对话期间新增、删除或修改了部分代码,不要将其恢复。 3. **以目的驱动,而非以接口驱动**:实现前先想清楚我为什么要这样设计接口、这个接口设计的目的是什么,而不是单纯地以将接口填满为目标。 4. **遇到歧义立即提问**:若思考或实现时遇到任何问题——例如描述模糊、接口不清晰、某些地方存在歧义等——应立即向我提问,而不是按自己的想法去写。 @@ -10,6 +10,7 @@ 6. **按我说的方式重构**:若目标是重构某个接口,按照我指定的方式执行: - **彻底性重构**(新旧接口完全没有重合):按正常方式全新实现,旧代码仅作逻辑与思路上的参考。 - **结构性重构**(新旧接口基本一致,细节有差距):将旧代码搬移到新接口上后进行微调。**不要**擅自新增任何参数、方法或接口,**不要**仅通过新增兼容层的方式应对重构。 +7. **不要有任何“顺手”的想法**:任何时候,都不要出现顺手的想法,包括但不限于发现了一个 bug,然后**顺手**修复、发现一处类型错误,然后**顺手**修复等,这种情况下应当遵循规则 1。 # 建议规则 @@ -32,7 +33,7 @@ ## 示例文档 -大致按照以下格式编写,如某部分需要详细描述,可单独开设标题;若某个接口内容较多,也可以在文档中为其单独开一个章节进行讲述。我会使用引用块的形式在文档中提出建议或回答。Markdown 文档不需要刻意换行,我的编辑器有自动换行功能,正常写没有问题。 +对于新增接口/彻底性地重构接口,大致按照以下格式编写,其余需求按照自己的理解去写即可。如某部分需要详细描述,可单独开设标题;若某个接口内容较多,也可以在文档中为其单独开一个章节进行讲述。我会使用引用块的形式在文档中提出建议或回答。Markdown 文档不需要刻意换行,我的编辑器有自动换行功能,正常写没有问题。 ```md # 需求综述 @@ -41,7 +42,7 @@ # 实现思路 -按照下面的格式分条描述实现思路,可以创建为 `todo list`。 +按照下面的格式分条描述实现思路。 ## 1. 完成 xxx @@ -51,6 +52,10 @@ ... +# 接口预期 + +这里列出每个接口,然后分析它们的预期使用频率(高中低),对于中频率和高频率,列出至少一个可能的使用场景。需要注意,使用频率越高,其接口名长度理应越短,对于高频接口,应该尽量不超过两个单词,以一个单词为宜;对于中频接口,应该尽量不超过三个单词;低频接口长度可以长一些,但不宜过长。 + # 涉及文件 ## 需要引用的文件 @@ -82,7 +87,7 @@ # 问题 -如果描述中有歧义或比较模糊的地方,可以在此列出,或者直接向我提问。 +如果描述中有歧义或比较模糊的地方,可以在此列出。 1. xxxxxx? 2. xxxxxx? From 9ada0796b3192abda57b0a4fd750b802c94cee90 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sat, 16 May 2026 17:06:18 +0800 Subject: [PATCH 15/26] =?UTF-8?q?refactor:=20Layer2=20=E6=95=B0=E6=8D=AE?= =?UTF-8?q?=E6=8B=86=E5=88=86=E8=87=B3=20data-system?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 39 ++++-- packages-user/data-base/src/common/index.ts | 1 + packages-user/data-base/src/index.ts | 1 - packages-user/data-state/package.json | 1 + packages-user/data-state/src/enemy/aura.ts | 7 +- .../data-state/src/enemy/calculator.ts | 5 +- packages-user/data-state/src/enemy/final.ts | 2 +- .../data-state/src/enemy/mapDamage.ts | 6 +- packages-user/data-state/src/enemy/types.ts | 2 +- packages-user/data-system/package.json | 7 ++ .../src/combat/context.ts | 13 +- .../src/combat/damage.ts | 9 +- .../src/combat/enemy.ts | 2 +- .../src/combat/index.ts | 0 .../src/combat/mapDamage.ts | 3 +- .../src/combat/types.ts | 13 +- packages-user/data-system/src/index.ts | 1 + packages-user/data-utils/src/utils.ts | 111 +----------------- pnpm-lock.yaml | 20 ++-- prompt.md | 22 +++- 20 files changed, 110 insertions(+), 155 deletions(-) create mode 100644 packages-user/data-system/package.json rename packages-user/{data-base => data-system}/src/combat/context.ts (99%) rename packages-user/{data-base => data-system}/src/combat/damage.ts (98%) rename packages-user/{data-base => data-system}/src/combat/enemy.ts (94%) rename packages-user/{data-base => data-system}/src/combat/index.ts (100%) rename packages-user/{data-base => data-system}/src/combat/mapDamage.ts (99%) rename packages-user/{data-base => data-system}/src/combat/types.ts (98%) create mode 100644 packages-user/data-system/src/index.ts diff --git a/dev.md b/dev.md index ac11cd8..25f8975 100644 --- a/dev.md +++ b/dev.md @@ -33,6 +33,13 @@ | `pnpm type` | 对仓库执行类型检查 | | `pnpm check:circular` | 对仓库执行循环引用检查 | +## 术语统一 + +- 方法:一般指挂载到接口 `interface` 或类 `class` 上的函数。 +- 函数:一般指在文件顶层定义的函数,有时也会指方法,需要根据语境判断。 +- 接口:有时指 `interface`,有时也会指方法、成员等内容,需要根据语境判断。 +- 成员/属性:一般指接口 `interface`、类 `class`、对象 `object` 上的字段。 + ## 开发原则 ### 模块原则 @@ -97,11 +104,29 @@ - **数据端**:可在 `node` 环境中单独运行,可直接用于录像验证,不负责任何渲染逻辑。 - **渲染端**:仅负责向数据端发送消息,不负责任何逻辑运算。 -| 包 | 层级 | 说明 | -| ---------------------- | ------------ | ------------------------------------ | -| `@user/data-base` | 数据端系统层 | 负责数据端核心系统 | -| `@user/data-state` | 数据端实现层 | 依赖系统层实现完整的游戏实例 | -| `@user/client-base` | 渲染端系统层 | 负责渲染端核心系统 | -| `@user/client-modules` | 渲染端实现层 | 依赖系统层实现客户端的渲染与用户交互 | - 数据端允许调用渲染端代码,但必须使用全局接口 `Mota.r(() => {})` 包裹。除非必要,否则不建议在数据端调用渲染端代码。 + +### 渲染端 + +渲染端目前已基本制作完成,分为两层: + +| 包 | 层级 | 说明 | +| ---------------------- | ------ | ------------------------------------ | +| `@user/client-base` | 系统层 | 负责渲染端核心系统 | +| `@user/client-modules` | 实现层 | 依赖系统层实现客户端的渲染与用户交互 | + +### 数据端 + +数据端目前正在从旧引擎进行彻底性重构,分为三层: + +**Layer 0 — 公共层**:包含公共接口、工具函数等内容,不依赖任何外部游戏逻辑,可被任意高层直接引用。内容较少,与 Layer 1 共同放在 `@user/data-base` 中,不单独开包。 + +**Layer 1 — 数据层**:包含所有会影响游戏存档与流程的数据内容,如地图、怪物、玩家属性等。本层通过统一接口 `IStateBase` 对外暴露数据访问能力,各类数据模块均以此接口为核心组织。 + +**Layer 2 — 执行层**:直接引用 Layer 1,负责产生影响游戏进程的动作,如玩家控制、战斗计算等。本层内容不会进入存档,仅通过修改 Layer 1 的数据来影响游戏状态,并通过统一接口 `ICoreState` 对外暴露执行能力。 + +| 包 | 层级 | 说明 | +| ------------------- | ----------------- | ------------------------------------------------------------------------------- | +| `@user/data-base` | Layer 0 / Layer 1 | 公共层与数据层,定义 `IStateBase` 及各类游戏数据(地图、怪物、玩家属性等) | +| `@user/data-state` | — | 数据端的顶层模块,指导 Layer 2 的执行行为,不直接参与执行 | +| `@user/data-system` | Layer 2 | 执行层,定义 `ICoreState`,依赖数据层实现玩家控制、战斗计算等影响游戏进程的动作 | diff --git a/packages-user/data-base/src/common/index.ts b/packages-user/data-base/src/common/index.ts index c528977..f989da9 100644 --- a/packages-user/data-base/src/common/index.ts +++ b/packages-user/data-base/src/common/index.ts @@ -1,5 +1,6 @@ export * from './face'; export * from './faceManager'; +export * from './indexer'; export * from './mover'; export * from './types'; export * from './utils'; diff --git a/packages-user/data-base/src/index.ts b/packages-user/data-base/src/index.ts index f71b3b5..0be7276 100644 --- a/packages-user/data-base/src/index.ts +++ b/packages-user/data-base/src/index.ts @@ -1,4 +1,3 @@ -export * from './combat'; export * from './common'; export * from './enemy'; export * from './flag'; diff --git a/packages-user/data-state/package.json b/packages-user/data-state/package.json index 0ff5c79..eca262b 100644 --- a/packages-user/data-state/package.json +++ b/packages-user/data-state/package.json @@ -4,6 +4,7 @@ "@motajs/types": "workspace:*", "@motajs/common": "workspace:*", "@user/data-base": "workspace:*", + "@user/data-system": "workspace:*", "@user/data-utils": "workspace:*" } } diff --git a/packages-user/data-state/src/enemy/aura.ts b/packages-user/data-state/src/enemy/aura.ts index 1220ba0..eae1149 100644 --- a/packages-user/data-state/src/enemy/aura.ts +++ b/packages-user/data-state/src/enemy/aura.ts @@ -14,10 +14,9 @@ import { IEnemyContext, IEnemySpecialModifier, IEnemyView, - IReadonlyEnemyHandler, - IReadonlyEnemy, - ISpecial -} from '@user/data-base'; + IReadonlyEnemyHandler +} from '@user/data-system'; +import { IReadonlyEnemy, ISpecial } from '@user/data-base'; import { IHaloValue } from './special'; import { IEnemyAttr } from './types'; import { IHeroAttr } from '../hero'; diff --git a/packages-user/data-state/src/enemy/calculator.ts b/packages-user/data-state/src/enemy/calculator.ts index 4831ba6..3d67f08 100644 --- a/packages-user/data-state/src/enemy/calculator.ts +++ b/packages-user/data-state/src/enemy/calculator.ts @@ -3,7 +3,7 @@ import { IDamageCalculator, IEnemyDamageInfo, IReadonlyEnemyHandler -} from '@user/data-base'; +} from '@user/data-system'; import { IEnemyAttr } from './types'; import { IVampireValue } from './special'; import { IHeroAttr } from '../hero'; @@ -90,7 +90,8 @@ export class MainDamageCalculator implements IDamageCalculator< const extraInfo = this.calculate({ enemy: guard.getComputedEnemy(), locator, - hero + hero, + data: handler.data }); turn += extraInfo.turn; damage += extraInfo.damage; diff --git a/packages-user/data-state/src/enemy/final.ts b/packages-user/data-state/src/enemy/final.ts index 0c722e7..dbd3e01 100644 --- a/packages-user/data-state/src/enemy/final.ts +++ b/packages-user/data-state/src/enemy/final.ts @@ -1,4 +1,4 @@ -import { IEnemyFinalEffect, IEnemyHandler } from '@user/data-base'; +import { IEnemyFinalEffect, IEnemyHandler } from '@user/data-system'; import { IEnemyAttr } from './types'; import { IHeroAttr } from '../hero'; diff --git a/packages-user/data-state/src/enemy/mapDamage.ts b/packages-user/data-state/src/enemy/mapDamage.ts index bea8256..6bff8e7 100644 --- a/packages-user/data-state/src/enemy/mapDamage.ts +++ b/packages-user/data-state/src/enemy/mapDamage.ts @@ -16,11 +16,13 @@ import { IMapDamageInfoExtra, IMapDamageReducer, IReadonlyEnemyHandler, + IMapDamageView +} from '@user/data-system'; +import { + IFaceHandler, ISpecial, - IMapDamageView, IReadonlyHeroAttribute, IReadonlyEnemy, - IFaceHandler, InternalFaceGroup } from '@user/data-base'; import { IZoneValue } from './special'; diff --git a/packages-user/data-state/src/enemy/types.ts b/packages-user/data-state/src/enemy/types.ts index e008ebe..59a2d32 100644 --- a/packages-user/data-state/src/enemy/types.ts +++ b/packages-user/data-state/src/enemy/types.ts @@ -1,4 +1,4 @@ -import { IEnemyView } from '@user/data-base'; +import { IEnemyView } from '@user/data-system'; export interface IEnemyAttr { /** 怪物生命值 */ diff --git a/packages-user/data-system/package.json b/packages-user/data-system/package.json new file mode 100644 index 0000000..be999dd --- /dev/null +++ b/packages-user/data-system/package.json @@ -0,0 +1,7 @@ +{ + "name": "@user/data-system", + "dependencies": { + "@motajs/common": "workspace:*", + "@user/data-base": "workspace:*" + } +} diff --git a/packages-user/data-base/src/combat/context.ts b/packages-user/data-system/src/combat/context.ts similarity index 99% rename from packages-user/data-base/src/combat/context.ts rename to packages-user/data-system/src/combat/context.ts index 2a6287f..ca7e8db 100644 --- a/packages-user/data-base/src/combat/context.ts +++ b/packages-user/data-system/src/combat/context.ts @@ -14,11 +14,16 @@ import { IMapDamage, IReadonlyEnemyHandler } from './types'; -import { IReadonlyHeroAttribute } from '../hero'; -import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; +import { + IReadonlyHeroAttribute, + IEnemy, + IReadonlyEnemy, + ISpecial, + IStateBase, + ILocationIndexer, + MapLocIndexer +} from '@user/data-base'; import { EnemyView } from './enemy'; -import { ILocationIndexer, MapLocIndexer } from '../common/indexer'; -import { IStateBase } from '../types'; export class EnemyContext implements IEnemyContext< TEnemy, diff --git a/packages-user/data-base/src/combat/damage.ts b/packages-user/data-system/src/combat/damage.ts similarity index 98% rename from packages-user/data-base/src/combat/damage.ts rename to packages-user/data-system/src/combat/damage.ts index ce70711..2b83a7e 100644 --- a/packages-user/data-base/src/combat/damage.ts +++ b/packages-user/data-system/src/combat/damage.ts @@ -11,9 +11,12 @@ import { IReadonlyEnemyHandler, IEnemyView } from './types'; -import { IHeroAttribute, IReadonlyHeroAttribute } from '../hero'; -import { IReadonlyEnemy } from '../enemy'; -import { IStateBase } from '../types'; +import { + IHeroAttribute, + IReadonlyHeroAttribute, + IReadonlyEnemy, + IStateBase +} from '@user/data-base'; interface ICriticalSearchResult { /** 此临界点的属性值 */ diff --git a/packages-user/data-base/src/combat/enemy.ts b/packages-user/data-system/src/combat/enemy.ts similarity index 94% rename from packages-user/data-base/src/combat/enemy.ts rename to packages-user/data-system/src/combat/enemy.ts index 94a8a60..b28cc53 100644 --- a/packages-user/data-base/src/combat/enemy.ts +++ b/packages-user/data-system/src/combat/enemy.ts @@ -1,4 +1,4 @@ -import { IEnemy, IReadonlyEnemy } from '../enemy'; +import { IEnemy, IReadonlyEnemy } from '@user/data-base'; import { IEnemyView, IEnemyContext } from './types'; export class EnemyView implements IEnemyView { diff --git a/packages-user/data-base/src/combat/index.ts b/packages-user/data-system/src/combat/index.ts similarity index 100% rename from packages-user/data-base/src/combat/index.ts rename to packages-user/data-system/src/combat/index.ts diff --git a/packages-user/data-base/src/combat/mapDamage.ts b/packages-user/data-system/src/combat/mapDamage.ts similarity index 99% rename from packages-user/data-base/src/combat/mapDamage.ts rename to packages-user/data-system/src/combat/mapDamage.ts index 2fd36e3..200fa3b 100644 --- a/packages-user/data-base/src/combat/mapDamage.ts +++ b/packages-user/data-system/src/combat/mapDamage.ts @@ -9,8 +9,7 @@ import { IMapDamageReducer, IMapDamageView } from './types'; -import { ILocationHelper } from '../common/indexer'; -import { IStateBase } from '../types'; +import { ILocationHelper, IStateBase } from '@user/data-base'; interface IPointInfo { /** 该点所有的地图伤害 */ diff --git a/packages-user/data-base/src/combat/types.ts b/packages-user/data-system/src/combat/types.ts similarity index 98% rename from packages-user/data-base/src/combat/types.ts rename to packages-user/data-system/src/combat/types.ts index 28d84cc..cc6ab59 100644 --- a/packages-user/data-base/src/combat/types.ts +++ b/packages-user/data-system/src/combat/types.ts @@ -1,8 +1,13 @@ import { ITileLocator, IRange } from '@motajs/common'; -import { IEnemy, IReadonlyEnemy, ISpecial } from '../enemy'; -import { IReadonlyHeroAttribute, IHeroAttribute } from '../hero'; -import { ILocationHelper } from '../common/indexer'; -import { IStateBase } from '../types'; +import { + IEnemy, + IReadonlyEnemy, + ISpecial, + IReadonlyHeroAttribute, + IHeroAttribute, + IStateBase, + ILocationHelper +} from '@user/data-base'; //#region 辅助接口 diff --git a/packages-user/data-system/src/index.ts b/packages-user/data-system/src/index.ts new file mode 100644 index 0000000..7fd3ec0 --- /dev/null +++ b/packages-user/data-system/src/index.ts @@ -0,0 +1 @@ +export * from './combat'; diff --git a/packages-user/data-utils/src/utils.ts b/packages-user/data-utils/src/utils.ts index 8102333..1e1df0d 100644 --- a/packages-user/data-utils/src/utils.ts +++ b/packages-user/data-utils/src/utils.ts @@ -1,22 +1,3 @@ -/** - * 滑动数组 - * @param arr - * @param delta - */ -export function slide(arr: T[], delta: number): T[] { - if (delta === 0) return arr; - delta %= arr.length; - if (delta > 0) { - arr.unshift(...arr.splice(arr.length - delta, delta)); - return arr; - } - if (delta < 0) { - arr.push(...arr.splice(0, -delta)); - return arr; - } - return arr; -} - const backDirMap: Record = { up: 'down', down: 'up', @@ -38,23 +19,8 @@ export function has(v: T): v is NonNullable { return v !== null && v !== void 0; } -export function maxGameScale(n: number = 0) { - const index = core.domStyle.availableScale.indexOf(core.domStyle.scale); - core.control.setDisplayScale( - core.domStyle.availableScale.length - 1 - index - n - ); - if (!core.isPlaying() && core.flags.enableHDCanvas) { - // @ts-ignore - core.domStyle.ratio = Math.max( - window.devicePixelRatio || 1, - core.domStyle.scale - ); - core.resize(); - } -} - export function ensureArray(arr: T): T extends any[] ? T : T[] { - // @ts-ignore + // @ts-expect-error 需要弃用 return arr instanceof Array ? arr : [arr]; } @@ -70,23 +36,6 @@ export function manhattan(x1: number, y1: number, x2: number, y2: number) { return Math.abs(x1 - x2) + Math.abs(y1 - y2); } -/** - * 检查一个点是否在当前超大地图 v2 优化范围内 - */ -export function checkV2(x?: number, y?: number) { - return ( - has(x) && - has(y) && - !( - core.bigmap.v2 && - (x < core.bigmap.posX - core.bigmap.extend || - x > core.bigmap.posX + core._WIDTH_ + core.bigmap.extend || - y < core.bigmap.posY - core.bigmap.extend || - y > core.bigmap.posY + core._HEIGHT_ + core.bigmap.extend) - ) - ); -} - export function formatDamage(damage: number): DamageString { let dam = ''; let color = ''; @@ -105,64 +54,6 @@ export function formatDamage(damage: number): DamageString { return { damage: dam, color: color as Color }; } -/** - * 判断一个数组的数值是否全部相等 - * @param arr 要判断的数组 - */ -export function equal(arr: number[]): boolean; -/** - * 判断一个数组的元素的某个属性的数值是否全部相等 - * @param arr 要判断的数组 - * @param key 要判断的属性名 - */ -export function equal(arr: T[], key: keyof T): boolean; -export function equal(arr: any, key?: any) { - if (has(key)) { - for (let i = 1; i < arr.length; i++) { - if (arr[i][key] !== arr[0][key]) return false; - } - return true; - } else { - for (let i = 1; i < arr.length; i++) { - if (arr[i] !== arr[0]) return false; - } - return true; - } -} - -/** - * 获得一个数组的数值的最大值和最小值 - * @param arr 要获得的数组 - */ -export function boundary(arr: number[]): [number, number]; -/** - * 获得一个数组的元素的某个属性的数值的最大值和最小值 - * @param arr 要获得的数组 - * @param key 要获得的属性名 - */ -export function boundary(arr: T[], key: keyof T): [number, number]; -export function boundary(arr: any, key?: any) { - if (has(key)) { - let min = arr[0][key]; - let max = arr[0][key]; - for (let i = 1; i < arr.length; i++) { - const ele = arr[i][key]; - if (ele < min) min = ele; - if (ele > max) max = ele; - } - return [min, max]; - } else { - let min = arr[0]; - let max = arr[0]; - for (let i = 1; i < arr.length; i++) { - const ele = arr[i]; - if (ele < min) min = ele; - if (ele > max) max = ele; - } - return [min, max]; - } -} - /** * 获取两个坐标的相对方向 * @param from 初始坐标 diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1bb304c..16fe420 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -315,10 +315,22 @@ importers: '@user/data-base': specifier: workspace:* version: link:../data-base + '@user/data-system': + specifier: workspace:* + version: link:../data-system '@user/data-utils': specifier: workspace:* version: link:../data-utils + packages-user/data-system: + dependencies: + '@motajs/common': + specifier: workspace:* + version: link:../../packages/common + '@user/data-base': + specifier: workspace:* + version: link:../data-base + packages-user/data-utils: dependencies: '@user/data-base': @@ -409,8 +421,6 @@ importers: specifier: workspace:* version: link:../data-utils - packages-user/types: {} - packages/animate: {} packages/audio: @@ -447,12 +457,6 @@ importers: specifier: workspace:* version: link:../common - packages/legacy-data: - dependencies: - '@motajs/common': - specifier: workspace:* - version: link:../common - packages/legacy-system: dependencies: '@motajs/system': diff --git a/prompt.md b/prompt.md index 240cbfe..5dd82ae 100644 --- a/prompt.md +++ b/prompt.md @@ -38,7 +38,23 @@ ```md # 需求综述 -描述清楚需求的内容与目的。 +描述清楚需求的内容、动机与目的。 + +# 接口设计与预期 + +这是相当重要的一章。需要按接口逐一列出其方法与成员,分析每个成员和方法的预期使用频率(高 / 中 / 低)并说明判断依据;对于中频和高频成员,还需列出至少一个典型使用场景。 + +**命名长度原则**:频率越高,成员名应越短。高频成员以一个单词为宜,最多不超过两个单词;中频成员不超过三个单词;低频成员可以稍长,但不宜过长。 + +**频率的定义**:此处频率指**用户编写此调用的可能性或频率**,而非运行时的调用频率。例如某成员每秒被调用千次,但整个游戏中只在一处出现过,仍属低频。 + +示例如下: + +## IObjectMover + +- `IObjectMover.forward()`:预期频率**高频**。向前移动一格是地图行走、动画演出等场景的核心需求,在逻辑与演出中都会频繁出现,故为高频。典型使用场景:演出中玩家或 NPC 沿某方向连续移动。 +- `IObjectMover.speed()`:预期频率**中频**。移动中修改移速有一定使用场景,但远不及 `forward`、`step` 等移动接口的频率,通常只在特殊演出或逻辑中出现,故为中频。典型使用场景:NPC 逃离怪物时先定在原地,随后逐渐加速逃跑。 +- `IObjectMover.stepFace()`:预期频率**低频**。移动方向与朝向不同的常见场景(后退)已由 `backward` 覆盖,只有极特殊情况才需要此接口(如角色朝向固定但沿垂直方向平移),相当罕见,故为低频。 # 实现思路 @@ -52,10 +68,6 @@ ... -# 接口预期 - -这里列出每个接口,然后分析它们的预期使用频率(高中低),对于中频率和高频率,列出至少一个可能的使用场景。需要注意,使用频率越高,其接口名长度理应越短,对于高频接口,应该尽量不超过两个单词,以一个单词为宜;对于中频接口,应该尽量不超过三个单词;低频接口长度可以长一些,但不宜过长。 - # 涉及文件 ## 需要引用的文件 From 501a598de0026904ea3a4189e06668d077d0c5ba Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sat, 16 May 2026 23:43:14 +0800 Subject: [PATCH 16/26] =?UTF-8?q?feat:=20=E8=A7=A6=E5=8F=91=E5=99=A8?= =?UTF-8?q?=E7=B3=BB=E7=BB=9F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 3 + docs/dev/map/trigger.md | 103 +++++++++++++ packages-user/data-base/src/map/layerState.ts | 13 +- packages-user/data-base/src/map/types.ts | 8 + packages-user/data-system/src/index.ts | 1 + .../data-system/src/trigger/collection.ts | 57 +++++++ .../data-system/src/trigger/index.ts | 3 + .../data-system/src/trigger/registry.ts | 49 ++++++ .../data-system/src/trigger/types.ts | 139 ++++++++++++++++++ packages/common/src/logger.json | 2 + prompt.md | 1 + 11 files changed, 378 insertions(+), 1 deletion(-) create mode 100644 docs/dev/map/trigger.md create mode 100644 packages-user/data-system/src/trigger/collection.ts create mode 100644 packages-user/data-system/src/trigger/index.ts create mode 100644 packages-user/data-system/src/trigger/registry.ts create mode 100644 packages-user/data-system/src/trigger/types.ts diff --git a/dev.md b/dev.md index 25f8975..45ec7b8 100644 --- a/dev.md +++ b/dev.md @@ -75,6 +75,7 @@ - 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不要频繁换行,每行长度应差不多,不允许在句中换行;参数注释换行后保持对齐。 - 单行注释结尾不加句号;较长的多行注释结尾可加句号。 - 一般不建议给接口(`inteface` 本身)、类型别名或类本身写注释(不好看),特殊情况除外。 +- 对于 jsDoc 注释,方法注释必须使用换行风格;对于成员 jsDoc 注释,除非注释较长需要换行,否则使用不换行的风格。 ### 类型规范 @@ -85,6 +86,7 @@ - 合理使用 `readonly`、`protected`、`private` 关键字。 - 可选参数过多时(大于两个),考虑改用对象参数。 - 尽量避免 `as` 类型断言,除非必要。 +- 函数类型单独开一个 `type` 类型别名,除非函数类型本身较短(小于 20 字符,且不会因为此函数类型导致换行) ### 其他要求 @@ -96,6 +98,7 @@ - 只进行必要的非空判断,非必要时直接使用非空断言 `!`。 - 除非参数要求传入函数等情况,不建议在函数内定义局部函数。 - 语句尽量不换行,除非必要,尤其注意三元运算符与 `private readonly` 类成员。 +- 任何时候都不应该写 `getter` 和 `setter`。 ## 双端分离 diff --git a/docs/dev/map/trigger.md b/docs/dev/map/trigger.md new file mode 100644 index 0000000..9583cc4 --- /dev/null +++ b/docs/dev/map/trigger.md @@ -0,0 +1,103 @@ +# 需求综述 + +当前地图系统已完成图层管理与动态图块的构建,但地图上每个格点可能存在的**事件逻辑**(如战斗、对话、商店等)尚无统一抽象。本需求旨在建立一套触发器系统,将地图事件的注册、收集与触发解耦为三个独立接口层,最终可通过统一的方式触发地图上某一点所有匹配的事件。 + +触发器本身不与地图绑定,可独立于地图存在。由于触发的执行依赖 Layer 2 的上下文(`IStateBase` 等),整个触发器系统均归属 Layer 2(`@user/data-system`),地图在 Layer 1 中只存储可序列化的图块数据,不直接持有 `ITrigger`。 + +--- + +# 接口设计与预期 + +## ITrigger + +- `ITrigger.type`:预期频率**低频**,触发器的类型标识符,以数字表示,用于区分不同种类的触发器(如战斗、对话等);一般仅在实例化时通过构造参数传入一次,运行期基本不读写,故为低频。 +- `ITrigger.priority`:预期频率**低频**,仅在创建触发器时设置一次,用于控制同格点多触发器的执行顺序;绝大多数情况下一个格点只会有一个触发器,多触发器仅为少量拓展场景预留,在 `collect` 场景下,同一次收集中的 `priority` 重复会被视为配置冲突,故为低频。 +- `ITrigger.trigger(handler)`:预期频率**中频**,用户在脚本中有时会直接持有某个触发器引用并手动触发,但大多数事件触发都通过 `ITriggerCollection.trigger` 完成,直接调用此方法的场合相对有限,故为中频。接受 `ITriggerHandler` 上下文对象(必选 `state: IStateBase`,可选 `layer?: ILayerState`、`mapLayer?: IMapLayer`、`locator?: ITileLocator`),返回 `Promise`。典型使用场景:脚本中已持有某个战斗触发器引用,希望直接触发而不经过格点收集流程。 +- `ITrigger.collection()`:预期频率**中频**,当用户希望将单个触发器包装为集合并走统一触发流程时使用,场景较为固定但有一定出现概率,故为中频。典型使用场景:脚本中手动构造只含单个触发器的集合,再调用 `collection.trigger(...)` 统一触发。 + +## ITriggerRegistry + +以触发器**类型**(`type: number`)为核心提供注册与查询;`registerString` / `getString` 是触发器自身 id 的字符串别名,与地图图块绑定无关,不参与 `collect` 的自动收集流程。共四个方法,不拆分为子接口。 + +- `ITriggerRegistry.register(type, factory)`:预期频率**低频**,按触发器类型注册触发器工厂函数(`(type: number) => ITrigger`),由注册表在实例化时将当前 `type` 透传给工厂,使 `ITrigger.type` 跟随注册表,`collect` 时每次调用工厂创建独立实例,一种触发器类型只注册一次,故为低频。 +- `ITriggerRegistry.get(type)`:预期频率**低频**,主要供 `ITriggerCollector` 内部调用,用户代码几乎不会直接使用,故为低频。 +- `ITriggerRegistry.registerString(id, factory)`:预期频率**低频**,为触发器注册字符串别名(`() => ITrigger`),仅用于手动按字符串 id 查询,与地图图块收集无关,故为低频。 +- `ITriggerRegistry.getString(id)`:预期频率**低频**,按字符串 id 查询触发器工厂,调用方手动获取后实例化,主要供内部调用,故为低频。 + +## ITriggerCollection + +- `ITriggerCollection.count`:预期频率**低频**,在"当格点无任何触发器时跳过处理"的场景下可快速判断,避免额外迭代,故为低频。 +- `ITriggerCollection.trigger(handler)`:预期频率**高频**,这是触发器系统对用户暴露的最主要入口,凡是需要触发某格事件的地方都会出现此调用,故为高频。接受 `ITriggerHandler` 上下文对象,顺序异步执行所有触发器,返回 `Promise`。典型使用场景:玩家移动到某格后,移动系统调用 `collection.trigger(handler)` 依次执行该格所有已排序的触发器。 +- `ITriggerCollection.triggerIter(handler)`:预期频率**低频**,返回 `AsyncGenerator`,允许调用方逐个手动推进触发器执行,每次 `next(handler)` 可传入新的上下文(传 `null` 则沿用初始 `handler`),故为低频。典型使用场景:需要在两个触发器之间插入额外效果(如战斗结束后立刻播放特效)的进阶场景。 +- `ITriggerCollection.iterate()`:预期频率**低频**,仅在需要检查当前集合包含哪些触发器时使用(如 UI 显示交互提示),多数情况下直接触发而无需遍历,故为低频。 +- `ITriggerCollection.push(trigger)`:预期频率**低频**,在脚本中偶尔需要向已有集合末尾追加一个触发器(如特殊演出追加额外效果),直接插入末尾不重新排序,故为低频。 +- `ITriggerCollection.unshift(trigger)`:预期频率**低频**,与 `push` 对称,向集合头部强制插入触发器,直接插入头部不重新排序,场景更为罕见,故为低频。 +- `ITriggerCollection.concat(...others)`:预期频率**低频**,将当前集合与一个或多个其他集合按自身在前、传入参数依序在后的顺序合并为新集合,不重新排序。此接口需求存疑,先行提供,故为低频。 + +## ITriggerCollector + +`ITriggerCollector` 独立存在于 Layer 2(`@user/data-system`),不附属于 `ILayerState`。调用方持有 collector 引用,调用 `collect(x, y, layer)` 时显式传入目标图层(`IMapLayer`)。收集时会依赖后续由 `IMapLayer.getTileInfo` 暴露的图块信息,其中包含触发器类型。引擎层会利用 `ILayerState.eventLayer` 自动调用 `collect` 实现默认收集行为,该行为不在本接口设计范围内;若需对多个图层收集,调用方自行多次调用并合并结果,合并顺序、跨层排序结果与跨层冲突处理均由调用方自行决定。 + +- `ITriggerCollector.collect(x, y, layer)`:预期频率**中频**,在移动系统或交互系统中需要确认某格事件时调用,使用场景固定且有一定频率,故为中频。`layer` 为必选,调用方显式指定要收集的目标图层(`IMapLayer`)。典型使用场景:玩家向某格移动时,移动系统持有 collector 引用并调用 `collector.collect(x, y, layer)` 获取目标格的 `ITriggerCollection`,再决定是否阻断移动或直接触发。 +- `ITriggerCollector.attachRegistry(registry)`:预期频率**低频**,仅在初始化或切换注册表时调用,故为低频。 + +--- + +# 实现思路 + +## 1. 触发器对象 ITrigger + +`ITrigger` 代表一类事件逻辑(如"战斗触发器"、"对话触发器"),是整个系统的原子单元。`type` 成员以数字标识触发器种类,在常规注册流程下由注册表在实例化时通过构造参数注入;`priority` 控制同格点的执行顺序,并在 `collect` 场景下充当唯一执行位。触发器本身是极其宽泛的东西,一般只有几种类型,比如战斗、触发系统事件、触发自定义事件等,不会每种战斗和每种对话都开一种触发器。触发时接受外部传入的 `ITriggerHandler` 上下文参数,执行对应逻辑。 + +`ITrigger` 提供 `collection()` 方法,将单个触发器包装为 `ITriggerCollection`,供不需要收集步骤的场景直接使用。 + +## 2. 触发器注册接口 ITriggerRegistry + +触发器以类型为单位注册。为保证每个收集场景下的 `ITrigger` 实例相互独立(触发器可在内部保存状态而不互相影响),注册时传入工厂函数 `(type: number) => ITrigger`,由注册表在创建实例时将当前类型透传给工厂,使实例上的 `ITrigger.type` 跟随注册表;`collect` 时按需调用工厂创建新实例。字符串别名注册仍用于手动查询场景,不参与 `collect` 自动收集。`ITriggerRegistry` 直接包含以下四个方法: + +- `register(type: number, factory: (type: number) => ITrigger)`:按触发器类型注册触发器工厂 +- `get(type: number)`:按触发器类型查询触发器工厂 +- `registerString(id: string, factory: () => ITrigger)`:为触发器注册字符串别名(仅用于手动查询,不参与 `collect` 自动收集) +- `getString(id: string)`:按字符串 id 查询触发器工厂 + +每个 key 只对应一个工厂。重复注册同一 key 时,发出警告并以新工厂覆盖旧的。 + +## 3. 触发收集 ITriggerCollector + +`ITriggerCollector` 属于 Layer 2(`@user/data-system`),独立于 `ILayerState` 存在,不挂载到任何 Layer 1 接口上。地图在 Layer 1 中只存储可序列化的图块数据(如图块编号),不持有 `ITrigger` 实例。收集时,调用方显式传入目标图层 `layer`(`IMapLayer`),`ITriggerCollector` 读取该图层中该格点的图块数据——包括静态图块(通过 `IMapLayer.getBlock`)以及动态图块(通过 `IMapLayer.dynamicLayer`)——并结合后续由 `IMapLayer.getTileInfo` 暴露的图块信息读取其中记录的触发器类型,再通过 `ITriggerRegistry` 获取工厂并构造对应的 `ITrigger`,收集后排序,返回 `ITriggerCollection`。注册表通过 `attachRegistry(registry)` 设置。 + +排序规则:按触发器自身 `priority` 降序排列。这里的 `priority` 不仅表示执行顺序,也表示单次收集内的唯一执行位;正常情况下同一坐标只会有一个触发器,多触发器支持仅用于极少数拓展场景。收集阶段若发现两个或以上触发器的 `priority` 相同,则视为配置冲突,发出警告,并将本次结果中所有该优先级的触发器全部剔除,不进入 `ITriggerCollection`。 + +## 4. 触发器集合 ITriggerCollection + +`ITriggerCollection` 是一组已排序的 `ITrigger` 的载体,提供统一的触发入口 `trigger(...)` 与迭代方法 `iterate()`、数量属性 `count`。`push` / `unshift` / `concat` 均不对集合重新排序,语义为"强制指定执行位置",与 `priority` 排序体系完全分离(`ITriggerCollection` 本身与地图无关,不应自行排序)。可由: + +- `ITriggerCollector.collect` 返回; +- `ITrigger.collection()` 方法直接构造(单触发器集合)。 + +触发执行策略:`trigger(handler)` 顺序异步执行(返回 `Promise`),触发器之间串行等待;`triggerIter(handler)` 返回异步生成器,调用方可逐个推进执行并为每一步单独传入上下文,适用于需要在触发器间插入额外逻辑的进阶场景。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `@user/data-base`(跨包引用):`@user/data-system/trigger/types.ts` 中的 `ITriggerHandler` 需要引用 `IStateBase`(全局状态)、`ILayerState`(楼层状态)、`IMapLayer`(图层)与 `ITileLocator`;`ITriggerCollector.collect` 同样需要引用 `IMapLayer`,并依赖其后续提供的 `getTileInfo` 读取图块信息中的触发器类型 + +## 需要修改的文件 + +### `@user/data-base` 中的 `ILayerState` + +- [x] 新增 `readonly eventLayer: IMapLayer | null` 属性:表示该楼层的默认事件图层,供引擎默认收集行为使用(引擎默认收集逻辑不在本设计范围内) +- [x] 新增 `setEventLayer(layer: IMapLayer | null): void` 方法:设置默认事件图层 + +## 需要新建的文件 + +### `@user/data-system/trigger/types.ts` + +- [ ] 新增 `ITriggerHandler` 接口:触发时传入的上下文对象,包含必选的 `state: IStateBase` 以及可选的 `layer?: ILayerState`、`mapLayer?: IMapLayer`、`locator?: ITileLocator` +- [ ] 新增 `ITrigger` 接口:触发器原子对象,代表一类事件逻辑;包含 `type: number` 类型标识、`priority` 优先级成员、`trigger(handler: ITriggerHandler): Promise` 触发方法与 `collection()` 方法以便包装为集合 +- [ ] 新增 `ITriggerRegistry` 接口:包含 `register(type, factory: (type: number) => ITrigger)` `get(type)` `registerString(id, factory: () => ITrigger)` `getString(id)` 四个方法;以触发器类型 `type` 为核心管理注册与查询,字符串 id 为触发器自身别名,不参与 `collect` 自动收集;数字注册路径下由注册表透传 `type` 给工厂,保证实例的 `ITrigger.type` 与注册项一致 +- [ ] 新增 `ITriggerCollection` 接口:包含已排序的触发器集合,提供 `trigger(handler)` 顺序异步触发入口(`Promise`)与 `triggerIter(handler)` 异步迭代触发入口(`AsyncGenerator`)、`iterate()` 迭代方法、`count` 数量属性、`push` / `unshift` 向集合末尾或头部插入(不重排序)的方法,以及 `concat(...others)` 按自身在前的顺序合并多个集合(不重排序)的方法 +- [ ] 新增 `ITriggerCollector` 接口:包含 `collect(x: number, y: number, layer: IMapLayer)` 收集方法与 `attachRegistry(registry: ITriggerRegistry | null)` 注册表设置方法 diff --git a/packages-user/data-base/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts index 9edb9ed..2e1e345 100644 --- a/packages-user/data-base/src/map/layerState.ts +++ b/packages-user/data-base/src/map/layerState.ts @@ -31,8 +31,8 @@ export class LayerState /** 图层钩子映射 */ private layerHookMap: Map = new Map(); - /** 楼层是否处于激活状态 */ active: boolean = false; + eventLayer: IMapLayer | null = null; /** 楼层级脏标记 */ private dirty: boolean = false; @@ -130,6 +130,17 @@ export class LayerState this.active = active; } + setEventLayer(layer: IMapLayer | null): void { + if (!layer) { + this.eventLayer = null; + } else { + if (!this.layerList.has(layer)) { + return; + } + this.eventLayer = layer; + } + } + isDirty(): boolean { return this.dirty; } diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index 49e6da5..8e7d9b8 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -231,6 +231,8 @@ export interface ILayerState extends IHookable { readonly width: number; /** 此楼层的地图高度 */ readonly height: number; + /** 当前楼层的默认事件层 */ + readonly eventLayer: IMapLayer | null; /** * 添加图层,使用楼层预设的宽高 @@ -293,6 +295,12 @@ export interface ILayerState extends IHookable { */ setActiveStatus(active: boolean): void; + /** + * 设置本楼层的事件层图层 + * @param layer 图层 + */ + setEventLayer(layer: IMapLayer | null): void; + /** * 楼层是否被修改过(相对于参考基准) */ diff --git a/packages-user/data-system/src/index.ts b/packages-user/data-system/src/index.ts index 7fd3ec0..25a6dfe 100644 --- a/packages-user/data-system/src/index.ts +++ b/packages-user/data-system/src/index.ts @@ -1 +1,2 @@ export * from './combat'; +export * from './trigger'; diff --git a/packages-user/data-system/src/trigger/collection.ts b/packages-user/data-system/src/trigger/collection.ts new file mode 100644 index 0000000..e76f69a --- /dev/null +++ b/packages-user/data-system/src/trigger/collection.ts @@ -0,0 +1,57 @@ +import { ITrigger, ITriggerCollection, ITriggerHandler } from './types'; + +export class TriggerCollection implements ITriggerCollection { + /** 当前集合内部维护的触发器列表 */ + private readonly triggerList: ITrigger[]; + + constructor(triggers: Iterable) { + this.triggerList = Array.from(triggers); + } + + count(): number { + return this.triggerList.length; + } + + async trigger( + handler: ITriggerHandler + ): Promise { + for (const trigger of this.triggerList) { + await trigger.trigger(handler); + } + } + + async *triggerIter( + handler: ITriggerHandler + ): AsyncGenerator | null> { + let currentHandler = handler; + for (const trigger of this.triggerList) { + await trigger.trigger(currentHandler); + const nextHandler = yield trigger; + if (nextHandler) { + currentHandler = nextHandler; + } else { + currentHandler = handler; + } + } + } + + iterate(): Iterable { + return this.triggerList.values(); + } + + push(trigger: ITrigger): void { + this.triggerList.push(trigger); + } + + unshift(trigger: ITrigger): void { + this.triggerList.unshift(trigger); + } + + concat(...others: ITriggerCollection[]): ITriggerCollection { + const merged = [...this.triggerList]; + for (const other of others) { + merged.push(...other.iterate()); + } + return new TriggerCollection(merged); + } +} diff --git a/packages-user/data-system/src/trigger/index.ts b/packages-user/data-system/src/trigger/index.ts new file mode 100644 index 0000000..02077b8 --- /dev/null +++ b/packages-user/data-system/src/trigger/index.ts @@ -0,0 +1,3 @@ +export * from './types'; +export * from './collection'; +export * from './registry'; diff --git a/packages-user/data-system/src/trigger/registry.ts b/packages-user/data-system/src/trigger/registry.ts new file mode 100644 index 0000000..6b2a86a --- /dev/null +++ b/packages-user/data-system/src/trigger/registry.ts @@ -0,0 +1,49 @@ +import { logger } from '@motajs/common'; +import { + ITrigger, + ITriggerRegistry, + TriggerFactory, + TriggerStringFactory +} from './types'; + +export class TriggerRegistry implements ITriggerRegistry { + /** 数字类型到触发器工厂的映射 */ + private readonly typeMap: Map = new Map(); + + /** 字符串 id 到触发器工厂的映射 */ + private readonly stringMap: Map = new Map(); + + register(type: number, factory: TriggerFactory): void { + if (this.typeMap.has(type)) { + logger.warn(132, 'type', type.toString()); + } + this.typeMap.set(type, factory); + } + + get(type: number): TriggerFactory | null { + return this.typeMap.get(type) ?? null; + } + + create(num: number): ITrigger | null { + const factory = this.get(num); + if (!factory) return null; + return factory(num); + } + + registerString(id: string, factory: TriggerStringFactory): void { + if (this.stringMap.has(id)) { + logger.warn(132, 'id', id); + } + this.stringMap.set(id, factory); + } + + getString(id: string): TriggerStringFactory | null { + return this.stringMap.get(id) ?? null; + } + + createByString(id: string): ITrigger | null { + const factory = this.getString(id); + if (!factory) return null; + return factory(); + } +} diff --git a/packages-user/data-system/src/trigger/types.ts b/packages-user/data-system/src/trigger/types.ts new file mode 100644 index 0000000..2e75673 --- /dev/null +++ b/packages-user/data-system/src/trigger/types.ts @@ -0,0 +1,139 @@ +import { ITileLocator } from '@motajs/common'; +import { ILayerState, IMapLayer, IStateBase } from '@user/data-base'; + +export interface ITriggerHandler { + /** 当前全局状态对象 */ + readonly state: IStateBase; + /** 当前楼层状态对象 */ + readonly layer?: ILayerState; + /** 当前参与触发的图层对象 */ + readonly mapLayer?: IMapLayer; + /** 当前触发点定位符 */ + readonly locator?: ITileLocator; +} + +export type TriggerFactory = (type: number) => ITrigger; + +export type TriggerStringFactory = () => ITrigger; + +export interface ITrigger { + /** 触发器类型标识 */ + readonly type: number; + /** 触发器优先级 */ + readonly priority: number; + + /** + * 使用给定上下文触发当前触发器 + * @param handler 触发上下文对象 + */ + trigger( + handler: ITriggerHandler + ): Promise; + + /** + * 将当前触发器包装为单元素触发器集合 + */ + collection(): ITriggerCollection; +} + +export interface ITriggerRegistry { + /** + * 注册一个按类型创建的触发器工厂 + * @param type 触发器类型 + * @param factory 触发器工厂函数 + */ + register(type: number, factory: TriggerFactory): void; + + /** + * 获取指定类型的触发器工厂 + * @param type 触发器类型 + */ + get(type: number): TriggerFactory | null; + + /** + * 根据触发器类型创建一个触发器实例,如果对应工厂不存在则返回 `null` + * @param num 触发器类型 + */ + create(num: number): ITrigger | null; + + /** + * 注册一个按字符串 id 查询的触发器工厂 + * @param id 触发器字符串 id + * @param factory 触发器工厂函数 + */ + registerString(id: string, factory: TriggerStringFactory): void; + + /** + * 获取指定字符串 id 对应的触发器工厂 + * @param id 触发器字符串 id + */ + getString(id: string): TriggerStringFactory | null; + + /** + * 根据字符串 id 创建一个触发器实例,如果对应工厂不存在则返回 `null` + * @param id 触发器字符串 id + */ + createByString(id: string): ITrigger | null; +} + +export interface ITriggerCollection { + /** + * 当前集合中的触发器数量 + */ + count(): number; + + /** + * 顺序触发当前集合中的所有触发器 + * @param handler 初始触发上下文对象 + */ + trigger( + handler: ITriggerHandler + ): Promise; + + /** + * 逐个触发当前集合中的触发器,并允许为下一次推进提供新上下文 + * @param handler 初始触发上下文对象 + */ + triggerIter( + handler: ITriggerHandler + ): AsyncGenerator | null>; + + /** + * 迭代当前集合中的所有触发器 + */ + iterate(): Iterable; + + /** + * 向集合末尾追加一个触发器 + * @param trigger 要追加的触发器 + */ + push(trigger: ITrigger): void; + + /** + * 向集合头部插入一个触发器 + * @param trigger 要插入的触发器 + */ + unshift(trigger: ITrigger): void; + + /** + * 将当前集合与其他集合顺序拼接为一个新集合 + * @param others 要拼接的其他集合 + */ + concat(...others: ITriggerCollection[]): ITriggerCollection; +} + +export interface ITriggerCollector { + /** + * 收集指定图层中某一点的所有触发器 + * @param x 横坐标 + * @param y 纵坐标 + * @param layer 目标图层 + */ + collect(x: number, y: number, layer: IMapLayer): ITriggerCollection; + + /** + * 绑定或清除当前 collector 使用的注册表 + * @param registry 触发器注册表 + */ + attachRegistry(registry: ITriggerRegistry | null): void; +} diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 571c3b9..8fde405 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -188,6 +188,8 @@ "128": "Position $1,$2 is out of map bounds, operation cancelled.", "129": "Position $1,$2 is not empty, existing block will be overwritten.", "130": "The given tile is not managed by this dynamic layer.", + "131": "Event layer to set is not belong to current LayerState.", + "132": "Trigger registry entry of $1 '$2' already exists, new factory will override old factory.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } diff --git a/prompt.md b/prompt.md index 5dd82ae..3137c38 100644 --- a/prompt.md +++ b/prompt.md @@ -21,6 +21,7 @@ 3. **发现接口问题时提问**:若认为类型标注中的接口设计有问题,或在实现中发现缺少某些接口,应向我提问是否添加,经我同意后方可添加。 4. **接口设计兼顾合理性与便捷性**:设计接口时不仅要考虑合理性,还要考虑使用便捷性。罕见场景应当被支持,但不应与常见场景共用同一接口——这只会增加常见场景的使用难度。 5. **避免多余的非空判断与类型守卫**:若某个类型已满足目标的类型约束,不应再对其添加任何判断或过滤操作。典型例子:`Promise.all` 对数组元素类型没有任何限制,传入 `(Promise | void)[]` 完全合法,无需多此一举地写成 `Promise.all(arr.filter(v => !!v))`。 +6. **关于整个仓库的类型检查**:一般情况下**不需要**跑全仓库的类型检查,每个需求都是独立的,不会影响外部内容。只有在进行重构的时候才有此需求。 **时刻谨记上述要求,避免一个需求反复修改仍无法满足预期。** From 13fc4e1b7c11dcb8bff59685db94d8ed6b8527ed Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 16:31:08 +0800 Subject: [PATCH 17/26] refactor: TileStore --- docs/dev/store/tile-store.md | 308 ++++++++++++++++++ packages-user/data-base/src/index.ts | 1 + packages-user/data-base/src/store/index.ts | 2 + .../data-base/src/store/tileStore.ts | 86 +++++ packages-user/data-base/src/store/types.ts | 91 ++++++ packages-user/data-base/src/types.ts | 7 +- packages-user/data-state/src/core.ts | 67 +++- packages-user/data-state/src/index.ts | 45 +-- packages-user/data-state/src/legacy/index.ts | 1 + packages-user/data-state/src/legacy/tile.ts | 39 +++ .../legacy-plugin-data/src/fallback.ts | 2 +- packages/common/src/logger.json | 3 + 12 files changed, 588 insertions(+), 64 deletions(-) create mode 100644 docs/dev/store/tile-store.md create mode 100644 packages-user/data-base/src/store/index.ts create mode 100644 packages-user/data-base/src/store/tileStore.ts create mode 100644 packages-user/data-base/src/store/types.ts create mode 100644 packages-user/data-state/src/legacy/tile.ts diff --git a/docs/dev/store/tile-store.md b/docs/dev/store/tile-store.md new file mode 100644 index 0000000..2f1fae4 --- /dev/null +++ b/docs/dev/store/tile-store.md @@ -0,0 +1,308 @@ +# 需求综述 + +当前关于地图触发器的设计卡在“图块定义本身尚未抽象出来”这一前置问题上。继续讨论 [docs/dev/map/tile-info.md](docs/dev/map/tile-info.md) 中的地图触发器存储方案,会立刻撞上一个更底层的问题: + +1. 某个图块数字到底对应什么 id; +2. 某个图块默认携带什么触发器类型; +3. 某个图块属于哪一类图块; +4. 旧引擎中的 `blocksInfo` 应该如何转移到新接口。 + +因此,下一步更合适的顺序不是继续扩展地图侧接口,而是先补齐一个独立的 `ITileStore`。它属于 Layer 0,不参与存档,也不承载运行时动态状态,只负责提供“图块定义查询”这一底层能力。 + +这次设计的目标如下: + +1. 将当前挂在全局状态上的 `idNumberMap` 与 `numberIdMap` 收拢到 `ITileStore` 内; +2. 为图块定义提供统一查询入口:`getData`、`getTrigger`、`getType`; +3. 提供统一写入口 `addTile`,用于初始化阶段录入图块定义; +4. 提供 `attachLegacyConverter` 与 `fromLegacy` 两个接口,用于从旧引擎迁移图块定义; +5. 明确这部分能力不属于存档系统,且应当放在 Layer 0。 + +--- + +# 接口设计与预期 + +## ITileRawData + +`ITileRawData` 表示单个图块的最小原始定义。按照当前结论,需要包含四个字段:图块数字、图块 id、触发器类型、图块类型。 + +- `ITileRawData.num`:预期频率**中频**。图块数字是整个图块定义系统的主键,`addTile`、`getData` 与旧引擎导入都会依赖它,但日常脚本中通常不会反复直接读写,故为中频。 +- `ITileRawData.id`:预期频率**中频**。图块 id 常用于脚本层、兼容层与素材层之间的衔接,出现频率不低,但通常通过 `idToNumber` 间接使用,故为中频。典型使用场景:旧接口或脚本给出 `yellowDoor` 这类字符串 id,希望先查到对应图块数字。 +- `ITileRawData.trigger`:预期频率**中频**。当前触发器设计已经收敛到“数据层只存触发器类型数字”,因此这是图块定义中的核心字段之一,但大多数代码仍会优先通过 `getTrigger` 访问,故为中频。典型使用场景:地图初始化时根据图块默认定义,给某个格点填入默认触发器类型。 +- `ITileRawData.type`:预期频率**中频**。图块类型会被 `getType` 高效访问,但在定义录入阶段仍应直接作为图块原始数据的一部分保存,避免再人为拆成第二套并行数据源。典型使用场景:地图或逻辑层拿到某个图块定义后,希望直接知道其属于地形、怪物、NPC 还是道具。 + +当前建议接口如下: + +```ts +export interface ITileRawData { + readonly num: number; + readonly id: string; + readonly trigger: number; + readonly type: TileType; +} +``` + +之所以推荐使用 `num` 而不是 `number`,是因为当前仓库内地图与图块相关接口几乎都使用 `num` 表示图块数字,延续这一命名更自然。 + +## TileType + +`getType` 需要返回一个图块类型枚举。按照当前需求,建议先定义以下八种: + +1. `Unknown` +2. `None` +3. `Terrain` +4. `Animate` +5. `Item` +6. `Enemy` +7. `Npc` +8. `Tileset` + +这里的目的不是完整复刻旧引擎的所有 `cls`,而是先给当前执行层与地图层提供足够稳定、足够粗粒度的类型划分。基于旧引擎的现有分类,当前建议映射关系如下: + +1. `0` 号空白图块映射为 `None` +2. `terrains` 与 `autotile` 统一映射为 `Terrain` +3. `animates` 映射为 `Animate` +4. `items` 映射为 `Item` +5. `enemys` 与 `enemy48` 统一映射为 `Enemy` +6. `npcs` 与 `npc48` 统一映射为 `Npc` +7. `tileset` 映射为 `Tileset` +8. 其他尚未归类或不存在的图块映射为 `Unknown` + +这样处理的原因是:当前数据端真正需要的是“足够稳定的逻辑分类”,而不是把渲染素材维度的细分 `cls` 原封不动搬进底层接口。 + +## ITileStore + +`ITileStore` 是图块定义的统一查询与写入接口。由于它本身不会进入存档,也不承担运行时状态变化,因此整体频率分布会明显偏向“读取高于写入”。 + +- `ITileStore.getData(num)`:预期频率**中频**。这个接口会返回完整的 `ITileRawData`,适合调试、兼容层、编辑器与初始化阶段使用,但在真正的高频逻辑中,调用方通常只关心某个单独字段,因此为中频。典型使用场景:兼容层需要同时读取图块数字、id 与默认触发器。 +- `ITileStore.getTrigger(num)`:预期频率**高频**。这是 `getData(num).trigger` 的快捷接口,后续地图初始化、事件绑定与触发器相关逻辑都会优先使用这一接口,故为高频。典型使用场景:根据某个图块数字读取其默认触发器类型,再决定是否写入地图触发器稀疏表。 +- `ITileStore.getType(num)`:预期频率**高频**。图块类型分类会直接影响地图逻辑、兼容层判断、后续的地图对象设计,因此它和 `getTrigger` 一样属于高频读取接口。典型使用场景:逻辑层拿到某个图块数字后,需要快速判断它属于地形、道具、怪物还是 NPC。 +- `ITileStore.addTile(data)`:预期频率**低频**。图块定义在正常运行期不会动态修改,`addTile` 主要用于初始化与旧数据导入阶段,故为低频。 +- `ITileStore.idToNumber(id)`:预期频率**中频**。它是 `idNumberMap` 的方法化替代,兼容层、脚本层和部分初始化逻辑都需要从字符串 id 反查图块数字,故为中频。典型使用场景:旧接口 `setBlock('yellowDoor', x, y)` 需要先把 id 转成图块数字。 +- `ITileStore.numberToId(num)`:预期频率**中频**。它是 `numberIdMap` 的方法化替代,主要用于调试、兼容层与少量需要回推图块 id 的场景,故为中频。典型使用场景:拿到地图上的图块数字后,希望恢复出旧引擎语义下的图块 id。 +- `ITileStore.attachLegacyConverter(converter)`:预期频率**低频**。仅在初始化或切换兼容转换器时调用,负责把旧引擎图块定义的解释规则注入到 store 中,故为低频。 +- `ITileStore.fromLegacy(num, legacy)`:预期频率**低频**。用于将单个旧样板图块定义转换并写入 store,整体使用方式应与 `IEnemyManager.fromLegacyEnemy` 类似,由外层自行遍历 legacy store 后逐个调用,故为低频。典型使用场景:初始化时遍历 `core.maps.blocksInfo`,对每一项执行 `tileStore.fromLegacy(num, block)`。 + +当前建议接口如下: + +```ts +export interface ITileStore { + getData(num: number): ITileRawData | null; + getTrigger(num: number): number; + getType(num: number): TileType; + addTile(data: ITileRawData): void; + idToNumber(id: string): number | null; + numberToId(num: number): string | null; + attachLegacyConverter( + converter: ITileLegacyConverter + ): void; + fromLegacy(num: number, legacy: TLegacy): ITileRawData; +} +``` + +返回值语义建议如下: + +1. `getData(num)`:若图块不存在,返回 `null` +2. `getTrigger(num)`:若图块不存在或未配置触发器,返回 `-1` +3. `getType(num)`:若图块不存在或尚未归类,返回 `TileType.Unknown` +4. `idToNumber(id)` / `numberToId(num)`:不存在时返回 `null` + +之所以让 `getTrigger` 和 `getType` 在缺失场景下返回稳定默认值,是因为这两者更偏“高频逻辑查询”,热路径上不适合层层判空。 + +## ITileLegacyConverter / attachLegacyConverter / fromLegacy + +`ITileStore` 本身不应直接理解旧引擎里 `blocksInfo` 的全部细节,而应通过用户层提供的 legacy converter 完成转换。这样做的原因是:旧引擎中的默认触发器来源并不统一,既有显式 `trigger` 字段,也有通过 `cls` 或其他成员隐式决定的情况。 + +从 [public/project/maps.js](public/project/maps.js) 当前样板可以直接看到两类典型情况: + +1. 部分图块显式写了 `trigger`,例如黄门的 `openDoor`、箱子的 `pushBox`、冰面或滑板的特殊触发; +2. 部分图块没有显式 `trigger`,但其行为仍然会根据 `cls` 或其他规则隐式确定,例如怪物图块。 + +因此更合适的设计是: + +```ts +export interface ITileLegacyConverter { + fromLegacy(num: number, legacy: TLegacy): ITileRawData; +} +``` + +其中: + +1. `attachLegacyConverter(converter)` 负责向 store 注入转换器; +2. `fromLegacy(num, legacy)` 负责调用当前转换器完成单个 legacy 图块定义的转换,并将结果写入 store; +3. 导入整个旧引擎 `blocksInfo` 时,由外层自行遍历并多次调用 `fromLegacy`。 + +当前更推荐的使用形式是: + +```ts +tileStore.attachLegacyConverter(converter); + +for (const [key, value] of Object.entries(core.maps.blocksInfo)) { + tileStore.fromLegacy(Number(key), value); +} +``` + +其职责包括: + +1. 用户层定义 legacy -> `ITileRawData` 的转换规则; +2. 显式处理“trigger 字段优先”与“按 cls 推导”并存的旧设计; +3. 保证 `ITileStore` 本体只负责存储与查询,不负责耦合旧样板细节。 + +--- + +# 实现思路 + +## 1. 先建立独立的 store 模块 + +因为 `ITileStore` 属于 Layer 0,且不依赖地图、怪物、勇士等更高层模块,所以更适合作为 `@user/data-base/src/store` 下的首个 Store 类接口存在。 + +当前不建议单独再开 `tile` 文件夹,而是直接放到 [packages-user/data-base/src/store](packages-user/data-base/src/store) 中。这样后续若还有其他内容迁移为新的 Store 类接口,也可以继续并列放在 `store` 目录下,而不是再拆出多个平行顶层目录。 + +## 2. 对外暴露方法,对内仍可继续使用双映射 + +`idNumberMap` 与 `numberIdMap` 迁移到 `ITileStore` 后,对外不再暴露原始 `Map`,而改成方法: + +1. `idToNumber(id)` +2. `numberToId(num)` + +但在内部实现上,仍然完全可以保留: + +1. `Map` +2. `Map` +3. `Map` + +也就是说,这次重构的重点是**收拢职责和稳定接口**,不是刻意放弃现有映射结构。 + +## 3. getType 直接从原始数据读取 + +按照当前结论,`ITileRawData` 包含: + +1. `num` +2. `id` +3. `trigger` +4. `type` + +这意味着 `getType(num)` 不需要再依赖额外并行映射,而可以直接读取 `getData(num)?.type`。这样做的好处是: + +1. `addTile` 的输入结构完整且闭合; +2. 不会再出现“raw data 一套、type 映射又一套”的双数据源; +3. legacy converter 转换出的结果可以直接完整写入 store。 + +## 4. addTile 只负责录入定义,不负责存档 + +`addTile(data)` 的职责应当收敛到“向 store 录入一个图块定义”,而不是承担任何运行时逻辑。 + +因为这部分数据不会动态变更,也不参与存档,所以其主要使用时机只有: + +1. 初次初始化 +2. 旧引擎数据迁移 +3. 极少量的测试或工具链注入 + +当前你已经给出了 number 冲突时“警告并覆盖”的语义,这一点应该直接保留。 + +此外,`id` 冲突但 `num` 不冲突时,也应当采用同样的警告并覆盖策略;并且警告内容需要明确指出冲突来源到底是 `num` 还是 `id`。 + +## 5. 全局状态从两张 Map 改为一个 store + +当前 [packages-user/data-base/src/types.ts](packages-user/data-base/src/types.ts) 里的 `IStateBase` 仍直接暴露: + +1. `idNumberMap` +2. `numberIdMap` + +如果 `ITileStore` 建立起来,那么全局状态更合理的暴露方式应当改为: + +```ts +readonly tileStore: ITileStore; +``` + +后续所有调用点统一改成: + +1. `state.tileStore.idToNumber(id)` +2. `state.tileStore.numberToId(num)` +3. `state.tileStore.getTrigger(num)` +4. `state.tileStore.getType(num)` + +这样图块定义相关职责就不会再散落在全局状态根节点上。 + +## 6. 旧引擎迁移的职责边界 + +当前 [packages-user/data-state/src/index.ts](packages-user/data-state/src/index.ts) 在初始化阶段直接遍历 `core.maps.blocksInfo`,并手动填充 `state.idNumberMap` / `state.numberIdMap`。 + +引入 `ITileStore` 后,这段初始化逻辑更适合拆成两段: + +1. 先在用户层实现并挂载 legacy converter; +2. 再遍历 `core.maps.blocksInfo`,逐个调用 `tileStore.fromLegacy(num, block)`; +3. 其他真正依赖图块定义的初始化逻辑,例如朝向绑定,再从 `tileStore` 继续读取数据。 + +这样旧引擎兼容逻辑就不会和全局状态初始化逻辑搅在一起。 + +同时,因为旧样板里的触发器来源并不统一,这种“用户层 converter + store 只负责存储”的边界也更合理: + +1. store 不需要知道 `trigger` 究竟来自字段、`cls`,还是更特殊的 legacy 规则; +2. 用户层可以按当前项目的具体兼容策略自由决定优先级; +3. 将来若 legacy 来源变化,只需要替换 converter,不必改 `ITileStore` 本体。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- [packages-user/data-base/src/types.ts](packages-user/data-base/src/types.ts):当前 `IStateBase` 仍直接暴露 `idNumberMap` 与 `numberIdMap` +- [packages-user/data-state/src/index.ts](packages-user/data-state/src/index.ts):当前旧引擎图块定义导入逻辑的主要入口 +- [packages-user/data-state/src/core.ts](packages-user/data-state/src/core.ts):当前 `CoreState` 中两张映射的实际持有位置 +- [packages-user/client-modules/src/fallback/load.ts](packages-user/client-modules/src/fallback/load.ts):当前旧引擎图块 `cls` 分类的实际使用点,可作为 `TileType` 映射参考 +- [docs/dev/map/tile-info.md](docs/dev/map/tile-info.md):后续地图触发器设计将直接依赖 `ITileStore` + +## 需要修改的文件 + +### `@user/data-base/src/store/types.ts` + +- [ ] 新增 `ITileRawData` 接口:定义图块最小原始定义,当前包含 `num`、`id`、`trigger`、`type` +- [ ] 新增 `TileType` 枚举:定义统一的图块逻辑分类 +- [ ] 新增 `ITileLegacyConverter` 接口:定义 legacy 图块定义到 `ITileRawData` 的转换规则 +- [ ] 新增 `ITileStore` 接口:提供图块定义的统一查询与写入入口 +- [ ] 为 `ITileStore` 新增 `attachLegacyConverter` 与 `fromLegacy` + +### `@user/data-base/src/store/tileStore.ts` + +- [ ] 实现 `ITileStore` +- [ ] 内部维护 `num -> raw data`、`id -> num` 与 `num -> id` 的映射 +- [ ] 实现 `addTile` 的警告覆盖逻辑,并区分 `num` 冲突与 `id` 冲突 +- [ ] 实现 `attachLegacyConverter` 与 `fromLegacy` + +### `@user/data-base/src/store/index.ts` + +- [ ] 导出 tile 模块公共接口与实现 + +### `@user/data-base/src/types.ts` + +- [ ] 从 `IStateBase` 中移除 `idNumberMap` 与 `numberIdMap` +- [ ] 新增 `readonly tileStore: ITileStore` + +### `@user/data-base/src/index.ts` + +- [ ] 补齐 tile 模块的公共导出 + +### `@user/data-state/src/core.ts` + +- [ ] 移除 `CoreState` 对两张映射的直接持有 +- [ ] 改为持有 `tileStore` + +### `@user/data-state/src/index.ts` + +- [ ] 将旧引擎 `blocksInfo` 的初始化逻辑迁移到“挂载 converter 后逐个调用 `fromLegacy`” +- [ ] 后续朝向绑定等逻辑改为通过 `tileStore.idToNumber` 读取图块数字 + +### `docs/dev/map/tile-info.md` + +- [ ] 在 `ITileStore` 定稿后,再继续补齐地图触发器设计文档中对图块默认触发器来源的描述 + +--- + +# 当前结论 + +1. `TileType` 应当直接包含进 `ITileRawData`,不再单独拆成并行数据源。 +2. legacy 导入不再使用顶层工厂函数,而改为 `attachLegacyConverter + fromLegacy` 组合;由用户层自行提供 converter,再逐个执行转换。 +3. `addTile` 在 `num` 冲突与 `id` 冲突两种场景下都应警告并覆盖,且警告信息必须明确指出冲突来源。 +4. `getTrigger(num)` 在图块不存在或无触发器时统一返回 `-1`。 +5. 旧引擎里的默认触发器来源是混合式的:有时来自显式 `trigger` 字段,有时来自 `cls` 或其他规则;这一差异应当由用户层 converter 消化,而不是让 `ITileStore` 本体直接耦合旧样板细节。 diff --git a/packages-user/data-base/src/index.ts b/packages-user/data-base/src/index.ts index 0be7276..55d11bf 100644 --- a/packages-user/data-base/src/index.ts +++ b/packages-user/data-base/src/index.ts @@ -4,6 +4,7 @@ export * from './flag'; export * from './hero'; export * from './load'; export * from './map'; +export * from './store'; export * from './game'; export * from './types'; diff --git a/packages-user/data-base/src/store/index.ts b/packages-user/data-base/src/store/index.ts new file mode 100644 index 0000000..b86cf0f --- /dev/null +++ b/packages-user/data-base/src/store/index.ts @@ -0,0 +1,2 @@ +export * from './tileStore'; +export * from './types'; diff --git a/packages-user/data-base/src/store/tileStore.ts b/packages-user/data-base/src/store/tileStore.ts new file mode 100644 index 0000000..af88d98 --- /dev/null +++ b/packages-user/data-base/src/store/tileStore.ts @@ -0,0 +1,86 @@ +import { isNil } from 'lodash-es'; +import { logger } from '@motajs/common'; +import { + ITileLegacyConverter, + ITileRawData, + ITileStore, + TileType +} from './types'; + +export class TileStore implements ITileStore { + /** 以图块数字为键的原始图块定义表 */ + private readonly dataMap: Map = new Map(); + + /** 由图块 id 反查图块数字的映射表 */ + private readonly idMap: Map = new Map(); + + /** 由图块数字反查图块 id 的映射表 */ + private readonly numMap: Map = new Map(); + + /** 当前挂载的旧样板图块转换器 */ + private legacyConverter: ITileLegacyConverter | null = null; + + getData(num: number): ITileRawData | null { + return this.dataMap.get(num) ?? null; + } + + getTrigger(num: number): number { + return this.dataMap.get(num)?.trigger ?? -1; + } + + getType(num: number): TileType { + return this.dataMap.get(num)?.type ?? TileType.Unknown; + } + + addTile(data: ITileRawData): void { + const oldData = this.dataMap.get(data.num); + const oldNum = this.idMap.get(data.id); + if (oldData) { + logger.warn(133, data.num.toString(), oldData.id); + this.deleteBy(oldData.num, oldData.id); + } + if (!isNil(oldNum) && oldNum !== data.num) { + logger.warn(134, data.id, oldNum.toString()); + const oldIdData = this.dataMap.get(oldNum); + if (oldIdData) { + this.deleteBy(oldIdData.num, oldIdData.id); + } else { + this.idMap.delete(data.id); + this.numMap.delete(oldNum); + } + } + this.dataMap.set(data.num, data); + this.idMap.set(data.id, data.num); + this.numMap.set(data.num, data.id); + } + + idToNumber(id: string): number | null { + return this.idMap.get(id) ?? null; + } + + numberToId(num: number): string | null { + return this.numMap.get(num) ?? null; + } + + attachLegacyConverter(converter: ITileLegacyConverter): void { + this.legacyConverter = converter; + } + + fromLegacy(num: number, legacy: TLegacy): ITileRawData { + const converter = this.legacyConverter; + if (!converter) { + logger.error(56); + throw new Error('Expected a tile legacy converter'); + } + const data = converter.fromLegacy(num, legacy); + this.addTile(data); + return data; + } + + /** 删除一组旧的图块定义及其双向索引 */ + private deleteBy(num: number, id: string): void { + this.dataMap.delete(num); + this.idMap.delete(id); + this.numMap.delete(num); + } +} diff --git a/packages-user/data-base/src/store/types.ts b/packages-user/data-base/src/store/types.ts new file mode 100644 index 0000000..4528233 --- /dev/null +++ b/packages-user/data-base/src/store/types.ts @@ -0,0 +1,91 @@ +export const enum TileType { + /** 未知或尚未归类的图块 */ + Unknown, + /** 空白图块 */ + None, + /** 地形类图块 */ + Terrain, + /** 动画类图块 */ + Animate, + /** 道具类图块 */ + Item, + /** 怪物类图块 */ + Enemy, + /** NPC 类图块 */ + Npc, + /** 自动元件 */ + Autotile, + /** Tileset 切片图块 */ + Tileset +} + +export interface ITileRawData { + /** 图块数字 */ + readonly num: number; + /** 图块字符串 id */ + readonly id: string; + /** 默认触发器类型 */ + readonly trigger: number; + /** 图块逻辑类型 */ + readonly type: TileType; +} + +export interface ITileLegacyConverter { + /** + * 将旧样板图块定义转换为新的图块原始数据 + * @param num 图块数字 + * @param legacy 旧样板图块定义 + */ + fromLegacy(num: number, legacy: TLegacy): ITileRawData; +} + +export interface ITileStore { + /** + * 获取指定图块数字对应的完整原始定义 + * @param num 图块数字 + */ + getData(num: number): ITileRawData | null; + + /** + * 获取指定图块数字对应的默认触发器类型 + * @param num 图块数字 + */ + getTrigger(num: number): number; + + /** + * 获取指定图块数字对应的图块类型 + * @param num 图块数字 + */ + getType(num: number): TileType; + + /** + * 添加一个图块定义;若 `num` 或 `id` 冲突则警告并覆盖 + * @param data 图块原始定义 + */ + addTile(data: ITileRawData): void; + + /** + * 根据图块 id 查询对应图块数字 + * @param id 图块 id + */ + idToNumber(id: string): number | null; + + /** + * 根据图块数字查询对应图块 id + * @param num 图块数字 + */ + numberToId(num: number): string | null; + + /** + * 挂载一个旧样板转换器 + * @param converter 旧样板转换器 + */ + attachLegacyConverter(converter: ITileLegacyConverter): void; + + /** + * 使用当前转换器转换并写入一个旧样板图块定义 + * @param num 图块数字 + * @param legacy 旧样板图块定义 + */ + fromLegacy(num: number, legacy: TLegacy): ITileRawData; +} diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index b733dbc..33b6e5f 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -3,6 +3,7 @@ import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; import { IFaceManager, IRoleFaceBinder, ISaveableContent } from './common'; import { IMapStore } from './map'; +import { ITileStore } from './store'; export interface IStateSaveData { /** 跟随者列表 */ @@ -14,10 +15,8 @@ export interface IStateBase { readonly roleFace: IRoleFaceBinder; /** 朝向管理 */ readonly faceManager: IFaceManager; - /** id 到图块数字的映射 */ - readonly idNumberMap: Map; - /** 图块数字到 id 的映射 */ - readonly numberIdMap: Map; + /** 图块定义存储 */ + readonly tileStore: ITileStore; /** 地图状态 */ readonly maps: IMapStore; diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 970ef08..35e11cc 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -1,12 +1,8 @@ import { ICoreState, ISaveableExecutor } from './types'; import { - DamageSystem, - EnemyContext, EnemyManager, HeroMover, - IEnemyContext, IEnemyManager, - MapDamage, HeroAttribute, HeroState, IHeroState, @@ -27,7 +23,9 @@ import { FaceManager, InternalFaceGroup, Dir4FaceHandler, - Dir8FaceHandler + Dir8FaceHandler, + ITileStore, + TileStore } from '@user/data-base'; import { CommonAuraConverter, @@ -52,17 +50,23 @@ import { TILE_WIDTH } from './shared'; import { IHeroAttr } from './hero'; +import { LegacyTileData, TileLegacyBridge } from './legacy'; import { ILoadProgressTotal, LoadProgressTotal } from '@motajs/loader'; import { isNil } from 'lodash-es'; import { logger } from '@motajs/common'; import { ISaveSystem, SaveSystem } from './save'; +import { + DamageSystem, + EnemyContext, + IEnemyContext, + MapDamage +} from '@user/data-system'; export class CoreState implements ICoreState { // 全局内容 readonly roleFace: IRoleFaceBinder; readonly faceManager: IFaceManager; - readonly idNumberMap: Map; - readonly numberIdMap: Map; + readonly tileStore: ITileStore; // 可存档内容 readonly maps: IMapStore; @@ -88,8 +92,9 @@ export class CoreState implements ICoreState { constructor() { this.maps = new MapStore(); - this.idNumberMap = new Map(); - this.numberIdMap = new Map(); + const tileStore = new TileStore(); + tileStore.attachLegacyConverter(new TileLegacyBridge()); + this.tileStore = tileStore; this.loadProgress = new LoadProgressTotal(); this.dataLoader = new MotaDataLoader(this.loadProgress); @@ -118,7 +123,7 @@ export class CoreState implements ICoreState { registerSpecials(enemyManager); this.enemyManager = enemyManager; // 怪物上下文初始化 - const enemyContext = new EnemyContext(); + const enemyContext = new EnemyContext(this); const damageSystem = new DamageSystem(enemyContext); const mapDamage = new MapDamage(enemyContext); damageSystem.useCalculator(new MainDamageCalculator()); @@ -170,6 +175,7 @@ export class CoreState implements ICoreState { // 加载先使用兼容层实现 loading.once('loaded', () => { + this.initTileStore(core.maps.blocksInfo); this.initEnemyManager(enemys_fcae963b_31c9_42b4_b48c_bb48d09f3f80); this.initMapStore( core.floorIds, @@ -185,6 +191,37 @@ export class CoreState implements ICoreState { //#endregion } + /** + * 初始化图块存储对象 + * @param data 旧样板图块定义对象 + */ + private initTileStore(data: typeof core.maps.blocksInfo) { + const entries = Object.entries(data); + for (const [key, block] of entries) { + this.tileStore.fromLegacy(Number(key), block); + } + + for (const [key, block] of entries) { + if (!block.faceIds) continue; + const { down, up, left, right } = block.faceIds; + const downNum = this.tileStore.idToNumber(down); + if (downNum !== Number(key)) continue; + const upNum = this.tileStore.idToNumber(up); + const leftNum = this.tileStore.idToNumber(left); + const rightNum = this.tileStore.idToNumber(right); + this.roleFace.malloc(downNum, FaceDirection.Down); + if (!isNil(upNum)) { + this.roleFace.bind(upNum, downNum, FaceDirection.Up); + } + if (!isNil(leftNum)) { + this.roleFace.bind(leftNum, downNum, FaceDirection.Left); + } + if (!isNil(rightNum)) { + this.roleFace.bind(rightNum, downNum, FaceDirection.Right); + } + } + } + /** * 初始化怪物管理器对象 * @param data 旧样板怪物存储对象 @@ -194,15 +231,15 @@ export class CoreState implements ICoreState { const manager = this.enemyManager; const reference = new Map>(); for (const [id, enemy] of Object.entries(structuredClone(data))) { - const num = this.idNumberMap.get(id); + const num = this.tileStore.idToNumber(id); if (isNil(num)) continue; if (enemy.faceIds) { // 有 faceId 的要把其他的也映射到当前怪物 const { left, up, right, down } = enemy.faceIds; - const leftCode = this.idNumberMap.get(left)!; - const upCode = this.idNumberMap.get(up)!; - const rightCode = this.idNumberMap.get(right)!; - const downCode = this.idNumberMap.get(down)!; + const leftCode = this.tileStore.idToNumber(left)!; + const upCode = this.tileStore.idToNumber(up)!; + const rightCode = this.tileStore.idToNumber(right)!; + const downCode = this.tileStore.idToNumber(down)!; const prefab = manager.fromLegacyEnemy(downCode, enemy); reference.set(downCode, prefab); manager.addPrefab(prefab); diff --git a/packages-user/data-state/src/index.ts b/packages-user/data-state/src/index.ts index 2cdc90c..d459569 100644 --- a/packages-user/data-state/src/index.ts +++ b/packages-user/data-state/src/index.ts @@ -1,47 +1,4 @@ -import { FaceDirection, loading } from '@user/data-base'; -import { isNil } from 'lodash-es'; -import { ICoreState } from './types'; -import { state } from './ins'; - -function createCoreState(state: ICoreState) { - //#region 图块部分 - - const data = Object.entries(core.maps.blocksInfo); - for (const [key, block] of data) { - const num = Number(key); - state.idNumberMap.set(block.id, num); - state.numberIdMap.set(num, block.id); - } - - for (const [key, block] of data) { - if (!block.faceIds) continue; - const { down, up, left, right } = block.faceIds; - const downNum = state.idNumberMap.get(down); - if (downNum !== Number(key)) continue; - const upNum = state.idNumberMap.get(up); - const leftNum = state.idNumberMap.get(left); - const rightNum = state.idNumberMap.get(right); - state.roleFace.malloc(downNum, FaceDirection.Down); - if (!isNil(upNum)) { - state.roleFace.bind(upNum, downNum, FaceDirection.Up); - } - if (!isNil(leftNum)) { - state.roleFace.bind(leftNum, downNum, FaceDirection.Left); - } - if (!isNil(rightNum)) { - state.roleFace.bind(rightNum, downNum, FaceDirection.Right); - } - } - - //#endregion -} - -export function create() { - loading.once('loaded', () => { - // 加载后初始化全局状态 - createCoreState(state); - }); -} +export function create() {} export * from './enemy'; export * from './hero'; diff --git a/packages-user/data-state/src/legacy/index.ts b/packages-user/data-state/src/legacy/index.ts index 2f2826e..9dd9b6e 100644 --- a/packages-user/data-state/src/legacy/index.ts +++ b/packages-user/data-state/src/legacy/index.ts @@ -4,4 +4,5 @@ export * from './hero'; export * from './interface'; export * from './item'; export * from './move'; +export * from './tile'; export * from './utils'; diff --git a/packages-user/data-state/src/legacy/tile.ts b/packages-user/data-state/src/legacy/tile.ts new file mode 100644 index 0000000..8694394 --- /dev/null +++ b/packages-user/data-state/src/legacy/tile.ts @@ -0,0 +1,39 @@ +import { ITileLegacyConverter, ITileRawData, TileType } from '@user/data-base'; + +export type LegacyTileData = MapDataOf; + +export class TileLegacyBridge implements ITileLegacyConverter { + fromLegacy(num: number, legacy: LegacyTileData): ITileRawData { + return { + num, + id: legacy.id, + trigger: -1, + type: this.getTileType(num, legacy) + }; + } + + private getTileType(num: number, legacy: LegacyTileData): TileType { + if (num === 0) return TileType.None; + switch (legacy.cls) { + case 'terrains': + return TileType.Terrain; + case 'autotile': + return TileType.Autotile; + case 'animates': + return TileType.Animate; + case 'items': + return TileType.Item; + case 'enemys': + case 'enemy48': + return TileType.Enemy; + case 'npcs': + case 'npc48': + return TileType.Npc; + // @ts-expect-error 动态类型声明导致的错误,忽略即可 + case 'tileset': + return TileType.Tileset; + default: + return TileType.Unknown; + } + } +} diff --git a/packages-user/legacy-plugin-data/src/fallback.ts b/packages-user/legacy-plugin-data/src/fallback.ts index 4cb8edf..8cd88eb 100644 --- a/packages-user/legacy-plugin-data/src/fallback.ts +++ b/packages-user/legacy-plugin-data/src/fallback.ts @@ -372,7 +372,7 @@ export function initFallback() { if (core.status.replay.speed === 24) { cb(); } else { - const num = state.idNumberMap.get(id)!; + const num = state.tileStore.idToNumber(id)!; const layer = state.maps.getLayerByAlias('event')!; layer.closeDoor(num, x, y).then(cb); diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 8fde405..731b04c 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -55,6 +55,7 @@ "53": "Expected serializable value set as enemy's default attribute.", "54": "Legacy '$1' API has been removed, consider using new APIs: '$2'.", "55": "Cannot load MapStore state: reference data (compareWith) has not been set.", + "56": "Cannot convert legacy tile data since no tile legacy converter is attached to TileStore.", "1201": "Floor-damage extension needs 'floor-binder' extension as dependency." }, "warn": { @@ -190,6 +191,8 @@ "130": "The given tile is not managed by this dynamic layer.", "131": "Event layer to set is not belong to current LayerState.", "132": "Trigger registry entry of $1 '$2' already exists, new factory will override old factory.", + "133": "TileStore.addTile: tile number $1 already exists (id: '$2'), old tile data will be overridden.", + "134": "TileStore.addTile: tile id '$1' already maps to number $2, old tile data will be overridden.", "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." } } From bf781c5ee85acfb0396e6776353bced0c5c3cea3 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 20:49:08 +0800 Subject: [PATCH 18/26] =?UTF-8?q?feat:=20=E9=9D=99=E6=80=81=E8=A7=A6?= =?UTF-8?q?=E5=8F=91=E5=99=A8=E5=AD=98=E5=82=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/map/tile-info.md | 283 +++++++++++++ .../data-base/src/map/dynamicLayer.ts | 58 ++- .../data-base/src/map/dynamicTile.ts | 6 + packages-user/data-base/src/map/layerState.ts | 9 +- packages-user/data-base/src/map/mapLayer.ts | 85 +++- packages-user/data-base/src/map/mapStore.ts | 375 +++++++++++------- packages-user/data-base/src/map/types.ts | 88 +++- packages-user/data-state/src/core.ts | 2 +- prompt.md | 9 + 9 files changed, 741 insertions(+), 174 deletions(-) create mode 100644 docs/dev/map/tile-info.md diff --git a/docs/dev/map/tile-info.md b/docs/dev/map/tile-info.md new file mode 100644 index 0000000..0f61c5d --- /dev/null +++ b/docs/dev/map/tile-info.md @@ -0,0 +1,283 @@ +# 需求综述 + +重新考虑之后,这一层需求更适合收敛成“图块数据”和“触发器数据”两套独立结构,而不是先抽象一层通用 `ITileInfo` 对象。 + +原因如下: + +1. `IMapLayer` 内部的 `Uint32Array` 主要服务于高频查询与渲染,本身就应该尽量纯粹; +2. 大多数格点只是墙壁、地板、空气,不含任何触发器,没有必要给每个格点额外挂一个信息对象; +3. 当前触发器系统在数据层真正需要的并不是 `ITrigger` 对象,而只是“该载体对应哪一种触发器类型”; +4. 动态图块是实例对象,天然适合作为触发器的运行时载体,触发器跟随动态图块移动也更自然; +5. 存档是否需要记录触发器,取决于“触发器是跟随地图状态定义,还是跟随图块定义”,这应当单独讨论,而不是先把对象模型写死。 + +因此,本文不再优先设计 `IWrappedTileInfo`、`ITileInfo`、`createTileInfo`、`bindTileInfo` 这一套通用信息接口,而改为先构建一套**以 `ITileStore` 默认值为主、地图稀疏覆盖为辅的触发器方案**: + +1. `ILayerState` 持有 `ITileStore` 引用,静态格点未主动设置时使用图块默认触发器类型; +2. `IMapLayer` 仅按坐标稀疏存储“手动覆盖值”,并提供 `revertTrigger` 恢复默认触发器; +3. 动态图块实例直接持有自己的触发器类型数字; +4. `ITrigger` 对象仍只存在于 Layer 2,在收集阶段按需实例化; +5. `setBlock` 与触发器解绑,不再通过 `keepInfo` 一类参数耦合两者。 + +--- + +# 接口设计与预期 + +## ILayerState.tileStore + +- `ILayerState.tileStore`:当前图层状态持有的图块定义 store 引用。 +- 预期频率:**低频到中频**。外部直接访问它的频率不会太高,但 `IMapLayer.getTriggerType` 等底层逻辑会稳定依赖它作为默认触发器来源。 +- 典型使用场景:静态格点没有手动设置触发器时,`IMapLayer` 先读取当前图块数字,再通过 `layerState.tileStore.getTrigger(num)` 获取默认触发器类型。 + +## IMapLayer.getTriggerType + +- `IMapLayer.getTriggerType(x, y)`:按坐标读取当前静态格点的“有效触发器类型”。若该点存在手动覆盖则返回覆盖值,否则回退到当前图块在 `ITileStore` 中的默认触发器类型。 +- 预期频率:**高频**。触发器收集时每次都需要先确认目标静态格点最终会暴露出哪一种触发器。 +- 典型使用场景:`ITriggerCollector.collect(x, y, layer)` 读取 `layer` 在 `(x, y)` 上的静态触发器类型。 +- 返回值建议:与 `ITileStore` 保持一致,越界或不存在触发器时统一返回 `-1`。 + +## IMapLayer.setTriggerType + +- `IMapLayer.setTriggerType(type, x, y)`:为指定静态格点写入手动覆盖的触发器类型数字。 +- 预期频率:**中频**。主要出现在地图初始化、编辑器写回、运行时脚本修改事件配置等场景。 +- 典型使用场景:给某一格配置战斗触发器;或显式将某个原本有默认触发器的图块覆盖为“无触发器”。 +- 语义建议:`setTriggerType` 只负责写覆盖值,不负责恢复默认值。若 `type = -1`,表示显式覆盖为“无触发器”;若要恢复为图块默认触发器,应调用 `revertTrigger`。 + +## IMapLayer.revertTrigger + +- `IMapLayer.revertTrigger(x, y)`:删除指定静态格点的手动触发器覆盖,使其重新回退到 `ITileStore` 的默认触发器类型。 +- 预期频率:**低频到中频**。主要出现在编辑器撤销覆盖、脚本恢复默认配置、动静态图块转换回写时。 +- 典型使用场景:某格点曾被脚本临时设置为其他触发器,演出结束后恢复为该图块原本的默认触发器。 + +## IDynamicTile.triggerType + +- `IDynamicTile.triggerType`:当前动态图块携带的触发器类型数字,`-1` 表示无触发器。 +- 预期频率:**中频**。收集器在读取某格所有动态图块时需要访问;运行时若有脚本操作某个动态图块事件,也可能直接读写。 +- 典型使用场景:某个 NPC 作为动态图块移动时,其战斗或对话触发器跟随该实例一起移动。 + +## IDynamicTile.setTriggerType + +- `IDynamicTile.setTriggerType(type)`:修改当前动态图块绑定的触发器类型。 +- 预期频率:**低频到中频**。通常只在创建动态图块、转换动静态图块、特殊脚本重配置时使用。 +- 典型使用场景:演出过程中把一个原本只是装饰的动态图块改成可交互单位。 + +## IDynamicLayer.transferToDynamic + +- `IDynamicLayer.transferToDynamic(x, y, keepTrigger?)`:把静态图块转换为动态图块,并按参数决定是否保留原先的触发器。 +- 预期频率:**中频**。每次把地图中的静态物件实例化为可移动对象时都会用到。 +- 典型使用场景:把地图上的 NPC 图块转成 `IDynamicTile`,并让对话或战斗触发器跟着它一起移动。 +- 语义建议:`keepTrigger` 默认值先定为 `true`。当 `keepTrigger = true` 时,将静态格点当前的有效触发器类型迁移到新建的动态图块;当 `keepTrigger = false` 时,新动态图块不保留原触发器,并且静态格点上的手动覆盖应一并清除。 + +## IDynamicLayer.transferToStatic + +- `IDynamicLayer.transferToStatic(tile, keepTrigger?)`:把动态图块还原为静态图块,并按参数决定是否把动态图块携带的触发器写回静态格点。 +- 预期频率:**中频**。会移动的图块在结束移动后重新落回地图时使用。 +- 典型使用场景:可推动箱子停止后重新固化为静态图块,同时决定是否保留它携带的触发器。 +- 语义建议:`keepTrigger` 默认值先定为 `true`。当 `keepTrigger = true` 时,将 `tile.triggerType` 写回目标静态格点;若写回值与该图块默认触发器一致,则应直接 `revertTrigger`,只在不一致时存入覆盖值。当 `keepTrigger = false` 时,不写回动态图块携带的触发器,静态格点自然回退到图块默认触发器。 + +## IDynamicLayer.transferToStaticIfSafe + +- `IDynamicLayer.transferToStaticIfSafe(tile, keepTrigger?)`:在满足安全回写条件时将动态图块还原为静态图块,并保持与 `transferToStatic` 一致的触发器迁移语义。 +- 预期频率:**中频**。用于需要先判断目标格点是否允许回写的动静态转换场景。 +- 典型使用场景:某个可移动物体尝试停回地图时,若目标格点安全则回写图块和触发器,否则保留动态状态。 +- 语义建议:为保持三组转换接口的对称性,`keepTrigger` 也应加入该接口,且默认值同样先定为 `true`。 + +## ITriggerCollector.collect + +- `ITriggerCollector.collect(x, y, layer)`:当前不再从 `getTileInfo` 中读取对象信息,而是分别读取静态格点与动态图块上的触发器类型数字,再按需实例化 `ITrigger`。 +- 预期频率:**中频**。玩家移动、交互判定、脚本触发等场景都会使用。 +- 典型使用场景: + 1. 读取 `layer.getTriggerType(x, y)`; + 2. 迭代 `layer.dynamicLayer.getDynamicTilesAt(x, y)`,读取每个 `tile.triggerType`; + 3. 将所有非 `-1` 的触发器类型交给 `ITriggerRegistry` 创建运行时 `ITrigger` 对象; + 4. 排序后组成 `ITriggerCollection`。 + +这里需要注意:**数据层不再存 `ITrigger` 对象,只存触发器类型数字;对象实例化延后到收集阶段完成。** 这样既保留了 Layer 2 的运行时灵活性,又降低了 Layer 1 的存储复杂度。 + +## 当前不再优先设计的接口 + +以下内容在这轮设计中不再作为主方案: + +1. `ITileInfo` / `IWrappedTileInfo` 一类通用格点信息对象; +2. `createTileInfo()` / `bindTileInfo()` 一类对象工厂接口; +3. `setBlock(block, x, y, keepInfo?)` 这类把图块写入与触发器保留策略绑在一起的接口。 + +这并不表示将来永远不会有通用格点附加信息,只是当前真实需求已经收敛到“触发器类型数字”,继续上抽象只会把接口设计得更重。 + +--- + +# 实现思路 + +## 1. 图块数组与触发器数据彻底分离 + +`IMapLayer` 内部继续保留 `Uint32Array` 作为图块数字的权威存储,仅服务于: + +1. 高频 `getBlock` 查询; +2. 区域拷贝与渲染; +3. 与现有 `openDoor`、`closeDoor`、`putMapData`、`setMapRef` 等图块相关操作配合。 + +触发器数据则不再混入图块数组逻辑中,而是作为独立结构维护。 + +## 2. 静态图层使用“默认值 + 稀疏覆盖” + +静态图层不应自行持有整份默认触发器表,而应通过 `ILayerState.tileStore` 获取默认值,只在地图侧额外存储“手动覆盖值”。 + +当前建议结构如下: + +```ts +Map; +``` + +- key = `y * width + x` 形式的格点下标; +- value = 手动覆盖的触发器类型数字。 + +`IMapLayer.getTriggerType(x, y)` 的读取顺序建议为: + +1. 若坐标越界,返回 `-1`; +2. 若该点存在手动覆盖,直接返回覆盖值; +3. 否则读取当前图块数字,并通过 `tileStore.getTrigger(num)` 返回默认触发器类型。 + +这样可以自然满足“仅存必要”的目标: + +1. 没有手动修改过触发器的格点不占额外存储; +2. 大多数格点直接复用 `ITileStore` 中的默认定义,不需要在地图层重复抄一份; +3. 只有真正偏离默认值的点,才进入地图侧稀疏映射; +4. `revertTrigger` 只需删除覆盖记录即可恢复默认。 + +## 3. 动态图块直接携带触发器类型 + +动态图块已经是实例对象,因此不需要再为它额外建一层稀疏映射。更自然的方案是: + +1. `DynamicTile` 内部直接保存 `triggerType: number`; +2. 图块移动时,触发器天然跟随这个实例走; +3. 收集器按坐标枚举动态图块后,直接读取其 `triggerType`。 + +这样“触发器跟着动态图块走”就不再需要额外维护坐标索引迁移,只要图块对象本身移动即可。 + +## 4. 动静态转换只负责迁移或丢弃触发器 + +因为静态格点与动态图块现在是两个不同的触发器载体,所以 `transferToDynamic` / `transferToStatic` / `transferToStaticIfSafe` 的核心职责也更清晰了: + +1. `transferToDynamic(..., keepTrigger = true)`:把静态格点上的触发器迁到新动态图块; +2. `transferToDynamic(..., keepTrigger = false)`:只转换图块,不保留原触发器,并清理静态格点上的手动覆盖; +3. `transferToStatic(..., keepTrigger = true)`:把动态图块携带的触发器写回静态格点;若与默认值一致则回退默认,否则记为手动覆盖; +4. `transferToStatic(..., keepTrigger = false)`:只还原图块,不回写动态图块触发器,让静态格点自然回退到图块默认触发器; +5. `transferToStaticIfSafe(..., keepTrigger = true)`:在安全回写条件满足时,保持与 `transferToStatic` 一致的迁移语义。 + +这比把“是否保留触发器”揉进 `setBlock` 更符合职责边界,因为真正发生触发器载体切换的地方只有这些转换接口。 + +## 5. 图块写接口不再隐式影响触发器 + +既然图块数组与触发器数据已经拆开,则以下接口默认不应直接修改触发器: + +1. `setBlock` +2. `putMapData` +3. `setMapRef` +4. `openDoor` +5. `closeDoor` + +这样做的好处是: + +1. 图块外观变化与逻辑触发变化彻底解耦; +2. 不再需要 `keepInfo` / `keepTrigger` 之类参数污染高频图块写路径; +3. 调用方若确实希望同步改动触发器,应显式调用 `setTriggerType` 或走动静态转换接口。 + +这里唯一需要特殊处理的是 `resize` / `resize2`:当地图缩小时,越界格点对应的稀疏触发器记录必须一起裁剪。 + +## 6. 触发器对象延后到 Layer 2 实例化 + +当前触发器接口仍然可以保留 `ITrigger` 对象模型,但这个对象不应该提前存进地图数据层。 + +更合理的职责划分是: + +1. Layer 1 只存 `triggerType: number`; +2. `ITriggerCollector` 在收集时根据 `triggerType` 向 `ITriggerRegistry` 要工厂; +3. 再由工厂创建运行时 `ITrigger` 对象并执行后续排序、触发流程。 + +这样既满足“地图上只存一个触发器类型数字即可”的诉求,也不需要推翻当前 Layer 2 的触发器执行模型。 + +## 7. 当前存档边界 + +静态格点的触发器来源当前已经明确为“图块默认值 + 地图手动覆盖值”两层结构,因此存档边界也可以先做阶段性收敛: + +1. 图块默认触发器由 `ITileStore` 提供,不需要在地图层重复存储; +2. 若静态格点的手动覆盖值需要进入存档,那么只需要保存地图侧的稀疏覆盖映射,而不需要保存整份默认触发器表; +3. 动态图块的存储方案目前尚未设计完成,因此其 `triggerType` 是否进入存档、读档后如何恢复,暂不在本轮接口设计中拍死。 + +因此,这一节当前只确认静态覆盖的存储边界;动态图块相关存档语义后续再单独设计。 + +## 8. 单个载体当前只存一个触发器类型 + +本轮设计中,每个静态格点与每个动态图块都只保存一个 `triggerType: number`。 + +这样做的原因是: + +1. 当前触发器本身不接受用户自定义参数,地图侧没有必要提前背负对象列表; +2. 对绝大多数格点而言,一个触发器类型已经足够; +3. 同一点多触发器仍可通过“静态格点 1 个 + 多个动态图块各 1 个”的方式聚合。 + +当前这条限制已经足够。以现有触发器定位来看,一个触发器类型只是告诉系统“这次行为该走哪种处理分支”;更复杂的行为应当放到自定义事件等更高自由度的描述层中,而不是在单个图块上堆叠多个触发器类型。 + +--- + +# 涉及文件 + +## 需要引用的文件 + +- `@user/data-base/src/map/types.ts`:当前 `ILayerState`、`IMapLayer`、`IDynamicLayer`、`IDynamicTile` 的权威接口定义 +- `@user/data-base/src/store/types.ts`:`ITileStore` 的权威接口定义 +- `@user/data-base/src/map/mapLayer.ts`:静态图层当前的图块数组实现 +- `@user/data-base/src/map/dynamicLayer.ts`:动静态图块转换逻辑的当前实现 +- `@user/data-base/src/map/dynamicTile.ts`:动态图块实例对象,适合新增 `triggerType` +- `docs/dev/map/trigger.md`:当前触发器文档仍假定从 `getTileInfo` 读取信息,后续需要同步调整 + +## 需要修改的文件 + +### `@user/data-base/src/map/types.ts` + +- [ ] 不再新增 `ITileInfo` / `IWrappedTileInfo` 作为本轮主接口 +- [ ] 为 `ILayerState` 新增 `readonly tileStore: ITileStore` +- [ ] 为 `IMapLayer` 新增 `getTriggerType(x, y): number` +- [ ] 为 `IMapLayer` 新增 `setTriggerType(type: number, x: number, y: number): void` +- [ ] 为 `IMapLayer` 新增 `revertTrigger(x: number, y: number): void` +- [ ] 为 `IDynamicTile` 新增 `readonly triggerType: number` +- [ ] 为 `IDynamicTile` 新增 `setTriggerType(type: number): void` +- [ ] 修改 `IDynamicLayer.transferToDynamic`:新增 `keepTrigger?: boolean` +- [ ] 修改 `IDynamicLayer.transferToStatic`:新增 `keepTrigger?: boolean` +- [ ] 修改 `IDynamicLayer.transferToStaticIfSafe`:新增 `keepTrigger?: boolean` + +### `@user/data-base/src/map/mapLayer.ts` + +- [ ] 新增静态手动覆盖触发器类型的稀疏存储结构 +- [ ] 实现 `getTriggerType` / `setTriggerType` / `revertTrigger` +- [ ] 保持 `setBlock`、`putMapData`、`setMapRef`、`openDoor`、`closeDoor` 与触发器逻辑解耦 +- [ ] 在 `resize` / `resize2` 中裁剪越界触发器记录 + +### `@user/data-base/src/map/dynamicTile.ts` + +- [ ] 新增 `triggerType` 成员与对应写接口 + +### `@user/data-base/src/map/dynamicLayer.ts` + +- [ ] 在 `transferToDynamic` 中实现静态格点与动态图块之间的触发器迁移或丢弃逻辑 +- [ ] 在 `transferToStatic` 中实现动态图块与静态格点之间的触发器迁移或丢弃逻辑 +- [ ] 若保留 `transferToStaticIfSafe` 的对称性,同步补齐其触发器迁移逻辑 + +### `@user/data-base/src/map/mapStore.ts` + +- [ ] 若静态手动覆盖需要进入存档,仅保存地图侧稀疏覆盖映射 +- [ ] 动态图块触发器字段的存档逻辑待动态图块存储方案定稿后再补齐 + +### `docs/dev/map/trigger.md` + +- [ ] 将 `collect` 过程从“读取 `getTileInfo` 中的对象信息”改为“读取静态与动态载体上的触发器类型数字,再按需实例化 `ITrigger`” + +--- + +# 当前结论 + +1. 静态格点触发器来源采用“`ITileStore` 默认值 + 地图手动覆盖值”两层结构,`revertTrigger` 用于恢复默认值。 +2. `getTriggerType(x, y)` 与 `ITileStore.getTrigger(num)` 对齐,越界或不存在触发器时统一返回 `-1`。 +3. `transferToDynamic`、`transferToStatic`、`transferToStaticIfSafe` 的 `keepTrigger` 默认值暂定为 `true`。 +4. 静态图层只稀疏存储手动覆盖值,不重复保存整份默认触发器表。 +5. 动态图块触发器的存档语义暂不拍死,待动态图块存储方案单独定稿后再处理。 +6. 单个载体只保存一个 `triggerType` 当前已经足够,复杂行为应交由自定义事件等更高层描述。 diff --git a/packages-user/data-base/src/map/dynamicLayer.ts b/packages-user/data-base/src/map/dynamicLayer.ts index 31a4026..20aac90 100644 --- a/packages-user/data-base/src/map/dynamicLayer.ts +++ b/packages-user/data-base/src/map/dynamicLayer.ts @@ -36,22 +36,42 @@ export class DynamicLayer createDynamic(num: number, x: number, y: number): IDynamicTile { const tile = new DynamicTile(num, x, y, this); + tile.setTriggerType(this.layer.getTriggerType(x, y)); this.addTileToPosMap(tile, x, y); this.posTileMap.set(tile, { x, y }); this.forEachHook(hook => hook.onCreateTile?.(tile, this)); return tile; } - transferToDynamic(x: number, y: number): IDynamicTile { + transferToDynamic( + x: number, + y: number, + keepTrigger: boolean = true + ): IDynamicTile { const num = this.layer.getBlock(x, y); + const triggerType = keepTrigger ? this.layer.getTriggerType(x, y) : -1; if (num === 0) { logger.warn(127, x.toString(), y.toString()); } this.layer.setBlock(0, x, y); - return this.createDynamic(num, x, y); + this.layer.revertTrigger(x, y); + const tile = this.createDynamic(num, x, y); + tile.setTriggerType(triggerType); + return tile; } - transferToStatic(tile: IDynamicTile): void { + /** + * 将动态图块上的触发器同步回当前静态格点 + */ + private syncStaticTrigger(tile: IDynamicTile, keepTrigger: boolean): void { + if (keepTrigger) { + this.layer.setTriggerType(tile.triggerType, tile.x, tile.y); + } else { + this.layer.revertTrigger(tile.x, tile.y); + } + } + + transferToStatic(tile: IDynamicTile, keepTrigger: boolean = true): void { const { x, y } = tile; const { width, height } = this.layer; if (x < 0 || y < 0 || x >= width || y >= height) { @@ -62,16 +82,26 @@ export class DynamicLayer logger.warn(129, x.toString(), y.toString()); } this.layer.setBlock(tile.num, x, y); + this.syncStaticTrigger(tile, keepTrigger); this.removeTile(tile); - this.forEachHook(hook => { - void hook.onDeleteTile?.(tile, this); - }); + this.forEachHook(hook => hook.onDeleteTile?.(tile, this)); } - transferToStaticIfSafe(tile: IDynamicTile): boolean { + transferToStaticIfSafe( + tile: IDynamicTile, + keepTrigger: boolean = true + ): boolean { + const { x, y } = tile; + const { width, height } = this.layer; + if (x < 0 || y < 0 || x >= width || y >= height) { + logger.warn(128, x.toString(), y.toString()); + return false; + } if (this.layer.getBlock(tile.x, tile.y) !== 0) return false; - this.layer.setBlock(tile.num, tile.x, tile.y); - this.deleteDynamic(tile); + this.layer.setBlock(tile.num, x, y); + this.syncStaticTrigger(tile, keepTrigger); + this.removeTile(tile); + this.forEachHook(hook => hook.onDeleteTile?.(tile, this)); return true; } @@ -117,12 +147,18 @@ export class DynamicLayer this.forEachHook(hook => hook.onUpdateTilePosition?.(tile, this)); } + /** + * 将动态图块登记到指定坐标的索引表中 + */ private addTileToPosMap(tile: IDynamicTile, x: number, y: number): void { const xMap = this.tilePosMap.getOrInsertComputed(y, () => new Map()); const set = xMap.getOrInsertComputed(x, () => new Set()); set.add(tile); } + /** + * 将动态图块从指定坐标的索引表中移除 + */ private removeTileFromPosMap( tile: IDynamicTile, x: number, @@ -131,7 +167,9 @@ export class DynamicLayer this.tilePosMap.get(y)?.get(x)?.delete(tile); } - /** 从两个内部映射中移除图块记录 */ + /** + * 从两个内部映射中移除图块记录 + */ private removeTile(tile: IDynamicTile): void { const pos = this.posTileMap.get(tile); if (pos) { diff --git a/packages-user/data-base/src/map/dynamicTile.ts b/packages-user/data-base/src/map/dynamicTile.ts index f4702ed..2eff581 100644 --- a/packages-user/data-base/src/map/dynamicTile.ts +++ b/packages-user/data-base/src/map/dynamicTile.ts @@ -10,6 +10,7 @@ import { DynamicTileMover } from './mover'; export class DynamicTile implements IDynamicTile { readonly mover: IObjectMover; + triggerType: number; /** 当前的朝向绑定对象 */ private face: IRoleFaceBinder | null = null; @@ -21,6 +22,7 @@ export class DynamicTile implements IDynamicTile { public readonly layer: IDynamicLayer ) { this.mover = new DynamicTileMover(this); + this.triggerType = -1; } setFaceBinder(binder: IRoleFaceBinder | null): void { @@ -36,6 +38,10 @@ export class DynamicTile implements IDynamicTile { return this.num; } + setTriggerType(type: number): void { + this.triggerType = type; + } + delete(): Promise { return this.layer.deleteDynamic(this); } diff --git a/packages-user/data-base/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts index 2e1e345..21f5a87 100644 --- a/packages-user/data-base/src/map/layerState.ts +++ b/packages-user/data-base/src/map/layerState.ts @@ -11,6 +11,7 @@ import { IMapLayerHookController, IMapLayerHooks } from './types'; +import { ITileStore } from '../store'; import { MapLayer } from './mapLayer'; export class LayerState @@ -38,6 +39,7 @@ export class LayerState private dirty: boolean = false; constructor( + public readonly tileStore: ITileStore, public width: number, public height: number ) { @@ -46,7 +48,12 @@ export class LayerState addLayer(): IMapLayer { const array = new Uint32Array(this.width * this.height); - const layer = new MapLayer(array, this.width, this.height); + const layer = new MapLayer( + array, + this.width, + this.height, + this.tileStore + ); this.layerList.add(layer); this.mapLayerList.add(layer); this.forEachHook(hook => { diff --git a/packages-user/data-base/src/map/mapLayer.ts b/packages-user/data-base/src/map/mapLayer.ts index 372d468..061cd39 100644 --- a/packages-user/data-base/src/map/mapLayer.ts +++ b/packages-user/data-base/src/map/mapLayer.ts @@ -8,6 +8,7 @@ import { } from './types'; import { Hookable, HookController, logger } from '@motajs/common'; import { DynamicLayer } from './dynamicLayer'; +import { ITileStore } from '../store'; // todo: 提供 core.setBlock 等方法的替代方法,同时添加 setBlockList,以及前景背景的接口 @@ -24,10 +25,17 @@ export class MapLayer private mapArray: Uint32Array; /** 地图数据引用 */ private mapData: IMapLayerData; + /** 手动触发器覆盖映射,key = y * width + x */ + private triggerMap: Map = new Map(); readonly dynamicLayer: IDynamicLayer; - constructor(array: Uint32Array, width: number, height: number) { + constructor( + array: Uint32Array, + width: number, + height: number, + private readonly tileStore: ITileStore + ) { super(); this.width = width; this.height = height; @@ -42,6 +50,25 @@ export class MapLayer this.dynamicLayer = new DynamicLayer(this); } + /** + * 在地图尺寸变化后重新映射手动触发器覆盖表 + */ + private remapTriggerMap( + beforeWidth: number, + width: number, + height: number + ): Map { + const next = new Map(); + for (const [index, type] of this.triggerMap) { + const x = index % beforeWidth; + const y = Math.floor(index / beforeWidth); + if (x < width && y < height) { + next.set(y * width + x, type); + } + } + return next; + } + resize(width: number, height: number): void { if (this.width === width && this.height === height) { return; @@ -55,6 +82,7 @@ export class MapLayer this.height = height; const area = width * height; const newArray = new Uint32Array(area); + this.triggerMap = this.remapTriggerMap(beforeWidth, width, height); this.mapArray = newArray; // 将原来的地图数组赋值给现在的 if (beforeArea > area) { @@ -84,13 +112,16 @@ export class MapLayer resize2(width: number, height: number): void { if (this.width === width && this.height === height) { + this.empty = true; this.mapArray.fill(0); + this.triggerMap.clear(); return; } this.mapData.expired = true; this.width = width; this.height = height; this.mapArray = new Uint32Array(width * height); + this.triggerMap.clear(); this.mapData = { expired: false, array: this.mapArray @@ -121,6 +152,39 @@ export class MapLayer return this.mapArray[y * this.width + x]; } + getTriggerType(x: number, y: number): number { + if (x < 0 || y < 0 || x >= this.width || y >= this.height) { + return -1; + } + const index = y * this.width + x; + if (this.triggerMap.has(index)) { + return this.triggerMap.get(index)!; + } + return this.tileStore.getTrigger(this.mapArray[index]); + } + + setTriggerType(type: number, x: number, y: number): void { + if (x < 0 || y < 0 || x >= this.width || y >= this.height) { + return; + } + const index = y * this.width + x; + if (this.tileStore.getTrigger(this.mapArray[index]) === type) { + this.triggerMap.delete(index); + } else { + this.triggerMap.set(index, type); + } + } + + revertTrigger(x: number, y: number): void { + if (x >= 0 && y >= 0 && x < this.width && y < this.height) { + this.triggerMap.delete(y * this.width + x); + } + } + + clearTrigger(): void { + this.triggerMap.clear(); + } + putMapData(array: Uint32Array, x: number, y: number, width: number): void { if (array.length % width !== 0) { logger.warn(8); @@ -201,13 +265,6 @@ export class MapLayer return res; } - /** - * 获取地图数据的内部存储直接引用 - */ - getMapRef(): IMapLayerData { - return this.mapData; - } - setMapRef(array: Uint32Array): void { if (array.length !== this.width * this.height) { logger.warn( @@ -229,6 +286,18 @@ export class MapLayer }); } + getMapRef(): IMapLayerData { + return this.mapData; + } + + setTriggerRef(triggers: Map): void { + this.triggerMap = triggers; + } + + getTriggerRef(): ReadonlyMap { + return this.triggerMap; + } + protected createController( hook: Partial ): IMapLayerHookController { diff --git a/packages-user/data-base/src/map/mapStore.ts b/packages-user/data-base/src/map/mapStore.ts index d72fc72..7095da2 100644 --- a/packages-user/data-base/src/map/mapStore.ts +++ b/packages-user/data-base/src/map/mapStore.ts @@ -1,5 +1,6 @@ import { logger } from '@motajs/common'; import { SaveCompression } from '../common'; +import { ITileStore } from '../store'; import { ILayerState, ILayerStateSave, @@ -31,6 +32,8 @@ export class MapStore implements IMapStore { /** 自动分区激活器开关 */ private autoActivitorEnabled: boolean = false; + constructor(private readonly tileStore: ITileStore) {} + //#region 楼层管理 createLayerState(id: string, width: number, height: number): ILayerState { @@ -39,7 +42,7 @@ export class MapStore implements IMapStore { } else { this.maps.push(id); } - const state = new LayerState(width, height); + const state = new LayerState(this.tileStore, width, height); // 若 refData 已存在,新楼层直接视为全脏 if (this.refData !== null) { state.setDirty(true); @@ -117,6 +120,10 @@ export class MapStore implements IMapStore { this.lastFloorId = id; } + /** + * 根据 maps 下标查找其所属的分区 + * @param idx 楼层在 maps 中的下标 + */ private findAreaByIndex(idx: number): MapArea | null { for (const area of this.areaList) { for (const interval of area) { @@ -128,6 +135,11 @@ export class MapStore implements IMapStore { return null; } + /** + * 批量设置一个分区内所有楼层的激活状态 + * @param area 目标分区 + * @param active 要设置的激活状态 + */ private setAreaActive(area: MapArea, active: boolean): void { for (const interval of area) { for (let i = interval.start; i <= interval.end; i++) { @@ -169,7 +181,7 @@ export class MapStore implements IMapStore { //#endregion - //#region 存档及压缩 + //#region 存档工具 compareWith(ref: Map>): void { if (this.refData !== null) return; @@ -202,6 +214,116 @@ export class MapStore implements IMapStore { } } + /** + * 提取楼层内所有图层的静态触发器覆盖映射 + * @param state 目标楼层状态 + */ + private getTriggerMap(state: ILayerState) { + const triggers = new Map>(); + for (const layer of state.layerList) { + const map = layer.getTriggerRef(); + if (map.size > 0) { + triggers.set(layer.zIndex, new Map(map)); + } + } + return triggers; + } + + /** + * 构造仅包含背景和静态触发器的空楼层存档 + * @param state 目标楼层状态 + */ + private emptySave(state: ILayerState): ILayerStateSave { + return { + background: state.getBackground(), + layers: new Map(), + triggers: this.getTriggerMap(state) + }; + } + + /** + * 将单个图层序列化为完整地图存档 + * @param layer 目标图层 + */ + private fullLayer(layer: IMapLayer): IMapLayerSave { + return { + width: layer.width, + height: layer.height, + fullMap: new Uint32Array(layer.getMapRef().array) + }; + } + + /** + * 将楼层所有图层全量序列化(NoCompression / LowCompression 用) + * @param state 目标楼层状态 + */ + private saveLayerStateFull(state: LayerState): ILayerStateSave { + const background = state.getBackground(); + const layers = new Map(); + const triggers = new Map>(); + for (const layer of state.layerList) { + const arr = layer.getMapRef().array; + layers.set(layer.zIndex, { + width: layer.width, + height: layer.height, + fullMap: new Uint32Array(arr) + }); + triggers.set(layer.zIndex, new Map(layer.getTriggerRef())); + } + return { background, layers, triggers }; + } + + /** + * 仅返回与参考基准不同的行(HighCompression 用) + * @param layer 目标图层 + * @param refArray 该图层对应的参考地图数据 + */ + private diffRows( + layer: IMapLayer, + refArray: Uint32Array + ): Map { + const rows = new Map(); + const arr = layer.getMapRef().array; + + for (let row = 0; row < layer.height; row++) { + const start = row * layer.width; + const end = start + layer.width; + const slice = arr.subarray(start, end); + const refSlice = refArray.subarray(start, end); + const same = refSlice.every((v, i) => slice[i] === v); + if (!same) { + rows.set(row, new Uint32Array(slice)); + } + } + + return rows; + } + + /** + * 判断楼层所有图层是否与参考基准完全一致(LowCompression 去误判用) + * @param id 楼层 id + * @param state 目标楼层状态 + */ + private isStateEqualToRef(id: string, state: LayerState): boolean { + const refFloor = this.refData?.get(id); + if (!refFloor) return false; + for (const layer of state.layerList) { + const refArray = refFloor.get(layer.zIndex); + if (!refArray) return false; + const cur = layer.getMapRef().array; + if (cur.length !== refArray.length) return false; + if (cur.some((v, i) => v !== refArray[i])) return false; + } + return true; + } + + //#endregion + + //#region 存档 + + /** + * 以无压缩方式序列化所有激活楼层 + */ private saveNoCompression(): IMapStoreSave { const floors = new Map(); for (const [id, state] of this.mapData) { @@ -211,77 +333,119 @@ export class MapStore implements IMapStore { return { floors }; } + /** + * 以低压缩方式序列化所有激活楼层 + */ private saveLowCompression(): IMapStoreSave { const floors = new Map(); - for (const [id, state] of this.mapData) { - if (!state.active) continue; - // 非 dirty 或 dirty 但与参考基准完全一致 → 空 layers(读档时从参考基准恢复) - if ( - !state.isDirty() || - (this.refData && this.isStateEqualToRef(id, state)) - ) { - floors.set(id, { - background: state.getBackground(), - layers: new Map() - }); - } else { - floors.set(id, this.saveLayerStateFull(state)); + if (this.refData) { + // 包含参考标准时需要对比 + for (const [id, state] of this.mapData) { + if (!state.active) continue; + if (state.isDirty() && this.isStateEqualToRef(id, state)) { + floors.set(id, this.saveLayerStateFull(state)); + } else { + floors.set(id, this.emptySave(state)); + } } - } - return { floors }; - } - - private saveHighCompression(): IMapStoreSave { - const floors = new Map(); - for (const [id, state] of this.mapData) { - if (!state.active) continue; - if (!state.isDirty()) { - floors.set(id, { - background: state.getBackground(), - layers: new Map() - }); - continue; + } else { + // 不包含参考标准时仅看 dirty 标记 + for (const [id, state] of this.mapData) { + if (!state.active) continue; + if (state.isDirty()) { + floors.set(id, this.saveLayerStateFull(state)); + } else { + floors.set(id, this.emptySave(state)); + } } - const refFloor = this.refData?.get(id); - const layersMap = new Map(); - for (const layer of state.layerList) { - const refArray = refFloor?.get(layer.zIndex); - const rows = this.diffRows(layer, refArray); - if (rows.size === 0 && refArray) continue; // 与参考完全一致 - layersMap.set(layer.zIndex, { - width: layer.width, - height: layer.height, - rows - }); - } - floors.set(id, { - background: state.getBackground(), - layers: layersMap - }); } return { floors }; } + /** + * 以高压缩方式序列化所有激活楼层 + */ + private saveHighCompression(): IMapStoreSave { + const floors = new Map(); + // 没有参考标准,直接退回低压缩级别 + if (!this.refData) return this.saveLowCompression(); + + for (const [id, state] of this.mapData) { + if (!state.active) continue; + if (state.isDirty()) { + const refFloor = this.refData.get(id); + const layersMap = new Map(); + // 对每一个地图的每一行进行遍历,然后仅存储有差别的行 + for (const layer of state.layerList) { + const refArray = refFloor?.get(layer.zIndex); + if (refArray) { + const rows = this.diffRows(layer, refArray); + if (rows.size === 0) continue; + layersMap.set(layer.zIndex, { + width: layer.width, + height: layer.height, + rows + }); + } else { + layersMap.set(layer.zIndex, this.fullLayer(layer)); + } + } + floors.set(id, { + background: state.getBackground(), + layers: layersMap, + triggers: this.getTriggerMap(state) + }); + } else { + floors.set(id, this.emptySave(state)); + } + } + + return { floors }; + } + + /** + * 加载指定图层的触发器 + * @param save 楼层存档数据 + * @param layer 目标图层 + */ + private loadTriggers(save: ILayerStateSave, layer: IMapLayer) { + const triggers = save.triggers.get(layer.zIndex); + layer.clearTrigger(); + if (triggers) { + layer.setTriggerRef(new Map(triggers)); + } + } + /** * NoCompression 读档:每个图层均有 fullMap,直接转移所有权,无需参考基准。 + * @param state 整体地图存档数据 */ private loadNoCompression(state: IMapStoreSave): void { for (const [id, cur] of this.mapData) { cur.setActiveStatus(state.floors.has(id)); } - for (const [id, layerStateSave] of state.floors) { + for (const [id, save] of state.floors) { const cur = this.mapData.get(id); if (!cur) { logger.warn(122, id); continue; } - cur.setBackground(layerStateSave.background); + cur.setBackground(save.background); for (const layer of cur.layerList) { - const layerSave = layerStateSave.layers.get(layer.zIndex); - if (!layerSave?.fullMap) continue; - layer.setMapRef(new Uint32Array(layerSave.fullMap)); + // 地图 + const layerSave = save.layers.get(layer.zIndex); + if (layerSave?.fullMap) { + layer.setMapRef(new Uint32Array(layerSave.fullMap)); + } + // 触发器 + this.loadTriggers(save, layer); + } + // 需要额外进行判断是否与参考地图相同 + if (this.isStateEqualToRef(id, cur)) { + cur.setDirty(false); + } else { + cur.setDirty(true); } - cur.setDirty(false); } } @@ -289,6 +453,7 @@ export class MapStore implements IMapStore { * LowCompression 读档: * - layers 有数据(dirty 楼层)→ fullMap 直接转移所有权 * - layers 为空(非 dirty 楼层)→ 从参考基准恢复 + * @param state 整体地图存档数据 */ private loadLowCompression(state: IMapStoreSave): void { if (!this.refData) { @@ -298,7 +463,7 @@ export class MapStore implements IMapStore { for (const [id, cur] of this.mapData) { cur.setActiveStatus(state.floors.has(id)); } - for (const [id, layerStateSave] of state.floors) { + for (const [id, save] of state.floors) { const cur = this.mapData.get(id); const refFloor = this.refData.get(id); if (!cur) { @@ -309,21 +474,26 @@ export class MapStore implements IMapStore { logger.warn(124, id); continue; } - cur.setBackground(layerStateSave.background); + cur.setBackground(save.background); + let shouldDirty = false; for (const layer of cur.layerList) { - const layerSave = layerStateSave.layers.get(layer.zIndex); + // 地图 + const layerSave = save.layers.get(layer.zIndex); if (layerSave?.fullMap) { - layer.setMapRef(layerSave.fullMap); + layer.setMapRef(new Uint32Array(layerSave.fullMap)); + shouldDirty = true; } else { - const refArray = refFloor?.get(layer.zIndex); + const refArray = refFloor.get(layer.zIndex); if (!refArray) { logger.warn(124, id); return; } layer.setMapRef(new Uint32Array(refArray)); } + // 触发器 + this.loadTriggers(save, layer); } - cur.setDirty(false); + cur.setDirty(shouldDirty); } } @@ -331,6 +501,7 @@ export class MapStore implements IMapStore { * HighCompression 读档: * - layers 有数据(dirty 楼层)→ 以参考基准为底,叠加差分行 * - layers 为空(非 dirty 楼层)或图层无变化(rows 缺失)→ 从参考基准恢复 + * @param state 整体地图存档数据 */ private loadHighCompression(state: IMapStoreSave): void { if (!this.refData) { @@ -340,7 +511,7 @@ export class MapStore implements IMapStore { for (const [id, cur] of this.mapData) { cur.setActiveStatus(state.floors.has(id)); } - for (const [id, layerStateSave] of state.floors) { + for (const [id, save] of state.floors) { const cur = this.mapData.get(id); const refFloor = this.refData.get(id); if (!cur) { @@ -351,34 +522,32 @@ export class MapStore implements IMapStore { logger.warn(124, id); continue; } - cur.setBackground(layerStateSave.background); - let isMapDirty = true; + cur.setBackground(save.background); + let shouldDirty = false; for (const layer of cur.layerList) { const refArray = refFloor.get(layer.zIndex); if (!refArray) { logger.warn(124, id); continue; } - const layerSave = layerStateSave.layers.get(layer.zIndex); + // 地图 + const layerSave = save.layers.get(layer.zIndex); if (!layerSave?.rows || layerSave.rows.size === 0) { // 图层无变化或非 dirty 楼层,从参考基准恢复 layer.setMapRef(new Uint32Array(refArray)); } else { // 以参考基准为底,叠加差分行 - isMapDirty = false; - const size = layer.width * layer.height; - const buf = new Uint32Array(size); - if (refArray) buf.set(refArray.subarray(0, size)); + shouldDirty = true; + const buf = new Uint32Array(refArray); for (const [rowIdx, rowData] of layerSave.rows) { - buf.set( - rowData.subarray(0, layer.width), - rowIdx * layer.width - ); + buf.set(rowData, rowIdx * layer.width); } layer.setMapRef(buf); } + // 触发器 + this.loadTriggers(save, layer); } - cur.setDirty(isMapDirty); + cur.setDirty(shouldDirty); } } @@ -402,71 +571,5 @@ export class MapStore implements IMapStore { } } - //#region 内部方法 - - /** - * 将楼层所有图层全量序列化(NoCompression / LowCompression 用) - */ - private saveLayerStateFull(state: LayerState): ILayerStateSave { - const layersMap = new Map(); - for (const layer of state.layerList) { - const arr = layer.getMapRef().array; - layersMap.set(layer.zIndex, { - width: layer.width, - height: layer.height, - fullMap: new Uint32Array(arr) - }); - } - return { background: state.getBackground(), layers: layersMap }; - } - - /** - * 仅返回与参考基准不同的行(HighCompression 用) - */ - private diffRows( - layer: IMapLayer, - refArray?: Uint32Array - ): Map { - const rows = new Map(); - const arr = layer.getMapRef().array; - if (refArray) { - for (let row = 0; row < layer.height; row++) { - const start = row * layer.width; - const end = start + layer.width; - const slice = arr.subarray(start, end); - const refSlice = refArray.subarray(start, end); - const same = refSlice.every((v, i) => slice[i] === v); - if (!same) { - rows.set(row, new Uint32Array(slice)); - } - } - } else { - for (let row = 0; row < layer.height; row++) { - const start = row * layer.width; - const end = start + layer.width; - rows.set(row, new Uint32Array(arr.subarray(start, end))); - } - } - return rows; - } - - /** - * 判断楼层所有图层是否与参考基准完全一致(LowCompression 去误判用) - */ - private isStateEqualToRef(id: string, state: LayerState): boolean { - const refFloor = this.refData?.get(id); - if (!refFloor) return false; - for (const layer of state.layerList) { - const refArray = refFloor.get(layer.zIndex); - if (!refArray) return false; - const cur = layer.getMapRef().array; - if (cur.length !== refArray.length) return false; - for (let i = 0; i < cur.length; i++) { - if (cur[i] !== refArray[i]) return false; - } - } - return true; - } - //#endregion } diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index 8e7d9b8..9d969e5 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -7,6 +7,7 @@ import { IRoleFaceBinder, ISaveableContent } from '../common'; +import { ITileStore } from '../store'; //#region 静态图层 @@ -103,6 +104,33 @@ export interface IMapLayer extends IHookable< */ getBlock(x: number, y: number): number; + /** + * 获取指定点的静态图块对应的有效触发器类型,若手动覆盖不存在则回退到图块默认触发器 + * @param x 图块横坐标 + * @param y 图块纵坐标 + */ + getTriggerType(x: number, y: number): number; + + /** + * 设置指定点静态图块的触发器 + * @param type 触发器类型 + * @param x 图块横坐标 + * @param y 图块纵坐标 + */ + setTriggerType(type: number, x: number, y: number): void; + + /** + * 删除指定点静态图块的触发器,回退为图块默认触发器 + * @param x 图块横坐标 + * @param y 图块纵坐标 + */ + revertTrigger(x: number, y: number): void; + + /** + * 清空地图上所有静态图块的手动设置的触发器,恢复为图块默认触发器 + */ + clearTrigger(): void; + /** * 设置地图图块 * @param array 地图图块数组 @@ -130,11 +158,31 @@ export interface IMapLayer extends IHookable< height: number ): Uint32Array; + /** + * 直接替换内部图块数组引用,跳过拷贝,高性能但风险较高。 + * 一般仅供 `MapStore` 读档时内部使用,外部正常情况下不应调用。 + * 调用方需确保传入数组的长度与 `width * height` 匹配, + * 且调用后不得再持有或修改传入的数组。 + * @param array 地图数组,会直接替换内部引用 + */ + setMapRef(array: Uint32Array): void; + /** * 获取整个地图的地图数组,是对内部数组的直接引用 */ getMapRef(): IMapLayerData; + /** + * 直接设置内部触发器映射对象,一般仅供内部存读档使用,外部正常情况下不应调用 + * @param triggers 触发器映射 + */ + setTriggerRef(triggers: Map): void; + + /** + * 获取静态触发器覆盖映射,一般仅供内部存档逻辑使用 + */ + getTriggerRef(): ReadonlyMap; + /** * 设置地图纵深,会影响渲染的遮挡顺序 * @param zIndex 纵深 @@ -155,15 +203,6 @@ export interface IMapLayer extends IHookable< * @param y 门纵坐标 */ closeDoor(num: number, x: number, y: number): Promise; - - /** - * 直接替换内部图块数组引用,跳过拷贝,高性能但风险较高。 - * 一般仅供 `MapStore` 读档时内部使用,外部正常情况下不应调用。 - * 调用方需确保传入数组的长度与 `width * height` 匹配, - * 且调用后不得再持有或修改传入的数组。 - * @param array 地图数组,会直接替换内部引用 - */ - setMapRef(array: Uint32Array): void; } //#endregion @@ -225,6 +264,8 @@ export interface ILayerStateHooks extends IHookBase { export interface ILayerState extends IHookable { /** 地图列表 */ readonly layerList: Set; + /** 当前楼层共享的图块定义 store */ + readonly tileStore: ITileStore; /** 此楼层是否处于激活状态 */ readonly active: boolean; /** 此楼层的地图宽度 */ @@ -316,7 +357,6 @@ export interface ILayerState extends IHookable { //#region 楼层管理 -/** 单个 MapLayer 的存档数据 */ export interface IMapLayerSave { readonly width: number; readonly height: number; @@ -332,27 +372,27 @@ export interface IMapLayerSave { readonly fullMap?: Uint32Array; } -/** 单个楼层的存档数据 */ export interface ILayerStateSave { + /** 楼层背景 */ readonly background: number; - /** key = zIndex,value = 对应图层存档数据 */ readonly layers: ReadonlyMap; + /** 静态触发器覆盖映射,仅在存在覆盖时写入 */ + readonly triggers: ReadonlyMap>; } -/** 整个 MapStore 的存档数据 */ export interface IMapStoreSave { /** key = 楼层 id,只包含 active 的楼层,inactive 的楼层不写入,读档时无需处理 */ readonly floors: ReadonlyMap; } -/** 单段闭区间 [start, end],start 和 end 均为 maps 下标 */ export interface IMapAreaInterval { + /** 区域起始索引,包含 */ readonly start: number; + /** 区域结束索引,包含 */ readonly end: number; } -/** 一个区域由一个或多个独立区间组成 */ export type MapArea = IMapAreaInterval[]; export interface IMapStore extends ISaveableContent { @@ -504,21 +544,25 @@ export interface IDynamicLayer extends IHookable { * @param y 纵坐标 * @returns 创建的动态图块引用 */ - transferToDynamic(x: number, y: number): IDynamicTile; + transferToDynamic( + x: number, + y: number, + keepTrigger?: boolean + ): IDynamicTile; /** * 将动态图块还原为静态图块。坐标越界则警告并放弃, * 否则写回静态图层并触发 {@link IDynamicLayerHooks.onDeleteTile} * @param tile 要还原的动态图块 */ - transferToStatic(tile: IDynamicTile): void; + transferToStatic(tile: IDynamicTile, keepTrigger?: boolean): void; /** * 仅当目标位置静态图块为 0(空白)时才还原为静态图块,否则不转换 * @param tile 要还原的动态图块 * @returns 是否转换成功 */ - transferToStaticIfSafe(tile: IDynamicTile): boolean; + transferToStaticIfSafe(tile: IDynamicTile, keepTrigger?: boolean): boolean; /** * 删除指定动态图块,触发 {@link IDynamicLayerHooks.onDeleteTile} 钩子。 @@ -557,6 +601,8 @@ export interface IDynamicLayer extends IHookable { export interface IDynamicTile extends IObjectMovable { /** 当前图块数字 */ readonly num: number; + /** 当前动态图块携带的触发器类型,-1 表示无触发器 */ + readonly triggerType: number; /** 当前图块所属的动态图层 */ readonly layer: IDynamicLayer; /** 当前动态图块的移动器 */ @@ -568,6 +614,12 @@ export interface IDynamicTile extends IObjectMovable { */ setFaceDirection(direction: FaceDirection): number; + /** + * 设置当前动态图块的触发器类型 + * @param type 触发器类型 + */ + setTriggerType(type: number): void; + /** * 直接删除此图块 */ diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 35e11cc..2145c69 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -91,10 +91,10 @@ export class CoreState implements ICoreState { > = new Map(); constructor() { - this.maps = new MapStore(); const tileStore = new TileStore(); tileStore.attachLegacyConverter(new TileLegacyBridge()); this.tileStore = tileStore; + this.maps = new MapStore(tileStore); this.loadProgress = new LoadProgressTotal(); this.dataLoader = new MotaDataLoader(this.loadProgress); diff --git a/prompt.md b/prompt.md index 3137c38..7a9b0dd 100644 --- a/prompt.md +++ b/prompt.md @@ -57,6 +57,15 @@ - `IObjectMover.speed()`:预期频率**中频**。移动中修改移速有一定使用场景,但远不及 `forward`、`step` 等移动接口的频率,通常只在特殊演出或逻辑中出现,故为中频。典型使用场景:NPC 逃离怪物时先定在原地,随后逐渐加速逃跑。 - `IObjectMover.stepFace()`:预期频率**低频**。移动方向与朝向不同的常见场景(后退)已由 `backward` 覆盖,只有极特殊情况才需要此接口(如角色朝向固定但沿垂直方向平移),相当罕见,故为低频。 +## 预期体量 + +本节应当写出预期的代码体量,并分析原因。示例如下: + +预期代码体量为 200-300 行。分析如下: + +- `IObjectMover` 首先需要完成计划存储与计划的定义,这些接口基本大致就是向数组中添加元素,每个方法内容都不多,整体预计在 100 行左右。 +- `IObjectMover` 还需要完成移动流程的编写工作,需要根据每个移动步按照流程执行不同的行为,这一过程较为复杂,预计需要 100-200 行。 + # 实现思路 按照下面的格式分条描述实现思路。 From 8f4c4b7df2adb4eae69da493320e34dca70262a3 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 21:32:23 +0800 Subject: [PATCH 19/26] =?UTF-8?q?refactor:=20=E5=B0=86=20Layer=200=20?= =?UTF-8?q?=E5=8D=95=E7=8B=AC=E6=94=BE=E5=88=B0=E4=B8=80=E4=B8=AA=E5=8C=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 11 ++-- packages-user/data-base/package.json | 1 + packages-user/data-base/src/enemy/enemy.ts | 2 +- packages-user/data-base/src/enemy/manager.ts | 2 +- packages-user/data-base/src/enemy/special.ts | 2 +- packages-user/data-base/src/enemy/types.ts | 2 +- packages-user/data-base/src/flag/types.ts | 2 +- packages-user/data-base/src/hero/attribute.ts | 2 +- packages-user/data-base/src/hero/mover.ts | 4 +- packages-user/data-base/src/hero/state.ts | 2 +- packages-user/data-base/src/hero/types.ts | 2 +- packages-user/data-base/src/index.ts | 2 - .../data-base/src/map/dynamicLayer.ts | 5 +- .../data-base/src/map/dynamicTile.ts | 5 +- packages-user/data-base/src/map/layerState.ts | 4 +- packages-user/data-base/src/map/mapLayer.ts | 7 ++- packages-user/data-base/src/map/mapStore.ts | 11 ++-- packages-user/data-base/src/map/mover.ts | 6 +- packages-user/data-base/src/map/types.ts | 26 +++++---- packages-user/data-base/src/shared.ts | 4 ++ packages-user/data-base/src/types.ts | 12 +--- packages-user/data-common/package.json | 6 ++ .../src/common/face.ts | 2 +- .../src/common/faceManager.ts | 2 +- .../src/common/index.ts | 0 .../src/common/indexer.ts | 0 .../src/common/mover.ts | 0 .../src/common/types.ts | 0 .../src/common/utils.ts | 0 packages-user/data-common/src/index.ts | 4 ++ .../src/store/index.ts | 0 .../src/store/tileStore.ts | 0 .../src/store/types.ts | 0 packages-user/data-common/src/types.ts | 16 ++++++ packages-user/data-state/package.json | 1 + packages-user/data-state/src/core.ts | 56 ++++++++++--------- .../data-state/src/enemy/mapDamage.ts | 7 +-- packages-user/data-state/src/legacy/move.ts | 3 +- packages-user/data-state/src/legacy/tile.ts | 6 +- packages-user/data-state/src/save/system.ts | 2 +- packages-user/data-state/src/save/types.ts | 2 +- packages-user/data-state/src/types.ts | 9 +-- .../data-system/src/combat/context.ts | 5 +- .../data-system/src/combat/mapDamage.ts | 3 +- packages-user/data-system/src/combat/types.ts | 4 +- .../legacy-plugin-data/src/fallback.ts | 3 +- packages/common/src/utils/types.ts | 2 +- pnpm-lock.yaml | 9 +++ 48 files changed, 159 insertions(+), 97 deletions(-) create mode 100644 packages-user/data-base/src/shared.ts create mode 100644 packages-user/data-common/package.json rename packages-user/{data-base => data-common}/src/common/face.ts (97%) rename packages-user/{data-base => data-common}/src/common/faceManager.ts (99%) rename packages-user/{data-base => data-common}/src/common/index.ts (100%) rename packages-user/{data-base => data-common}/src/common/indexer.ts (100%) rename packages-user/{data-base => data-common}/src/common/mover.ts (100%) rename packages-user/{data-base => data-common}/src/common/types.ts (100%) rename packages-user/{data-base => data-common}/src/common/utils.ts (100%) create mode 100644 packages-user/data-common/src/index.ts rename packages-user/{data-base => data-common}/src/store/index.ts (100%) rename packages-user/{data-base => data-common}/src/store/tileStore.ts (100%) rename packages-user/{data-base => data-common}/src/store/types.ts (100%) create mode 100644 packages-user/data-common/src/types.ts diff --git a/dev.md b/dev.md index 45ec7b8..62f19e0 100644 --- a/dev.md +++ b/dev.md @@ -128,8 +128,9 @@ **Layer 2 — 执行层**:直接引用 Layer 1,负责产生影响游戏进程的动作,如玩家控制、战斗计算等。本层内容不会进入存档,仅通过修改 Layer 1 的数据来影响游戏状态,并通过统一接口 `ICoreState` 对外暴露执行能力。 -| 包 | 层级 | 说明 | -| ------------------- | ----------------- | ------------------------------------------------------------------------------- | -| `@user/data-base` | Layer 0 / Layer 1 | 公共层与数据层,定义 `IStateBase` 及各类游戏数据(地图、怪物、玩家属性等) | -| `@user/data-state` | — | 数据端的顶层模块,指导 Layer 2 的执行行为,不直接参与执行 | -| `@user/data-system` | Layer 2 | 执行层,定义 `ICoreState`,依赖数据层实现玩家控制、战斗计算等影响游戏进程的动作 | +| 包 | 层级 | 说明 | +| ------------------- | ------- | ------------------------------------------------------------------------------- | +| `@user/data-common | Layer 0 | 公共层,定义 `IDataCommon` 及公共无依赖接口 | +| `@user/data-base` | Layer 1 | 数据层,定义 `IStateBase` 及可存档游戏数据(地图、怪物、玩家属性等) | +| `@user/data-system` | Layer 2 | 执行层,定义 `ICoreState`,依赖数据层实现玩家控制、战斗计算等影响游戏进程的动作 | +| `@user/data-state` | — | 数据端的顶层模块,指导 Layer 2 的执行行为,不直接参与执行 | diff --git a/packages-user/data-base/package.json b/packages-user/data-base/package.json index 89deac7..77412d8 100644 --- a/packages-user/data-base/package.json +++ b/packages-user/data-base/package.json @@ -1,6 +1,7 @@ { "name": "@user/data-base", "dependencies": { + "@user/data-common": "workspace:*", "@motajs/common": "workspace:*", "@motajs/types": "workspace:*", "@motajs/loader": "workspace:*" diff --git a/packages-user/data-base/src/enemy/enemy.ts b/packages-user/data-base/src/enemy/enemy.ts index 369ae39..63b2870 100644 --- a/packages-user/data-base/src/enemy/enemy.ts +++ b/packages-user/data-base/src/enemy/enemy.ts @@ -1,5 +1,5 @@ import { logger } from '@motajs/common'; -import { SaveCompression } from '../common'; +import { SaveCompression } from '@user/data-common'; import { IEnemy, IEnemySaveState, IReadonlyEnemy, ISpecial } from './types'; export class Enemy implements IEnemy { diff --git a/packages-user/data-base/src/enemy/manager.ts b/packages-user/data-base/src/enemy/manager.ts index b3ad7c1..2cdff49 100644 --- a/packages-user/data-base/src/enemy/manager.ts +++ b/packages-user/data-base/src/enemy/manager.ts @@ -10,7 +10,7 @@ import { SpecialCreation, IEnemySaveState } from './types'; -import { SaveCompression } from '../common'; +import { SaveCompression } from '@user/data-common'; export class EnemyManager implements IEnemyManager { /** 特殊属性注册表,code -> 创建函数 */ diff --git a/packages-user/data-base/src/enemy/special.ts b/packages-user/data-base/src/enemy/special.ts index 6f53661..312f702 100644 --- a/packages-user/data-base/src/enemy/special.ts +++ b/packages-user/data-base/src/enemy/special.ts @@ -1,5 +1,5 @@ import { isEqual } from 'lodash-es'; -import { SaveCompression } from '../common'; +import { SaveCompression } from '@user/data-common'; import { ISpecial, SpecialCreation } from './types'; // TODO: 颜色参数 diff --git a/packages-user/data-base/src/enemy/types.ts b/packages-user/data-base/src/enemy/types.ts index 61d6ba8..a316d9b 100644 --- a/packages-user/data-base/src/enemy/types.ts +++ b/packages-user/data-base/src/enemy/types.ts @@ -1,4 +1,4 @@ -import { ISaveableContent } from '../common'; +import { ISaveableContent } from '@user/data-common'; //#region 怪物基础 diff --git a/packages-user/data-base/src/flag/types.ts b/packages-user/data-base/src/flag/types.ts index a7cc428..3071a80 100644 --- a/packages-user/data-base/src/flag/types.ts +++ b/packages-user/data-base/src/flag/types.ts @@ -1,6 +1,6 @@ //#region 字段 -import { ISaveableContent } from '../common'; +import { ISaveableContent } from '@user/data-common'; export interface IFlagCommonField { /** 此字段所处的 Flag 系统 */ diff --git a/packages-user/data-base/src/hero/attribute.ts b/packages-user/data-base/src/hero/attribute.ts index 6a1f6f0..4e0a8a8 100644 --- a/packages-user/data-base/src/hero/attribute.ts +++ b/packages-user/data-base/src/hero/attribute.ts @@ -1,5 +1,5 @@ import { logger } from '@motajs/common'; -import { SaveCompression } from '../common'; +import { SaveCompression } from '@user/data-common'; import { IHeroAttribute, IHeroModifier } from './types'; export abstract class BaseHeroModifier implements IHeroModifier { diff --git a/packages-user/data-base/src/hero/mover.ts b/packages-user/data-base/src/hero/mover.ts index c578f30..b384978 100644 --- a/packages-user/data-base/src/hero/mover.ts +++ b/packages-user/data-base/src/hero/mover.ts @@ -1,8 +1,8 @@ import { Hookable, HookController, IHookController } from '@motajs/common'; import { isNil } from 'lodash-es'; -import { getFaceMovement, nextFaceDirection } from '../common/utils'; +import { getFaceMovement, nextFaceDirection } from '@user/data-common'; import { IHeroFollower, IHeroMover, IHeroMovingHooks } from './types'; -import { FaceDirection } from '../common'; +import { FaceDirection } from '@user/data-common'; const DEFAULT_HERO_IMAGE: ImageIds = 'hero.png'; diff --git a/packages-user/data-base/src/hero/state.ts b/packages-user/data-base/src/hero/state.ts index 37a690d..045e470 100644 --- a/packages-user/data-base/src/hero/state.ts +++ b/packages-user/data-base/src/hero/state.ts @@ -8,7 +8,7 @@ import { IModifierStateSave, IReadonlyHeroAttribute } from './types'; -import { SaveCompression } from '../common'; +import { SaveCompression } from '@user/data-common'; import { logger } from '@motajs/common'; export class HeroState implements IHeroState { diff --git a/packages-user/data-base/src/hero/types.ts b/packages-user/data-base/src/hero/types.ts index a35902b..3d0f048 100644 --- a/packages-user/data-base/src/hero/types.ts +++ b/packages-user/data-base/src/hero/types.ts @@ -1,5 +1,5 @@ import { IFacedTileLocator, IHookBase, IHookable } from '@motajs/common'; -import { FaceDirection, ISaveableContent } from '../common'; +import { FaceDirection, ISaveableContent } from '@user/data-common'; //#region 勇士属性 diff --git a/packages-user/data-base/src/index.ts b/packages-user/data-base/src/index.ts index 55d11bf..7d31be1 100644 --- a/packages-user/data-base/src/index.ts +++ b/packages-user/data-base/src/index.ts @@ -1,10 +1,8 @@ -export * from './common'; export * from './enemy'; export * from './flag'; export * from './hero'; export * from './load'; export * from './map'; -export * from './store'; export * from './game'; export * from './types'; diff --git a/packages-user/data-base/src/map/dynamicLayer.ts b/packages-user/data-base/src/map/dynamicLayer.ts index 20aac90..8afc2a4 100644 --- a/packages-user/data-base/src/map/dynamicLayer.ts +++ b/packages-user/data-base/src/map/dynamicLayer.ts @@ -11,13 +11,15 @@ import { IDynamicTile, IMapLayer } from './types'; -import { FaceDirection, degradeFace } from '../common'; +import { FaceDirection, IDataCommon, degradeFace } from '@user/data-common'; import { DynamicTile } from './dynamicTile'; export class DynamicLayer extends Hookable implements IDynamicLayer { + readonly state: IDataCommon; + /** 坐标到动态图块集合的映射,外层 key = y,内层 key = x,不使用 index 是为了支持地图外图块 */ private readonly tilePosMap: Map>> = new Map(); @@ -26,6 +28,7 @@ export class DynamicLayer constructor(public readonly layer: IMapLayer) { super(); + this.state = layer.state; } protected createController( diff --git a/packages-user/data-base/src/map/dynamicTile.ts b/packages-user/data-base/src/map/dynamicTile.ts index 2eff581..3169edf 100644 --- a/packages-user/data-base/src/map/dynamicTile.ts +++ b/packages-user/data-base/src/map/dynamicTile.ts @@ -1,14 +1,16 @@ import { isNil } from 'lodash-es'; import { FaceDirection, + IDataCommon, IMoverController, IObjectMover, IRoleFaceBinder -} from '../common'; +} from '@user/data-common'; import { IDynamicLayer, IDynamicTile } from './types'; import { DynamicTileMover } from './mover'; export class DynamicTile implements IDynamicTile { + readonly state: IDataCommon; readonly mover: IObjectMover; triggerType: number; @@ -21,6 +23,7 @@ export class DynamicTile implements IDynamicTile { public y: number, public readonly layer: IDynamicLayer ) { + this.state = layer.state; this.mover = new DynamicTileMover(this); this.triggerType = -1; } diff --git a/packages-user/data-base/src/map/layerState.ts b/packages-user/data-base/src/map/layerState.ts index 21f5a87..b11638b 100644 --- a/packages-user/data-base/src/map/layerState.ts +++ b/packages-user/data-base/src/map/layerState.ts @@ -11,7 +11,7 @@ import { IMapLayerHookController, IMapLayerHooks } from './types'; -import { ITileStore } from '../store'; +import { IDataCommon, ITileStore } from '@user/data-common'; import { MapLayer } from './mapLayer'; export class LayerState @@ -39,6 +39,7 @@ export class LayerState private dirty: boolean = false; constructor( + public readonly state: IDataCommon, public readonly tileStore: ITileStore, public width: number, public height: number @@ -52,6 +53,7 @@ export class LayerState array, this.width, this.height, + this, this.tileStore ); this.layerList.add(layer); diff --git a/packages-user/data-base/src/map/mapLayer.ts b/packages-user/data-base/src/map/mapLayer.ts index 061cd39..373dac2 100644 --- a/packages-user/data-base/src/map/mapLayer.ts +++ b/packages-user/data-base/src/map/mapLayer.ts @@ -1,6 +1,7 @@ import { isNil } from 'lodash-es'; import { IDynamicLayer, + ILayerState, IMapLayer, IMapLayerData, IMapLayerHookController, @@ -8,7 +9,7 @@ import { } from './types'; import { Hookable, HookController, logger } from '@motajs/common'; import { DynamicLayer } from './dynamicLayer'; -import { ITileStore } from '../store'; +import { IDataCommon, ITileStore } from '@user/data-common'; // todo: 提供 core.setBlock 等方法的替代方法,同时添加 setBlockList,以及前景背景的接口 @@ -16,6 +17,8 @@ export class MapLayer extends Hookable implements IMapLayer { + readonly state: IDataCommon; + width: number; height: number; empty: boolean = true; @@ -34,9 +37,11 @@ export class MapLayer array: Uint32Array, width: number, height: number, + public readonly layerState: ILayerState, private readonly tileStore: ITileStore ) { super(); + this.state = layerState.state; this.width = width; this.height = height; const area = width * height; diff --git a/packages-user/data-base/src/map/mapStore.ts b/packages-user/data-base/src/map/mapStore.ts index 7095da2..365d898 100644 --- a/packages-user/data-base/src/map/mapStore.ts +++ b/packages-user/data-base/src/map/mapStore.ts @@ -1,6 +1,6 @@ import { logger } from '@motajs/common'; -import { SaveCompression } from '../common'; -import { ITileStore } from '../store'; +import { IDataCommon, SaveCompression } from '@user/data-common'; +import { ITileStore } from '@user/data-common'; import { ILayerState, ILayerStateSave, @@ -32,7 +32,10 @@ export class MapStore implements IMapStore { /** 自动分区激活器开关 */ private autoActivitorEnabled: boolean = false; - constructor(private readonly tileStore: ITileStore) {} + constructor( + private readonly tileStore: ITileStore, + public readonly state: IDataCommon + ) {} //#region 楼层管理 @@ -42,7 +45,7 @@ export class MapStore implements IMapStore { } else { this.maps.push(id); } - const state = new LayerState(this.tileStore, width, height); + const state = new LayerState(this.state, this.tileStore, width, height); // 若 refData 已存在,新楼层直接视为全脏 if (this.refData !== null) { state.setDirty(true); diff --git a/packages-user/data-base/src/map/mover.ts b/packages-user/data-base/src/map/mover.ts index c6cd03a..2340ff2 100644 --- a/packages-user/data-base/src/map/mover.ts +++ b/packages-user/data-base/src/map/mover.ts @@ -4,8 +4,9 @@ import { ObjectMover, ObjectMoveStep, ObjectMoveStepType -} from '../common'; +} from '@user/data-common'; import { IDynamicTile } from './types'; +import { DYNAMIC_MOVER_FACE } from '../shared'; //#region 动态图块 @@ -16,7 +17,8 @@ const enum DynamicMoveCode { export class DynamicTileMover extends ObjectMover { constructor(public readonly tile: IDynamicTile) { - super(); + const face = tile.state.faceManager; + super(face.get(DYNAMIC_MOVER_FACE)!); } protected onMoveStart(): Promise { diff --git a/packages-user/data-base/src/map/types.ts b/packages-user/data-base/src/map/types.ts index 9d969e5..f6ca49f 100644 --- a/packages-user/data-base/src/map/types.ts +++ b/packages-user/data-base/src/map/types.ts @@ -1,13 +1,14 @@ import { IHookable, IHookBase, IHookController } from '@motajs/common'; import { FaceDirection, + IDataCommonExtended, IMoverController, IObjectMovable, IObjectMover, IRoleFaceBinder, ISaveableContent -} from '../common'; -import { ITileStore } from '../store'; +} from '@user/data-common'; +import { ITileStore } from '@user/data-common'; //#region 静态图层 @@ -69,10 +70,10 @@ export interface IMapLayerHookController extends IHookController getMapData(): Readonly; } -export interface IMapLayer extends IHookable< - IMapLayerHooks, - IMapLayerHookController -> { +export interface IMapLayer + extends + IHookable, + IDataCommonExtended { /** 地图宽度 */ readonly width: number; /** 地图高度 */ @@ -85,6 +86,8 @@ export interface IMapLayer extends IHookable< /** 图层纵深 */ readonly zIndex: number; + /** 当前图层所属的地图状态对象 */ + readonly layerState: ILayerState; /** 此图层对应的动态图块图层,z 层级与静态图块一致 */ readonly dynamicLayer: IDynamicLayer; @@ -261,7 +264,8 @@ export interface ILayerStateHooks extends IHookBase { onResizeLayer(layer: IMapLayer, width: number, height: number): void; } -export interface ILayerState extends IHookable { +export interface ILayerState + extends IHookable, IDataCommonExtended { /** 地图列表 */ readonly layerList: Set; /** 当前楼层共享的图块定义 store */ @@ -395,7 +399,8 @@ export interface IMapAreaInterval { export type MapArea = IMapAreaInterval[]; -export interface IMapStore extends ISaveableContent { +export interface IMapStore + extends ISaveableContent, IDataCommonExtended { /** 所有楼层的 id 有序数组 */ readonly maps: ReadonlyArray; @@ -524,7 +529,8 @@ export interface IDynamicLayerHooks extends IHookBase { onUpdateTilePosition(tile: IDynamicTile, layer: IDynamicLayer): void; } -export interface IDynamicLayer extends IHookable { +export interface IDynamicLayer + extends IHookable, IDataCommonExtended { /** 当前动态图层所属的静态图层 */ readonly layer: IMapLayer; @@ -598,7 +604,7 @@ export interface IDynamicLayer extends IHookable { updateDynamicTile(tile: IDynamicTile): void; } -export interface IDynamicTile extends IObjectMovable { +export interface IDynamicTile extends IObjectMovable, IDataCommonExtended { /** 当前图块数字 */ readonly num: number; /** 当前动态图块携带的触发器类型,-1 表示无触发器 */ diff --git a/packages-user/data-base/src/shared.ts b/packages-user/data-base/src/shared.ts new file mode 100644 index 0000000..0464e06 --- /dev/null +++ b/packages-user/data-base/src/shared.ts @@ -0,0 +1,4 @@ +import { FaceGroup } from '@user/data-common'; + +/** 动态图块所使用的默认移动组,不知道干什么的就别动 */ +export const DYNAMIC_MOVER_FACE = FaceGroup.Dir8; diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index 33b6e5f..94e65e0 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -1,23 +1,15 @@ import { IHeroFollower, IHeroState } from './hero'; import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; -import { IFaceManager, IRoleFaceBinder, ISaveableContent } from './common'; import { IMapStore } from './map'; -import { ITileStore } from './store'; +import { IDataCommon, ISaveableContent } from '@user/data-common'; export interface IStateSaveData { /** 跟随者列表 */ readonly followers: readonly IHeroFollower[]; } -export interface IStateBase { - /** 朝向绑定 */ - readonly roleFace: IRoleFaceBinder; - /** 朝向管理 */ - readonly faceManager: IFaceManager; - /** 图块定义存储 */ - readonly tileStore: ITileStore; - +export interface IStateBase extends IDataCommon { /** 地图状态 */ readonly maps: IMapStore; /** 勇士状态 */ diff --git a/packages-user/data-common/package.json b/packages-user/data-common/package.json new file mode 100644 index 0000000..f69debc --- /dev/null +++ b/packages-user/data-common/package.json @@ -0,0 +1,6 @@ +{ + "name": "@user/data-common", + "dependencies": { + "@motajs/common": "workspace:*" + } +} diff --git a/packages-user/data-base/src/common/face.ts b/packages-user/data-common/src/common/face.ts similarity index 97% rename from packages-user/data-base/src/common/face.ts rename to packages-user/data-common/src/common/face.ts index 5318fcf..8654106 100644 --- a/packages-user/data-base/src/common/face.ts +++ b/packages-user/data-common/src/common/face.ts @@ -1,5 +1,5 @@ import { logger } from '@motajs/common'; -import { IFaceData, IRoleFaceBinder } from './types'; +import { IFaceData, IRoleFaceBinder } from '../common'; import { isNil } from 'lodash-es'; import { FaceDirection } from '.'; diff --git a/packages-user/data-base/src/common/faceManager.ts b/packages-user/data-common/src/common/faceManager.ts similarity index 99% rename from packages-user/data-base/src/common/faceManager.ts rename to packages-user/data-common/src/common/faceManager.ts index 8736d3a..66df2b0 100644 --- a/packages-user/data-base/src/common/faceManager.ts +++ b/packages-user/data-common/src/common/faceManager.ts @@ -2,7 +2,7 @@ import { FaceDirection } from './types'; //#region 接口与枚举 -export const enum InternalFaceGroup { +export const enum FaceGroup { /** 四方向(上下左右) */ Dir4, /** 八方向(上下左右+斜向) */ diff --git a/packages-user/data-base/src/common/index.ts b/packages-user/data-common/src/common/index.ts similarity index 100% rename from packages-user/data-base/src/common/index.ts rename to packages-user/data-common/src/common/index.ts diff --git a/packages-user/data-base/src/common/indexer.ts b/packages-user/data-common/src/common/indexer.ts similarity index 100% rename from packages-user/data-base/src/common/indexer.ts rename to packages-user/data-common/src/common/indexer.ts diff --git a/packages-user/data-base/src/common/mover.ts b/packages-user/data-common/src/common/mover.ts similarity index 100% rename from packages-user/data-base/src/common/mover.ts rename to packages-user/data-common/src/common/mover.ts diff --git a/packages-user/data-base/src/common/types.ts b/packages-user/data-common/src/common/types.ts similarity index 100% rename from packages-user/data-base/src/common/types.ts rename to packages-user/data-common/src/common/types.ts diff --git a/packages-user/data-base/src/common/utils.ts b/packages-user/data-common/src/common/utils.ts similarity index 100% rename from packages-user/data-base/src/common/utils.ts rename to packages-user/data-common/src/common/utils.ts diff --git a/packages-user/data-common/src/index.ts b/packages-user/data-common/src/index.ts new file mode 100644 index 0000000..97bcfee --- /dev/null +++ b/packages-user/data-common/src/index.ts @@ -0,0 +1,4 @@ +export * from './common'; +export * from './store'; + +export * from './types'; diff --git a/packages-user/data-base/src/store/index.ts b/packages-user/data-common/src/store/index.ts similarity index 100% rename from packages-user/data-base/src/store/index.ts rename to packages-user/data-common/src/store/index.ts diff --git a/packages-user/data-base/src/store/tileStore.ts b/packages-user/data-common/src/store/tileStore.ts similarity index 100% rename from packages-user/data-base/src/store/tileStore.ts rename to packages-user/data-common/src/store/tileStore.ts diff --git a/packages-user/data-base/src/store/types.ts b/packages-user/data-common/src/store/types.ts similarity index 100% rename from packages-user/data-base/src/store/types.ts rename to packages-user/data-common/src/store/types.ts diff --git a/packages-user/data-common/src/types.ts b/packages-user/data-common/src/types.ts new file mode 100644 index 0000000..d814269 --- /dev/null +++ b/packages-user/data-common/src/types.ts @@ -0,0 +1,16 @@ +import { IFaceManager, IRoleFaceBinder } from './common'; +import { ITileStore } from './store'; + +export interface IDataCommon { + /** 图块定义存储 */ + readonly tileStore: ITileStore>; + /** 朝向绑定 */ + readonly roleFace: IRoleFaceBinder; + /** 朝向管理 */ + readonly faceManager: IFaceManager; +} + +export interface IDataCommonExtended { + /** 当前对象对应的基本数据端对象(Layer 0 对象) */ + readonly state: IDataCommon; +} diff --git a/packages-user/data-state/package.json b/packages-user/data-state/package.json index eca262b..e3e224d 100644 --- a/packages-user/data-state/package.json +++ b/packages-user/data-state/package.json @@ -3,6 +3,7 @@ "dependencies": { "@motajs/types": "workspace:*", "@motajs/common": "workspace:*", + "@user/data-common": "workspace:*", "@user/data-base": "workspace:*", "@user/data-system": "workspace:*", "@user/data-utils": "workspace:*" diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 2145c69..0bba55c 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -1,4 +1,18 @@ import { ICoreState, ISaveableExecutor } from './types'; +import { + IRoleFaceBinder, + IFaceManager, + ITileStore, + ISaveableContent, + TileStore, + SaveCompression, + RoleFaceBinder, + FaceManager, + Dir4FaceHandler, + Dir8FaceHandler, + FaceGroup, + FaceDirection +} from '@user/data-common'; import { EnemyManager, HeroMover, @@ -11,22 +25,16 @@ import { IMotaDataLoader, MotaDataLoader, loading, - IRoleFaceBinder, - RoleFaceBinder, - FaceDirection, - ISaveableContent, - SaveCompression, IReadonlyEnemy, IMapStore, - MapStore, - IFaceManager, - FaceManager, - InternalFaceGroup, - Dir4FaceHandler, - Dir8FaceHandler, - ITileStore, - TileStore + MapStore } from '@user/data-base'; +import { + DamageSystem, + EnemyContext, + IEnemyContext, + MapDamage +} from '@user/data-system'; import { CommonAuraConverter, EnemyLegacyBridge, @@ -55,29 +63,25 @@ import { ILoadProgressTotal, LoadProgressTotal } from '@motajs/loader'; import { isNil } from 'lodash-es'; import { logger } from '@motajs/common'; import { ISaveSystem, SaveSystem } from './save'; -import { - DamageSystem, - EnemyContext, - IEnemyContext, - MapDamage -} from '@user/data-system'; export class CoreState implements ICoreState { - // 全局内容 + // Layer 0 内容 readonly roleFace: IRoleFaceBinder; readonly faceManager: IFaceManager; readonly tileStore: ITileStore; - // 可存档内容 + // Layer 1 内容 readonly maps: IMapStore; readonly hero: IHeroState; readonly enemyManager: IEnemyManager; readonly flags: IFlagSystem; - // 状态内容 + // Layer 2 内容 + readonly enemyContext: IEnemyContext; + + // 用户层内容 readonly loadProgress: ILoadProgressTotal; readonly dataLoader: IMotaDataLoader; - readonly enemyContext: IEnemyContext; readonly saveSystem: ISaveSystem; /** 可存档对象映射 */ @@ -94,7 +98,7 @@ export class CoreState implements ICoreState { const tileStore = new TileStore(); tileStore.attachLegacyConverter(new TileLegacyBridge()); this.tileStore = tileStore; - this.maps = new MapStore(tileStore); + this.maps = new MapStore(tileStore, this); this.loadProgress = new LoadProgressTotal(); this.dataLoader = new MotaDataLoader(this.loadProgress); @@ -166,9 +170,9 @@ export class CoreState implements ICoreState { this.faceManager = new FaceManager(); const dir4 = new Dir4FaceHandler(); const dir8 = new Dir8FaceHandler(); - this.faceManager.register(InternalFaceGroup.Dir4, dir4); + this.faceManager.register(FaceGroup.Dir4, dir4); this.faceManager.registerById('dir4', dir4); - this.faceManager.register(InternalFaceGroup.Dir8, dir8); + this.faceManager.register(FaceGroup.Dir8, dir8); this.faceManager.registerById('dir8', dir8); this.flags = new FlagSystem(); diff --git a/packages-user/data-state/src/enemy/mapDamage.ts b/packages-user/data-state/src/enemy/mapDamage.ts index 6bff8e7..b0659e8 100644 --- a/packages-user/data-state/src/enemy/mapDamage.ts +++ b/packages-user/data-state/src/enemy/mapDamage.ts @@ -19,15 +19,14 @@ import { IMapDamageView } from '@user/data-system'; import { - IFaceHandler, ISpecial, IReadonlyHeroAttribute, - IReadonlyEnemy, - InternalFaceGroup + IReadonlyEnemy } from '@user/data-base'; import { IZoneValue } from './special'; import { IEnemyAttr, MapDamageType } from './types'; import { IHeroAttr } from '../hero'; +import { IFaceHandler, FaceGroup } from '@user/data-common'; const RECT_RANGE = new RectRange(); const MANHATTAN_RANGE = new ManhattanRange(); @@ -312,7 +311,7 @@ export class MainMapDamageConverter implements IMapDamageConverter< const laser = enemy.getSpecial(24); if (laser) { - const face = handler.data.faceManager.get(InternalFaceGroup.Dir4)!; + const face = handler.data.faceManager.get(FaceGroup.Dir4)!; views.push(new LaserDamageView(context, locator, laser, face)); } diff --git a/packages-user/data-state/src/legacy/move.ts b/packages-user/data-state/src/legacy/move.ts index 48c3aa3..c91c047 100644 --- a/packages-user/data-state/src/legacy/move.ts +++ b/packages-user/data-state/src/legacy/move.ts @@ -1,9 +1,10 @@ import EventEmitter from 'eventemitter3'; import { backDir, toDir } from './utils'; -import { fromDirectionString, loading } from '@user/data-base'; +import { loading } from '@user/data-base'; import type { HeroKeyMover } from '@user/client-modules'; import { sleep } from '@motajs/common'; import { state } from '..'; +import { fromDirectionString } from '@user/data-common'; // todo: 转身功能 diff --git a/packages-user/data-state/src/legacy/tile.ts b/packages-user/data-state/src/legacy/tile.ts index 8694394..ca50d42 100644 --- a/packages-user/data-state/src/legacy/tile.ts +++ b/packages-user/data-state/src/legacy/tile.ts @@ -1,4 +1,8 @@ -import { ITileLegacyConverter, ITileRawData, TileType } from '@user/data-base'; +import { + ITileLegacyConverter, + ITileRawData, + TileType +} from '@user/data-common'; export type LegacyTileData = MapDataOf; diff --git a/packages-user/data-state/src/save/system.ts b/packages-user/data-state/src/save/system.ts index 8b5fecd..68e93c9 100644 --- a/packages-user/data-state/src/save/system.ts +++ b/packages-user/data-state/src/save/system.ts @@ -6,7 +6,7 @@ import { ISaveSystem, ISaveSystemConfig } from './types'; -import { ISaveableContent, SaveCompression } from '@user/data-base'; +import { ISaveableContent, SaveCompression } from '@user/data-common'; import { isNil } from 'lodash-es'; interface ISaveRecord { diff --git a/packages-user/data-state/src/save/types.ts b/packages-user/data-state/src/save/types.ts index 034db4b..82737b5 100644 --- a/packages-user/data-state/src/save/types.ts +++ b/packages-user/data-state/src/save/types.ts @@ -1,4 +1,4 @@ -import { ISaveableContent, SaveCompression } from '@user/data-base'; +import { ISaveableContent, SaveCompression } from '@user/data-common'; import { Dexie, Table } from 'dexie'; export interface IGlobalTrasaction { diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index 5ef2e96..beb114d 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -1,13 +1,10 @@ -import { - IEnemyContext, - IMotaDataLoader, - ISaveableContent, - IStateBase -} from '@user/data-base'; +import { IMotaDataLoader, IStateBase } from '@user/data-base'; import { IEnemyAttr } from './enemy'; import { IHeroAttr } from './hero'; import { ILoadProgressTotal } from '@motajs/loader'; import { ISaveSystem } from './save'; +import { IEnemyContext } from '@user/data-system'; +import { ISaveableContent } from '@user/data-common'; export interface ISaveableExecutor { /** diff --git a/packages-user/data-system/src/combat/context.ts b/packages-user/data-system/src/combat/context.ts index ca7e8db..22dbb4f 100644 --- a/packages-user/data-system/src/combat/context.ts +++ b/packages-user/data-system/src/combat/context.ts @@ -19,11 +19,10 @@ import { IEnemy, IReadonlyEnemy, ISpecial, - IStateBase, - ILocationIndexer, - MapLocIndexer + IStateBase } from '@user/data-base'; import { EnemyView } from './enemy'; +import { ILocationIndexer, MapLocIndexer } from '@user/data-common'; export class EnemyContext implements IEnemyContext< TEnemy, diff --git a/packages-user/data-system/src/combat/mapDamage.ts b/packages-user/data-system/src/combat/mapDamage.ts index 200fa3b..e68249a 100644 --- a/packages-user/data-system/src/combat/mapDamage.ts +++ b/packages-user/data-system/src/combat/mapDamage.ts @@ -9,7 +9,8 @@ import { IMapDamageReducer, IMapDamageView } from './types'; -import { ILocationHelper, IStateBase } from '@user/data-base'; +import { IStateBase } from '@user/data-base'; +import { ILocationHelper } from '@user/data-common'; interface IPointInfo { /** 该点所有的地图伤害 */ diff --git a/packages-user/data-system/src/combat/types.ts b/packages-user/data-system/src/combat/types.ts index cc6ab59..044cafe 100644 --- a/packages-user/data-system/src/combat/types.ts +++ b/packages-user/data-system/src/combat/types.ts @@ -5,9 +5,9 @@ import { ISpecial, IReadonlyHeroAttribute, IHeroAttribute, - IStateBase, - ILocationHelper + IStateBase } from '@user/data-base'; +import { ILocationHelper } from '@user/data-common'; //#region 辅助接口 diff --git a/packages-user/legacy-plugin-data/src/fallback.ts b/packages-user/legacy-plugin-data/src/fallback.ts index 8cd88eb..a69fb7b 100644 --- a/packages-user/legacy-plugin-data/src/fallback.ts +++ b/packages-user/legacy-plugin-data/src/fallback.ts @@ -1,8 +1,9 @@ import type { TimingFn } from 'mutate-animate'; import { heroMoveCollection, MoveStep, state } from '@user/data-state'; -import { fromDirectionString, hook, loading } from '@user/data-base'; +import { hook, loading } from '@user/data-base'; import { Patch, PatchClass } from '@motajs/legacy-common'; import { isNil } from 'lodash-es'; +import { fromDirectionString } from '@user/data-common'; // 向后兼容用,会充当两个版本间过渡的作用 diff --git a/packages/common/src/utils/types.ts b/packages/common/src/utils/types.ts index 8334175..82b6a31 100644 --- a/packages/common/src/utils/types.ts +++ b/packages/common/src/utils/types.ts @@ -1,4 +1,4 @@ -import { FaceDirection } from '@user/data-base'; +import { FaceDirection } from '@user/data-common'; export interface ISearchable4Dir { /** 获取上侧元素 */ diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 16fe420..a8ea3a0 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -288,6 +288,15 @@ importers: '@motajs/types': specifier: workspace:* version: link:../../packages/types + '@user/data-common': + specifier: workspace:* + version: link:../data-common + + packages-user/data-common: + dependencies: + '@motajs/common': + specifier: workspace:* + version: link:../../packages/common packages-user/data-fallback: dependencies: From b779e62eb2b4c25f6107b073439b88a7e8262a44 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 21:38:29 +0800 Subject: [PATCH 20/26] =?UTF-8?q?refactor:=20=E7=BB=9F=E4=B8=80=E4=B8=89?= =?UTF-8?q?=E4=B8=AA=E6=95=B0=E6=8D=AE=E5=B1=82=E7=9A=84=E6=8E=A5=E5=8F=A3?= =?UTF-8?q?=E9=A3=8E=E6=A0=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 2 +- packages-user/data-base/src/types.ts | 5 +++++ packages-user/data-common/src/types.ts | 2 +- packages-user/data-state/src/types.ts | 7 ++----- packages-user/data-system/src/index.ts | 2 ++ packages-user/data-system/src/types.ts | 12 ++++++++++++ 6 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 packages-user/data-system/src/types.ts diff --git a/dev.md b/dev.md index 62f19e0..c124f90 100644 --- a/dev.md +++ b/dev.md @@ -122,7 +122,7 @@ 数据端目前正在从旧引擎进行彻底性重构,分为三层: -**Layer 0 — 公共层**:包含公共接口、工具函数等内容,不依赖任何外部游戏逻辑,可被任意高层直接引用。内容较少,与 Layer 1 共同放在 `@user/data-base` 中,不单独开包。 +**Layer 0 — 公共层**:包含公共接口、工具函数等内容,不依赖任何外部游戏逻辑,可被任意高层直接引用。包含统一接口 `IDataCommon`。 **Layer 1 — 数据层**:包含所有会影响游戏存档与流程的数据内容,如地图、怪物、玩家属性等。本层通过统一接口 `IStateBase` 对外暴露数据访问能力,各类数据模块均以此接口为核心组织。 diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index 94e65e0..796a4b6 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -34,3 +34,8 @@ export interface IStateBase extends IDataCommon { */ getSaveableContent(id: string): ISaveableContent | null; } + +export interface IStateBaseExtended { + /** 当前对象对应的数据层对象(Layer 1 对象) */ + readonly state: IStateBase; +} diff --git a/packages-user/data-common/src/types.ts b/packages-user/data-common/src/types.ts index d814269..dffe3f9 100644 --- a/packages-user/data-common/src/types.ts +++ b/packages-user/data-common/src/types.ts @@ -11,6 +11,6 @@ export interface IDataCommon { } export interface IDataCommonExtended { - /** 当前对象对应的基本数据端对象(Layer 0 对象) */ + /** 当前对象对应的公共层对象(Layer 0 对象) */ readonly state: IDataCommon; } diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index beb114d..73de768 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -3,7 +3,7 @@ import { IEnemyAttr } from './enemy'; import { IHeroAttr } from './hero'; import { ILoadProgressTotal } from '@motajs/loader'; import { ISaveSystem } from './save'; -import { IEnemyContext } from '@user/data-system'; +import { IStateSystem } from '@user/data-system'; import { ISaveableContent } from '@user/data-common'; export interface ISaveableExecutor { @@ -15,14 +15,11 @@ export interface ISaveableExecutor { afterLoad(data: T, state: IStateBase): void; } -export interface ICoreState extends IStateBase { +export interface ICoreState extends IStateSystem { /** 加载进度对象 */ readonly loadProgress: ILoadProgressTotal; /** 数据端加载对象 */ readonly dataLoader: IMotaDataLoader; - /** 怪物上下文 */ - readonly enemyContext: IEnemyContext; - /** 存档系统 */ readonly saveSystem: ISaveSystem; diff --git a/packages-user/data-system/src/index.ts b/packages-user/data-system/src/index.ts index 25a6dfe..d7cdcfd 100644 --- a/packages-user/data-system/src/index.ts +++ b/packages-user/data-system/src/index.ts @@ -1,2 +1,4 @@ export * from './combat'; export * from './trigger'; + +export * from './types'; diff --git a/packages-user/data-system/src/types.ts b/packages-user/data-system/src/types.ts new file mode 100644 index 0000000..f08ee0b --- /dev/null +++ b/packages-user/data-system/src/types.ts @@ -0,0 +1,12 @@ +import { IStateBase } from '@user/data-base'; +import { IEnemyContext } from './combat'; + +export interface IStateSystem extends IStateBase { + /** 怪物上下文 */ + readonly enemyContext: IEnemyContext; +} + +export interface IStateSystemExtended { + /** 当前对象对应的执行层对象(Layer 2 对象) */ + readonly state: IStateSystem; +} From 0f5b1f4d80f7803a51edac95795084b89af6e1ed Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 21:50:49 +0800 Subject: [PATCH 21/26] =?UTF-8?q?refactor:=20=E5=88=A0=E9=99=A4=E6=97=A7?= =?UTF-8?q?=20Range=20=E6=8E=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 2 +- packages-user/data-fallback/src/battle.ts | 270 ------ packages-user/data-fallback/src/damage.ts | 124 --- packages-user/data-fallback/src/index.ts | 4 - packages-user/data-state/src/enemy/damage.ts | 813 ------------------ packages-user/data-utils/src/index.ts | 1 - packages-user/data-utils/src/range.ts | 86 -- .../src/enemy/checkblock.ts | 91 -- .../legacy-plugin-data/src/enemy/index.ts | 7 - packages-user/legacy-plugin-data/src/index.ts | 3 - 10 files changed, 1 insertion(+), 1400 deletions(-) delete mode 100644 packages-user/data-fallback/src/battle.ts delete mode 100644 packages-user/data-fallback/src/damage.ts delete mode 100644 packages-user/data-state/src/enemy/damage.ts delete mode 100644 packages-user/data-utils/src/range.ts delete mode 100644 packages-user/legacy-plugin-data/src/enemy/checkblock.ts delete mode 100644 packages-user/legacy-plugin-data/src/enemy/index.ts diff --git a/dev.md b/dev.md index c124f90..05714d5 100644 --- a/dev.md +++ b/dev.md @@ -45,7 +45,7 @@ ### 模块原则 - **无副作用**:所有模块只包含函数、类、常量的声明,不允许出现导出的变量声明或顶层代码执行,允许但不建议编写类的静态块。 -- **模块初始化**:如需初始化,编写一个 `createXxx` 函数,在 `index.ts` 中整合后逐级向上传递,直至顶层模块统一执行。 +- **模块初始化**:如需初始化,编写一个 `createXxx` 函数,在 `index.ts` 中整合后逐级向上传递,直至顶层模块统一执行。注意,当前设计理念下,**不应该**有场景会需要这种函数。 - **不转发导出**:不允许一个文件导出不属于当前 monorepo 或当前文件夹的内容。 - **无循环引用**:不允许出现循环引用。若遇到不得不循环引用的情况,应首先反思接口设计是否存在问题。 diff --git a/packages-user/data-fallback/src/battle.ts b/packages-user/data-fallback/src/battle.ts deleted file mode 100644 index bcdaacf..0000000 --- a/packages-user/data-fallback/src/battle.ts +++ /dev/null @@ -1,270 +0,0 @@ -import { - DamageEnemy, - ensureFloorDamage, - getEnemy, - state -} from '@user/data-state'; -import { hook } from '@user/data-base'; -import { Patch, PatchClass } from '@motajs/legacy-common'; -import { isNil } from 'lodash-es'; - -export interface CurrentEnemy { - enemy: DamageEnemy; - // 这个是干啥的? - onMapEnemy: DamageEnemy[]; -} - -export function patchBattle() { - const patch = new Patch(PatchClass.Enemys); - const patch2 = new Patch(PatchClass.Events); - - patch.add('canBattle', function (x, y, floorId) { - const enemy = typeof x === 'number' ? getEnemy(x, y!, floorId) : x; - if (!enemy) { - throw new Error( - `Cannot get enemy on x:${x}, y:${y}, floor: ${floorId}` - ); - } - const { damage } = enemy.calDamage(); - - return damage < core.status.hero.hp; - }); - - function battle( - x: number | DamageEnemy, - y: number, - force: boolean = false, - callback?: () => void - ) { - core.saveAndStopAutomaticRoute(); - const isLoc = typeof x === 'number'; - const enemy = isLoc ? getEnemy(x, y) : x; - if (!enemy) { - throw new Error( - `Cannot battle with enemy since no enemy on ${x},${y}` - ); - } - // 非强制战斗 - // @ts-expect-error 2.c 重构 - if (!core.canBattle(x, y) && !force && !core.status.event.id) { - core.stopSound(); - core.playSound('操作失败'); - core.drawTip('你打不过此怪物!', enemy!.id); - return core.clearContinueAutomaticRoute(callback); - } - // 自动存档 - if (!core.status.event.id) core.autosave(true); - // 战前事件 - // 战后事件 - core.afterBattle(enemy, isLoc ? x : enemy.x, y); - callback?.(); - } - - const getFacedId = (enemy: DamageEnemy) => { - const e = enemy.enemy; - - if (e.displayIdInBook) return e.displayIdInBook; - if (e.faceIds) return e.faceIds.down; - return e.id; - }; - - patch.add('getCurrentEnemys', function (floorId = core.status.floorId) { - floorId = floorId || core.status.floorId; - const enemys: CurrentEnemy[] = []; - const used: Record = {}; - ensureFloorDamage(floorId); - const floor = core.status.maps[floorId]; - floor.enemy.list.forEach(v => { - const id = getFacedId(v); - if (!(id in used)) { - const e = new DamageEnemy(v.enemy); - e.calAttribute(); - e.getRealInfo(); - e.calDamage(); - const curr: CurrentEnemy = { - enemy: e, - onMapEnemy: [v] - }; - enemys.push(curr); - used[id] = curr.onMapEnemy; - } else { - used[id].push(v); - } - }); - - return enemys.sort((a, b) => { - const ad = a.enemy.calDamage().damage; - const bd = b.enemy.calDamage().damage; - return ad - bd; - }); - }); - - patch2.add('battle', battle); - - patch2.add('_sys_battle', function (data: Block, callback?: () => void) { - // 检查战前事件 - const floor = core.floors[core.status.floorId]; - const beforeBattle: MotaEvent = []; - const loc = `${data.x},${data.y}` as LocString; - const enemy = getEnemy(data.x, data.y); - - beforeBattle.push(...(floor.beforeBattle[loc] ?? [])); - beforeBattle.push(...(enemy!.enemy.beforeBattle ?? [])); - - if (beforeBattle.length > 0) { - beforeBattle.push({ type: 'battle', x: data.x, y: data.y }); - core.clearContinueAutomaticRoute(); - - // 自动存档 - const inAction = core.status.event.id === 'action'; - if (inAction) { - core.insertAction(beforeBattle, data.x, data.y); - core.doAction(); - } else { - core.autosave(true); - core.insertAction(beforeBattle, data.x, data.y, callback); - } - } else { - battle(data.x, data.y, false, callback); - } - }); - - patch2.add('_action_battle', function (data, x, y, prefix) { - if (data.id) { - // const enemy = getSingleEnemy(data.id as EnemyIds); - // todo: 与不在地图上的怪物战斗 - } else { - if (data.floorId !== core.status.floorId) { - core.doAction(); - return; - } - const [ex, ey] = core.events.__action_getLoc( - data.loc, - x, - y, - prefix - ) as LocArr; - battle(ex, ey, true, core.doAction); - } - }); - - patch2.add( - 'afterBattle', - function (enemy: DamageEnemy, x?: number, y?: number) { - // 播放战斗动画 - let animate: AnimationIds = 'hand'; - // 检查当前装备是否存在攻击动画 - const equipId = core.getEquip(0); - if (equipId && (core.material.items[equipId].equip || {}).animate) - animate = core.material.items[equipId].equip.animate; - - // 检查该动画是否存在SE,如果不存在则使用默认音效 - if (!core.material.animates[animate]?.se) - core.playSound('attack.opus'); - - // 战斗伤害 - const info = enemy.getRealInfo(); - const damageInfo = enemy.calDamage(core.status.hero); - const damage = damageInfo.damage; - // 判定是否致死 - if (damage >= core.status.hero.hp) { - core.status.hero.hp = 0; - core.updateStatusBar(false, true); - core.events.lose('战斗失败'); - return; - } - - // 扣减体力值并记录统计数据 - core.status.hero.hp -= damage; - core.status.hero.statistics.battleDamage += damage; - core.status.hero.statistics.battle++; - - // 获得金币经验 - const money = core.hasFlag('curse') ? 0 : enemy.info.money!; - const exp = core.hasFlag('curse') ? 0 : enemy.info.exp!; - - core.status.hero.money += money; - core.status.hero.statistics.money += money; - core.status.hero.exp += exp; - core.status.hero.statistics.exp += exp; - - const hint = `打败 ${enemy.enemy.name},金币+${money},经验+${exp}`; - core.drawTip(hint, enemy.id); - - // 毒衰咒 - if (info.special.has(12)) core.setFlag('poison', true); - if (info.special.has(13)) core.setFlag('weak', true); - if (info.special.has(14)) core.setFlag('curse', true); - - // 仇恨 - if (info.special.has(17)) { - const hatred = state.flags.getFieldValueDefaults('hatred', 0); - core.setFlag('hatred', hatred / 2); - } else { - core.addFlag('hatred', core.values.hatred); - } - - // 自爆 - if (info.special.has(19)) { - core.status.hero.hp = 1; - } - - // 退化 - if (info.special.has(21)) { - core.status.hero.atk -= info.atkValue ?? 0; - core.status.hero.def -= info.defValue ?? 0; - } - - // 事件的处理 - const todo: MotaEvent = []; - - // 战后事件 - if (!isNil(core.status.floorId)) { - const loc = `${x},${y}` as LocString; - todo.push( - ...(core.floors[core.status.floorId].afterBattle[loc] ?? []) - ); - } - todo.push(...(enemy.enemy.afterBattle ?? [])); - - // 如果事件不为空,将其插入 - if (todo.length > 0) core.insertAction(todo, x, y); - - if (!isNil(x) && !isNil(y)) { - core.drawAnimate(animate, x, y); - core.removeBlock(x, y); - } else core.drawHeroAnimate(animate); - - // 如果已有事件正在处理中 - if (isNil(core.status.event.id)) core.continueAutomaticRoute(); - else core.clearContinueAutomaticRoute(); - - core.checkAutoEvents(); - - hook.emit('afterBattle', enemy, x, y); - } - ); -} - -declare global { - interface Enemys { - getCurrentEnemys(floorId: FloorIds): CurrentEnemy[]; - canBattle(enemy: DamageEnemy, _?: number, floorId?: FloorIds): boolean; - canBattle(x: number, y: number, floorId?: FloorIds): boolean; - } - - interface Events { - battle( - enemy: DamageEnemy, - y?: number, - force?: boolean, - callback?: () => void - ): void; - battle( - x: number, - y?: number, - force?: boolean, - callback?: () => void - ): void; - } -} diff --git a/packages-user/data-fallback/src/damage.ts b/packages-user/data-fallback/src/damage.ts deleted file mode 100644 index 19261bc..0000000 --- a/packages-user/data-fallback/src/damage.ts +++ /dev/null @@ -1,124 +0,0 @@ -import { Patch, PatchClass } from '@motajs/legacy-common'; -import { EnemyCollection, ensureFloorDamage } from '@user/data-state'; -import { formatDamage } from '@user/data-utils'; -import { isNil } from 'lodash-es'; - -export function patchDamage() { - const patch = new Patch(PatchClass.Control); - patch.add( - 'updateDamage', - function ( - floorId = core.status.floorId, - ctx, - thumbnail: boolean = false - ) { - if (!floorId || core.status.gameOver || main.mode !== 'play') - return; - const onMap = isNil(ctx); - const floor = core.status.maps[floorId]; - - // 没有怪物手册 - // if (!core.hasItem('book')) return; - core.status.damage.posX = core.bigmap.posX; - core.status.damage.posY = core.bigmap.posY; - if (!onMap) { - const width = core.floors[floorId].width, - height = core.floors[floorId].height; - // 地图过大的缩略图不绘制显伤 - if (width * height > core.bigmap.threshold) return; - } - // 计算伤害 - ensureFloorDamage(floorId); - - floor.enemy.extract(); - floor.enemy.calRealAttribute(); - floor.enemy.calMapDamage(); - floor.enemy.emit('calculated'); - core.status.damage.data = []; - - // floor.enemy.render(true); - - // getItemDetail(floorId, onMap); // 宝石血瓶详细信息 - if (thumbnail) { - renderThumbnailDamage(floor.enemy); - core.control.drawDamage(ctx, floorId); - } - } - ); -} - -function renderThumbnailDamage(col: EnemyCollection) { - if (main.replayChecking) return; - core.status.damage.data = []; - core.status.damage.extraData = []; - - // 怪物伤害 - col.list.forEach(v => { - const { damage } = v.calDamage(); - - // 伤害全部相等,绘制在怪物本身所在位置 - const { damage: dam, color } = formatDamage(damage); - const critical = v.calCritical(1)[0]; - core.status.damage.data.push({ - text: dam, - px: 32 * v.x! + 1, - py: 32 * (v.y! + 1) - 1, - color: color - }); - const setting = Mota.require('@motajs/legacy-ui').mainSetting; - const criGem = setting.getValue('screen.criticalGem', false); - const n = critical?.atkDelta ?? Infinity; - const ratio = core.status.maps[col.floorId].ratio; - const cri = criGem ? Math.ceil(n / ratio) : n; - - core.status.damage.data.push({ - text: isFinite(cri) ? cri.toString() : '?', - px: 32 * v.x! + 1, - py: 32 * (v.y! + 1) - 11, - color: '#fff' - }); - }); - - // 地图伤害 - const floor = core.status.maps[col.floorId]; - const width = floor.width; - const height = floor.height; - const objs = core.getMapBlocksObj(col.floorId); - - const startX = 0; - const endX = width; - const startY = 0; - const endY = height; - - for (let x = startX; x < endX; x++) { - for (let y = startY; y < endY; y++) { - const id = `${x},${y}` as LocString; - const dam = col.mapDamage[id]; - if (!dam || objs[id]?.event.noPass) continue; - - // 地图伤害 - if (dam.damage !== 0) { - const damage = core.formatBigNumber(dam.damage, true); - const color = dam.damage < 0 ? '#6eff6a' : '#fa3'; - core.status.damage.extraData.push({ - text: damage, - px: 32 * x + 16, - py: 32 * y + 16, - color, - alpha: 1 - }); - } - - // 追猎 - if (dam.ambush) { - core.status.damage.extraData.push({ - text: '!', - px: 32 * x + 16, - py: 32 * (y + 1) - 14, - color: '#fd4', - alpha: 1 - }); - } - } - } -} diff --git a/packages-user/data-fallback/src/index.ts b/packages-user/data-fallback/src/index.ts index 525aaa6..71800e6 100644 --- a/packages-user/data-fallback/src/index.ts +++ b/packages-user/data-fallback/src/index.ts @@ -1,12 +1,8 @@ import { ICoreState } from '@user/data-state'; -import { patchBattle } from './battle'; -import { patchDamage } from './damage'; import { patchFlags } from './flag'; import { patchHero } from './hero'; export function patchAll(state: ICoreState) { - patchBattle(); - patchDamage(); patchFlags(state); patchHero(state); } diff --git a/packages-user/data-state/src/enemy/damage.ts b/packages-user/data-state/src/enemy/damage.ts deleted file mode 100644 index 46d5774..0000000 --- a/packages-user/data-state/src/enemy/damage.ts +++ /dev/null @@ -1,813 +0,0 @@ -import { getHeroStatusOf, getHeroStatusOn } from '../legacy/hero'; -import { Range, ensureArray, has, manhattan } from '@user/data-utils'; -import EventEmitter from 'eventemitter3'; -import { hook } from '@user/data-base'; -import { - EnemyInfo, - DamageInfo, - DamageDelta, - HaloData, - CriticalDamageDelta, - MapDamage, - HaloFn, - IEnemyCollection, - IDamageEnemy, - HaloType, - IEnemyCollectionEvent -} from '@motajs/types'; - -export class EnemyCollection - extends EventEmitter - implements IEnemyCollection -{ - floorId: FloorIds; - list: Map = new Map(); - - range: Range = new Range(); - /** 地图伤害 */ - mapDamage: Record = {}; - haloList: HaloData[] = []; - - /** 楼层宽度 */ - width: number = 0; - /** 楼层高度 */ - height: number = 0; - - constructor(floorId: FloorIds) { - super(); - this.floorId = floorId; - this.extract(); - } - - get(x: number, y: number) { - const index = x + y * this.width; - return this.list.get(index) ?? null; - } - - /** - * 解析本地图的怪物信息 - */ - extract() { - this.list.clear(); - core.extractBlocks(this.floorId); - const floor = core.status.maps[this.floorId]; - this.width = floor.width; - this.height = floor.height; - floor.blocks.forEach(v => { - if (v.disable) return; - if (v.event.cls !== 'enemy48' && v.event.cls !== 'enemys') return; - const { x, y } = v; - const index = x + y * this.width; - const enemy = core.material.enemys[v.event.id as EnemyIds]; - this.list.set( - index, - new DamageEnemy(enemy, v.x, v.y, this.floorId, this) - ); - }); - this.emit('extract'); - hook.emit('enemyExtract', this); - } - - /** - * 计算怪物真实属性 - */ - calRealAttribute() { - this.haloList = []; - this.list.forEach(v => { - v.reset(); - }); - this.list.forEach(v => { - v.preProvideHalo(); - }); - this.list.forEach(v => { - v.calAttribute(); - v.provideHalo(); - }); - this.list.forEach(v => { - v.getRealInfo(); - }); - } - - /** - * 计算怪物伤害 - * @param noCache 是否不使用缓存 - */ - calDamage(noCache: boolean = false) { - if (noCache) this.calRealAttribute(); - this.list.forEach(v => { - v.calDamage(void 0); - }); - } - - /** - * 计算地图伤害 - */ - calMapDamage() { - this.mapDamage = {}; - const hero = getHeroStatusOn(realStatus, this.floorId); - this.list.forEach(v => { - v.calMapDamage(this.mapDamage, hero); - }); - } - - /** - * 向怪物施加光环 - * @param type 光环的范围类型 - * @param data 光环范围信息 - * @param halo 光环效果函数 - * @param recursion 是否递归施加,只有在光环预平衡阶段会使用到 - */ - applyHalo( - type: K, - data: HaloType[K], - enemy: DamageEnemy, - halo: HaloFn | HaloFn[], - recursion: boolean = false - ) { - const arr = ensureArray(halo); - const enemys = this.range.type(type).scan(this.list.values(), data); - if (!recursion) { - arr.forEach(v => { - enemys.forEach(e => { - e.injectHalo(v, enemy.info); - }); - }); - } else { - enemys.forEach(e => { - arr.forEach(v => { - e.injectHalo(v, enemy.info); - e.preProvideHalo(); - }); - }); - } - } - - /** - * 预平衡光环 - */ - preBalanceHalo() { - this.list.forEach(v => { - v.preProvideHalo(); - }); - } -} - -export class DamageEnemy implements IDamageEnemy { - id: EnemyIds; - x?: number; - y?: number; - floorId?: FloorIds; - enemy: Enemy; - col?: EnemyCollection; - - /** - * 怪物属性。 - * 属性计算流程:预平衡光环(即计算加光环的光环怪的光环) -> 计算怪物在没有光环下的属性 - * -> provide inject 光环 -> 计算怪物的光环加成 -> 计算完毕 - */ - info!: EnemyInfo; - - /** 向其他怪提供过的光环 */ - providedHalo: Set = new Set(); - - /** - * 伤害计算进度,0 -> 预平衡光环 -> 1 -> 计算没有光环的属性 -> 2 -> provide inject 光环 - * -> 3 -> 计算光环加成 -> 4 -> 计算完毕 - */ - progress: number = 0; - - constructor( - enemy: Enemy, - x?: number, - y?: number, - floorId?: FloorIds, - col?: EnemyCollection - ) { - this.id = enemy.id; - this.enemy = enemy; - this.x = x; - this.y = y; - this.floorId = floorId; - this.col = col; - this.reset(); - } - - reset() { - const enemy = this.enemy; - this.info = { - hp: enemy.hp, - atk: enemy.atk, - def: enemy.def, - special: new Set(enemy.special), - atkBuff_: 0, - defBuff_: 0, - hpBuff_: 0, - guard: [], - enemy: this.enemy, - x: this.x, - y: this.y, - floorId: this.floorId - }; - - for (const [key, value] of Object.entries(enemy)) { - if (!(key in this.info) && has(value)) { - // @ts-expect-error 无法推导 - this.info[key] = value; - } - } - this.progress = 0; - this.providedHalo.clear(); - } - - /** - * 计算怪物在不计光环下的属性,在inject光环之前,预平衡光环之后执行 - */ - calAttribute() { - if (this.progress !== 1 && has(this.x) && has(this.floorId)) return; - this.progress = 2; - const special = this.info.special; - const info = this.info; - - const { atk = 0, def = 0 } = getHeroStatusOn(realStatus); - - // 坚固 - if (special.has(3)) { - info.def = Math.max(info.def, atk - 1); - } - - // 模仿 - if (special.has(10)) { - info.atk = atk; - info.def = def; - } - } - - /** - * 获取怪物的真实属性信息,在inject光环后执行 - */ - getRealInfo() { - if (this.progress < 3 && has(this.x) && has(this.floorId)) { - throw new Error( - `Unexpected early real info calculating. Progress: ${this.progress}` - ); - } - if (this.progress === 4) return this.info; - this.progress = 4; - - // 此时已经inject光环,因此直接计算真实属性 - const info = this.info; - - info.atk = Math.floor(info.atk * (info.atkBuff_ / 100 + 1)); - info.def = Math.floor(info.def * (info.defBuff_ / 100 + 1)); - info.hp = Math.floor(info.hp * (info.hpBuff_ / 100 + 1)); - - return this.info; - } - - /** - * 光环预提供,用于平衡所有怪的光环属性,避免出现不同情况下光环效果不一致的现象 - */ - preProvideHalo() { - if (this.progress !== 0) return; - this.progress = 1; - if (!this.floorId) return; - if (!has(this.x) || !has(this.y)) return; - - // 这里可以做优先级更高的光环,比如加光环的光环怪等,写法与 provideHalo 类似 - - // e 是被加成怪的属性,enemy 是施加光环的怪 - } - - /** - * 向其他怪提供光环 - */ - provideHalo() { - if (this.progress !== 2) return; - this.progress = 3; - if (!this.floorId) return; - if (!has(this.x) || !has(this.y)) return; - const col = this.col ?? core.status.maps[this.floorId].enemy; - if (!col) return; - const special = this.info.special; - - // e 是被加成怪的属性,enemy 是施加光环的怪 - - // 普通光环 - if (special.has(25)) { - // 光环效果,这里直接增加 e 的 buff 属性 - const halo = (e: EnemyInfo, enemy: EnemyInfo) => { - if (enemy.haloAdd) { - e.hpBuff_ += enemy.hpBuff ?? 0; - e.atkBuff_ += enemy.atkBuff ?? 0; - e.defBuff_ += enemy.defBuff ?? 0; - } else { - e.hpBuff_ = Math.max(e.hpBuff_, enemy.hpBuff ?? 0); - e.atkBuff_ = Math.max(e.atkBuff_, enemy.atkBuff ?? 0); - e.defBuff_ = Math.max(e.defBuff_, enemy.defBuff ?? 0); - } - }; - // 根据范围施加光环 - const range = this.info.haloRange ?? 1; - if (this.info.haloSquare) { - col.applyHalo( - 'square', - { x: this.x, y: this.y, d: range * 2 + 1 }, - this, - halo - ); - } else { - col.applyHalo( - 'manhattan', - { x: this.x, y: this.y, d: range }, - this, - halo - ); - } - } - - // 支援也是一类光环 - if (special.has(26)) { - col.applyHalo( - 'square', - { x: this.x, y: this.y, d: 3 }, - this, - (e, enemy) => { - e.guard.push(enemy); - } - ); - } - } - - /** - * 接受其他怪的光环 - */ - injectHalo(halo: HaloFn, enemy: EnemyInfo) { - halo(this.info, enemy); - } - - /** - * 计算怪物伤害 - */ - calDamage(hero: Partial = core.status.hero): DamageInfo { - const enemy = this.getRealInfo(); - return this.calEnemyDamageOf(hero, enemy); - } - - /** - * 计算地图伤害 - * @param damage 存入的对象 - */ - calMapDamage( - damage: Record = {}, - _hero: Partial = getHeroStatusOn(realStatus) - ) { - if (!has(this.x) || !has(this.y) || !has(this.floorId)) return damage; - const enemy = this.enemy; - const floor = core.status.maps[this.floorId]; - const w = floor.width; - const h = floor.height; - const objs = core.getMapBlocksObj(this.floorId); - - // 领域 - if (this.info.special.has(15)) { - const range = enemy.range ?? 1; - const startX = Math.max(0, this.x - range); - const startY = Math.max(0, this.y - range); - const endX = Math.min(floor.width - 1, this.x + range); - const endY = Math.min(floor.height - 1, this.y + range); - const dam = Math.max(enemy.zone ?? 0, 0); - - for (let x = startX; x <= endX; x++) { - for (let y = startY; y <= endY; y++) { - if ( - !enemy.zoneSquare && - manhattan(x, y, this.x, this.y) > range - ) { - // 如果是十字范围而且曼哈顿距离大于范围,则跳过此格 - continue; - } - const loc = `${x},${y}` as LocString; - if (objs[loc]?.event.noPass) continue; - this.setMapDamage(damage, loc, dam, '领域'); - } - } - } - - // 激光 - if (this.info.special.has(24)) { - const dirs: Dir[] = ['left', 'down', 'up', 'right']; - const dam = Math.max(enemy.laser ?? 0, 0); - - for (const dir of dirs) { - let x = this.x; - let y = this.y; - const { x: dx, y: dy } = core.utils.scan[dir]; - while (x >= 0 && y >= 0 && x < w && y < h) { - x += dx; - y += dy; - const loc = `${x},${y}` as LocString; - if (objs[loc]?.event.noPass) continue; - this.setMapDamage(damage, loc, dam, '激光'); - } - } - } - - // 阻击 - if (this.info.special.has(18)) { - const dirs: Dir[] = ['left', 'down', 'up', 'right']; - for (const dir of dirs) { - const { x: dx, y: dy } = core.utils.scan[dir]; - const x = this.x + dx; - const y = this.y + dy; - const loc = `${x},${y}` as LocString; - if (objs[loc]?.event.noPass) continue; - this.setMapDamage(damage, loc, this.info.repulse ?? 0, '阻击'); - damage[loc].repulse ??= []; - damage[loc].repulse.push([this.x, this.y]); - } - } - - // 捕捉 - if (this.info.special.has(27)) { - const dirs: Dir[] = ['left', 'down', 'up', 'right']; - for (const dir of dirs) { - const { x: dx, y: dy } = core.utils.scan[dir]; - const x = this.x + dx; - const y = this.y + dy; - const loc = `${x},${y}` as LocString; - if (objs[loc]?.event.noPass) continue; - damage[loc] ??= { damage: 0, type: new Set() }; - damage[loc].ambush ??= []; - damage[loc].ambush.push([this.x, this.y]); - } - } - - // 夹击 - if (this.info.special.has(16)) { - // 只计算右方和下方的怪物,这样就可以避免一个点被重复计算两次 - const dirs: Dir[] = ['down', 'right']; - for (const dir of dirs) { - const { x: dx, y: dy } = core.utils.scan[dir]; - const x = this.x + dx * 2; - const y = this.y + dy * 2; - const e = this.col?.get(x, y); - if (!e) continue; - const info = e.getRealInfo(); - if (!info.special.has(16)) continue; - const cx = this.x + dx; - const cy = this.y + dy; - const loc = `${cx},${cy}` as LocString; - if (objs[loc]?.event.noPass) continue; - const half = getHeroStatusOn('hp') / 2; - let bt = half; - // 夹击不超伤害值 - if (core.flags.betweenAttackMax) { - const aDamage = this.calDamage().damage; - const bDamage = e.calDamage().damage; - bt = Math.min(aDamage, bDamage, half); - } - this.setMapDamage(damage, loc, bt, '夹击'); - } - } - - return damage; - } - - private setMapDamage( - damage: Record, - loc: string, - dam: number, - type: string - ) { - damage[loc] ??= { damage: 0, type: new Set() }; - damage[loc].damage += dam; - if (type) damage[loc].type.add(type); - } - - private calEnemyDamageOf( - hero: Partial, - enemy: EnemyInfo - ): DamageInfo { - const status = getHeroStatusOf(hero, realStatus, this.floorId); - const damage = calDamageWith(enemy, status) ?? Infinity; - - return { damage }; - } - - /** - * 计算怪物临界,计算临界时,根据当前方向计算临界,但也会输出与当前最少伤害的伤害差值 - * @param num 要计算多少个临界 - * @param dir 从怪物位置指向勇士的方向 - * @param hero 勇士属性,最终结果将会与由此属性计算出的伤害相减计算减伤 - */ - calCritical( - num: number = 1, - hero: Partial = core.status.hero - ): CriticalDamageDelta[] { - const origin = this.calDamage(hero); - const seckill = this.getSeckillAtk(); - return this.calCriticalWith(num, seckill, origin, hero); - } - - /** - * 二分计算怪物临界 - * @param num 计算的临界数量 - * @param min 当前怪物伤害最小值 - * @param seckill 秒杀怪物时的攻击 - * @param hero 勇士真实属性 - */ - private calCriticalWith( - num: number, - seckill: number, - origin: DamageInfo, - hero: Partial - ): CriticalDamageDelta[] { - if (!isFinite(seckill)) return []; - - const res: CriticalDamageDelta[] = []; - const def = hero.def!; - const precision = - (seckill < Number.MAX_SAFE_INTEGER ? 1 : seckill / 1e15) * 2; - const enemy = this.getRealInfo(); - - let curr = hero.atk!; - let start = curr; - let end = seckill; - let ori = origin.damage; - - const status = { atk: curr, def }; - - const calDam = () => { - status.atk = curr; - return this.calEnemyDamageOf(status, enemy).damage; - }; - - let i = 0; - while (res.length < num) { - if (end - start <= precision) { - // 到达二分所需精度,计算临界准确值 - let cal = false; - for (const v of [(start + end) / 2, end]) { - curr = v; - const dam = calDam(); - if (dam < ori) { - res.push({ - damage: dam, - atkDelta: Math.ceil(v - hero.atk!), - delta: -(dam - origin.damage) - }); - - start = v; - end = seckill; - cal = true; - ori = dam; - break; - } - } - if (!cal) break; - } - curr = Math.floor((start + end) / 2); - - const damage = calDam(); - - if (damage < ori) { - end = curr; - } else { - start = curr; - } - if (i++ >= 10000) { - // eslint-disable-next-line no-console - console.warn( - `Unexpected endless loop in calculating critical.` + - `Enemy Id: ${this.id}. Loc: ${this.x},${this.y}. Floor: ${this.floorId}` - ); - break; - } - } - - if (res.length === 0) { - curr = hero.atk!; - const dam = calDam(); - res.push({ - damage: dam, - atkDelta: 0, - delta: 0 - }); - } - - return res; - } - - /** - * 计算n防减伤 - * @param num 要加多少防御 - * @param dir 从怪物位置指向勇士的方向 - * @param hero 勇士属性,最终结果将会与由此属性计算出的伤害相减计算减伤 - */ - calDefDamage( - num: number = 1, - hero: Partial = core.status.hero - ): DamageDelta { - const damage = this.calDamage({ - def: (hero.def ?? core.status.hero.def) + num - }); - const origin = this.calDamage(hero); - const finite = isFinite(damage.damage); - - return { - damage: damage.damage, - info: damage, - delta: -(finite ? damage.damage - origin.damage : Infinity) - }; - } - - /** - * 获取怪物秒杀时所需的攻击 - */ - getSeckillAtk(): number { - const info = this.getRealInfo(); - - // 坚固,不可能通过攻击秒杀 - if (info.special.has(3)) { - return Infinity; - } - - // 常规怪物秒杀攻击是怪物防御+怪物生命 - return info.def + info.hp; - } -} - -export interface DamageWithTurn { - damage: number; - turn: number; -} - -/** - * 计算伤害时会用到的勇士属性,攻击防御,其余的不会有buff加成,直接从core.status.hero取 - * 如果有属性不会被 buff 加成请在这里去除,有助于提高性能表现 - */ -const realStatus: (keyof HeroStatus)[] = ['atk', 'def', 'mdef', 'hpmax']; - -/** 当前是否正在计算支援怪的伤害 */ -let inGuard = false; - -/** - * 计算伤害,返回值包含伤害与回合数 - * @param info 怪物信息 - * @param hero 勇士真实属性 - */ -export function calDamageWithTurn( - info: EnemyInfo, - hero: Partial -): DamageWithTurn { - const { hp } = core.status.hero; - const { atk, def, mdef } = hero as HeroStatus; - const { atk: monAtk, def: monDef, special } = info; - let { hp: monHp } = info; - - // 无敌 - if (special.has(20) && core.itemCount('cross') < 1) { - return { damage: Infinity, turn: 0 }; - } - - /** 怪物会对勇士造成的总伤害 */ - let damage = 0; - - /** 勇士每轮造成的伤害 */ - let heroPerDamage: number = 0; - /** 怪物每轮造成的伤害 */ - let enemyPerDamage: number = 0; - - // 勇士每轮伤害为勇士攻击减去怪物防御 - heroPerDamage += atk - monDef; - - // 吸血 - if (special.has(11)) { - const vampire = info.vampire ?? 0; - const value = (vampire / 100) * hp; - damage += value; - // 如果吸血加到自身 - if (info.add) { - monHp += value; - } - } - - // 魔攻 - if (special.has(2)) { - enemyPerDamage = monAtk; - } else { - enemyPerDamage = monAtk - def; - } - - // 连击 - if (special.has(4)) enemyPerDamage *= 2; - if (special.has(5)) enemyPerDamage *= 3; - if (special.has(6)) enemyPerDamage *= info.n!; - - if (enemyPerDamage < 0) enemyPerDamage = 0; - - let turn = Math.ceil(monHp / heroPerDamage); - - // 支援,当怪物被支援且不包含支援标记时执行,因为支援怪不能再被支援了 - if (info.guard.length > 0 && !inGuard) { - inGuard = true; - // 支援中魔防只会被计算一次,因此除了当前怪物,计算其他怪物伤害时魔防为 0 - const status = { ...hero, mdef: 0 }; - // 计算支援怪的伤害,同时把打支援怪花费的回合数加到当前怪物上,因为打支援怪的时候当前怪物也会打你 - // 因此回合数需要加上打支援怪的回合数 - for (const enemy of info.guard) { - // 直接把 enemy 传过去,因此支援的 enemy 会吃到其原本所在位置的光环加成 - const extraInfo = calDamageWithTurn(enemy, status); - turn += extraInfo.turn; - damage += extraInfo.damage; - } - inGuard = false; - } - - // 先攻 - if (special.has(1)) { - damage += enemyPerDamage; - } - - // 破甲 - if (special.has(7)) { - const value = info.breakArmor ?? core.values.breakArmor; - damage += (value / 100) * def; - } - - // 反击 - if (special.has(8)) { - const value = info.counterAttack ?? core.values.counterAttack; - // 反击是每回合生效,因此加到 enemyPerDamage 上 - enemyPerDamage += (value / 100) * atk; - } - - // 净化 - if (special.has(9)) { - const value = info.purify ?? core.values.purify; - damage += mdef * value; - } - - damage += (turn - 1) * enemyPerDamage; - - // 魔防 - damage -= mdef; - - // 未开启负伤时,如果伤害为负,则设为 0 - if (!core.flags.enableNegativeDamage && damage < 0) { - damage = 0; - } - - // 固伤,无法被魔防减伤 - if (special.has(22)) { - damage += info.damage ?? 0; - } - - // 仇恨,无法被魔防减伤 - if (special.has(17)) { - damage += core.getFlag('hatred', 0); - } - - return { damage: Math.floor(damage), turn }; -} - -/** - * 计算怪物伤害 - * @param info 怪物信息 - * @param hero 勇士信息 - */ -export function calDamageWith( - info: EnemyInfo, - hero: Partial -): number { - return calDamageWithTurn(info, hero).damage; -} - -export function ensureFloorDamage(floorId: FloorIds) { - const floor = core.status.maps[floorId]; - floor.enemy ??= new EnemyCollection(floorId); -} - -export function getSingleEnemy(id: EnemyIds) { - const e = core.material.enemys[id]; - const enemy = new DamageEnemy(e); - enemy.calAttribute(); - enemy.getRealInfo(); - enemy.calDamage(core.status.hero); - return enemy; -} - -export function getEnemy( - x: number, - y: number, - floorId: FloorIds = core.status.floorId -) { - const enemy = core.status.maps[floorId].enemy.get(x, y); - return enemy; -} - -declare global { - interface Floor { - enemy: EnemyCollection; - } -} diff --git a/packages-user/data-utils/src/index.ts b/packages-user/data-utils/src/index.ts index 43ce4e4..04bca77 100644 --- a/packages-user/data-utils/src/index.ts +++ b/packages-user/data-utils/src/index.ts @@ -1,2 +1 @@ -export * from './range'; export * from './utils'; diff --git a/packages-user/data-utils/src/range.ts b/packages-user/data-utils/src/range.ts deleted file mode 100644 index 5c73819..0000000 --- a/packages-user/data-utils/src/range.ts +++ /dev/null @@ -1,86 +0,0 @@ -import { isNil } from 'lodash-es'; - -interface RangeTypeData { - square: { x: number; y: number; d: number }; - rect: { x: number; y: number; w: number; h: number }; - manhattan: { x: number; y: number; d: number }; -} - -type InRangeFn, T> = (item: E, data: T) => boolean; - -export class Range { - static rangeType: Record = {}; - - /** - * 获取一个范围类型,并进行判断 - * @param type 范围类型 - */ - type( - type: T - ): T extends keyof RangeTypeData ? RangeType : RangeType { - return Range.rangeType[type] as T extends keyof RangeTypeData - ? RangeType - : RangeType; - } - - /** - * 注册一个新的范围类型 - * @param type 范围类型 - * @param fn 判断是否在范围内的函数 - */ - static register( - type: K, - fn: InRangeFn, RangeTypeData[K]> - ): void; - static register(type: string, fn: InRangeFn, any>): void; - static register(type: string, fn: InRangeFn, any>): void { - const range = new RangeType(type, fn); - this.rangeType[type] = range; - } -} - -class RangeType { - readonly type: string; - /** - * 判断一个元素是否在指定范围内 - * @param item 要判断的元素 - * @param data 范围数据 - */ - readonly inRange: InRangeFn, Type>; - - constructor(type: string, fn: InRangeFn, Type>) { - this.type = type; - this.inRange = fn; - } - - /** - * 扫描一个列表中所有在范围内的元素 - * @param items 元素列表 - * @param data 范围数据 - */ - scan>(items: Iterable, data: Type): T[] { - const res: T[] = []; - for (const ele of items) { - if (this.inRange(ele, data)) { - res.push(ele); - } - } - return res; - } -} - -Range.register('square', (item, { x, y, d }) => { - if (isNil(item.x) || isNil(item.y)) return false; - const r = Math.floor(d / 2); - return Math.abs(item.x - x) <= r && Math.abs(item.y - y) <= r; -}); -Range.register('rect', (item, { x, y, w, h }) => { - if (isNil(item.x) || isNil(item.y)) return false; - const ex = x + w; - const ey = y + h; - return item.x >= x && item.y >= y && item.x < ex && item.y < ey; -}); -Range.register('manhattan', (item, { x, y, d }) => { - if (isNil(item.x) || isNil(item.y)) return false; - return Math.abs(item.x - x) + Math.abs(item.y - y) < d; -}); diff --git a/packages-user/legacy-plugin-data/src/enemy/checkblock.ts b/packages-user/legacy-plugin-data/src/enemy/checkblock.ts deleted file mode 100644 index f1294a9..0000000 --- a/packages-user/legacy-plugin-data/src/enemy/checkblock.ts +++ /dev/null @@ -1,91 +0,0 @@ -import { DamageEnemy } from '@user/data-state'; -import { findDir, ofDir } from '@user/data-utils'; - -export function createCheckBlock() { - // 地图伤害在这实现。2.C 会修改实现方式 - control.prototype.checkBlock = function () { - const heroLoc = core.status.hero.loc; - const { x, y } = heroLoc; - const loc = `${x},${y}`; - const col = core.status.thisMap.enemy; - const info = col.mapDamage[loc]; - if (!info) return; - const damage = info.damage; - - // 阻击夹域伤害 - if (damage) { - core.status.hero.hp -= damage; - const type = [...info.type]; - const text = type.join(',') || '伤害'; - core.drawTip('受到' + text + damage + '点'); - core.drawHeroAnimate('zone'); - this._checkBlock_disableQuickShop(); - core.status.hero.statistics.extraDamage += damage; - if (core.status.hero.hp <= 0) { - core.status.hero.hp = 0; - core.updateStatusBar(); - core.events.lose(); - return; - } else { - core.updateStatusBar(); - } - } - - const actions: MotaAction[] = []; - - // 阻击效果 - if (info.repulse) { - for (const [x, y] of info.repulse) { - const loc2 = { x, y }; - const dir = findDir(heroLoc, loc2); - if (dir === 'none') continue; - const [nx, ny] = ofDir(x, y, dir); - if (core.noPass(nx, ny) || !core.canMoveHero(x, y, dir)) { - continue; - } - actions.push({ - type: 'move', - time: 250, - keep: true, - loc: [x, y], - steps: [`${dir}:1`], - async: true - }); - } - } - - /** 存储要和哪些捕捉怪战斗 */ - const ambushEnemies: DamageEnemy[] = []; - - // 捕捉效果 - if (info.ambush) { - for (const [x, y] of info.ambush) { - const loc2 = { x, y }; - const dir = findDir(loc2, heroLoc); - if (dir === 'none') continue; - actions.push({ - type: 'move', - time: 250, - keep: false, - loc: [x, y], - steps: [`${dir}:1`], - async: true - }); - const enemy = col.get(x, y); - if (enemy) { - ambushEnemies.push(enemy); - } - } - } - - if (actions.length > 0) { - actions.push({ type: 'waitAsync' }); - // 与捕捉怪战斗 - core.insertAction(actions, void 0, void 0, () => { - ambushEnemies.forEach(v => { - core.battle(v, v.y, true); - }); - }); - } - }; -} diff --git a/packages-user/legacy-plugin-data/src/enemy/index.ts b/packages-user/legacy-plugin-data/src/enemy/index.ts deleted file mode 100644 index c3a151a..0000000 --- a/packages-user/legacy-plugin-data/src/enemy/index.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { createCheckBlock } from './checkblock'; - -export function createEnemy() { - createCheckBlock(); -} - -export * from './checkblock'; diff --git a/packages-user/legacy-plugin-data/src/index.ts b/packages-user/legacy-plugin-data/src/index.ts index 278ba30..fb04005 100644 --- a/packages-user/legacy-plugin-data/src/index.ts +++ b/packages-user/legacy-plugin-data/src/index.ts @@ -4,12 +4,10 @@ import { initFiveLayer } from './fiveLayer'; import { createHook } from './hook'; import { initReplay } from './replay'; import { initUI } from './ui'; -import { createEnemy } from './enemy'; export function createLegacy() { initFallback(); loading.once('coreInit', () => { - createEnemy(); initFiveLayer(); createHook(); initReplay(); @@ -17,7 +15,6 @@ export function createLegacy() { }); } -export * from './enemy'; export * from './fallback'; export * from './fiveLayer'; export * from './removeMap'; From 7428f41c9356755c61bafb85c90f841470bc2370 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 22:03:22 +0800 Subject: [PATCH 22/26] =?UTF-8?q?refactor:=20=E7=A7=BB=E9=99=A4=20data-uti?= =?UTF-8?q?ls=20=E5=8C=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/data-fallback/package.json | 3 +- packages-user/data-state/package.json | 3 +- packages-user/data-state/src/enemy/index.ts | 1 - packages-user/data-state/src/legacy/move.ts | 14 +- packages-user/data-utils/package.json | 6 - packages-user/data-utils/src/index.ts | 1 - packages-user/data-utils/src/utils.ts | 70 ----- packages-user/entry-data/package.json | 5 +- packages-user/entry-data/src/create.ts | 6 +- packages-user/entry-data/src/mota.ts | 8 +- packages-user/legacy-plugin-data/package.json | 5 +- .../legacy-plugin-data/src/fallback.ts | 34 +-- packages/legacy-ui/src/preset/uiIns.ts | 1 - packages/legacy-ui/src/tools/fly.ts | 72 ++--- packages/legacy-ui/src/ui/book.vue | 254 ------------------ packages/legacy-ui/src/ui/index.ts | 1 - 16 files changed, 76 insertions(+), 408 deletions(-) delete mode 100644 packages-user/data-utils/package.json delete mode 100644 packages-user/data-utils/src/index.ts delete mode 100644 packages-user/data-utils/src/utils.ts delete mode 100644 packages/legacy-ui/src/ui/book.vue diff --git a/packages-user/data-fallback/package.json b/packages-user/data-fallback/package.json index ddf8fb0..0c9d6f2 100644 --- a/packages-user/data-fallback/package.json +++ b/packages-user/data-fallback/package.json @@ -3,7 +3,6 @@ "dependencies": { "@motajs/legacy-common": "workspace:*", "@user/data-state": "workspace:*", - "@user/data-base": "workspace:*", - "@user/data-utils": "workspace:*" + "@user/data-base": "workspace:*" } } diff --git a/packages-user/data-state/package.json b/packages-user/data-state/package.json index e3e224d..e9a666b 100644 --- a/packages-user/data-state/package.json +++ b/packages-user/data-state/package.json @@ -5,7 +5,6 @@ "@motajs/common": "workspace:*", "@user/data-common": "workspace:*", "@user/data-base": "workspace:*", - "@user/data-system": "workspace:*", - "@user/data-utils": "workspace:*" + "@user/data-system": "workspace:*" } } diff --git a/packages-user/data-state/src/enemy/index.ts b/packages-user/data-state/src/enemy/index.ts index ae9c5d4..23e0ffc 100644 --- a/packages-user/data-state/src/enemy/index.ts +++ b/packages-user/data-state/src/enemy/index.ts @@ -1,7 +1,6 @@ export * from './aura'; export * from './calculator'; export * from './comparer'; -export * from './damage'; export * from './final'; export * from './legacy'; export * from './mapDamage'; diff --git a/packages-user/data-state/src/legacy/move.ts b/packages-user/data-state/src/legacy/move.ts index c91c047..0a0db29 100644 --- a/packages-user/data-state/src/legacy/move.ts +++ b/packages-user/data-state/src/legacy/move.ts @@ -272,13 +272,13 @@ export class HeroMover extends ObjectMoverBase { return super.startMove(); } - private checkAutoSave(x: number, y: number, nx: number, ny: number) { - const index = `${x},${y}`; - const nIndex = `${nx},${ny}`; - const map = core.status.thisMap.enemy.mapDamage; - const dam = map[index]; - const nextDam = map[nIndex]; - if (!dam || !nextDam) return; + private checkAutoSave(_x: number, _y: number, _nx: number, _ny: number) { + // const index = `${x},${y}`; + // const nIndex = `${nx},${ny}`; + // const map = core.status.thisMap.enemy.mapDamage; + // const dam = map[index]; + // const nextDam = map[nIndex]; + // if (!dam || !nextDam) return; // 可以在这里判断地图伤害,并进行自动存档,例如在进入或离开地图伤害时存档 // if (dam.damage > 0 || nextDam.damage > 0) { // core.autosave() diff --git a/packages-user/data-utils/package.json b/packages-user/data-utils/package.json deleted file mode 100644 index 2a42245..0000000 --- a/packages-user/data-utils/package.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "name": "@user/data-utils", - "dependencies": { - "@user/data-base": "workspace:*" - } -} \ No newline at end of file diff --git a/packages-user/data-utils/src/index.ts b/packages-user/data-utils/src/index.ts deleted file mode 100644 index 04bca77..0000000 --- a/packages-user/data-utils/src/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from './utils'; diff --git a/packages-user/data-utils/src/utils.ts b/packages-user/data-utils/src/utils.ts deleted file mode 100644 index 1e1df0d..0000000 --- a/packages-user/data-utils/src/utils.ts +++ /dev/null @@ -1,70 +0,0 @@ -const backDirMap: Record = { - up: 'down', - down: 'up', - left: 'right', - right: 'left', - leftup: 'rightdown', - rightup: 'leftdown', - leftdown: 'rightup', - rightdown: 'leftup' -}; - -export function backDir(dir: Dir): Dir; -export function backDir(dir: Dir2): Dir2; -export function backDir(dir: Dir2): Dir2 { - return backDirMap[dir]; -} - -export function has(v: T): v is NonNullable { - return v !== null && v !== void 0; -} - -export function ensureArray(arr: T): T extends any[] ? T : T[] { - // @ts-expect-error 需要弃用 - return arr instanceof Array ? arr : [arr]; -} - -export function ofDir(x: number, y: number, dir: Dir2): LocArr { - const { x: dx, y: dy } = core.utils.scan2[dir]; - return [x + dx, y + dy]; -} - -/** - * 计算曼哈顿距离 - */ -export function manhattan(x1: number, y1: number, x2: number, y2: number) { - return Math.abs(x1 - x2) + Math.abs(y1 - y2); -} - -export function formatDamage(damage: number): DamageString { - let dam = ''; - let color = ''; - if (!Number.isFinite(damage)) { - dam = '???'; - color = '#f22'; - } else { - dam = core.formatBigNumber(damage, true); - if (damage <= 0) color = '#1f1'; - else if (damage < core.status.hero.hp / 3) color = '#fff'; - else if (damage < (core.status.hero.hp * 2) / 3) color = '#ff0'; - else if (damage < core.status.hero.hp) color = '#f93'; - else color = '#f22'; - } - - return { damage: dam, color: color as Color }; -} - -/** - * 获取两个坐标的相对方向 - * @param from 初始坐标 - * @param to 指向坐标 - */ -export function findDir(from: Loc, to: Loc): Dir | 'none' { - const dx = Math.sign(to.x - from.x); - const dy = Math.sign(to.y - from.y); - return ( - (Object.entries(core.utils.scan).find(v => { - return v[1].x === dx && v[1].y === dy; - })?.[0] as Dir) ?? 'none' - ); -} diff --git a/packages-user/entry-data/package.json b/packages-user/entry-data/package.json index c2e0e05..fc2b3c0 100644 --- a/packages-user/entry-data/package.json +++ b/packages-user/entry-data/package.json @@ -2,10 +2,11 @@ "name": "@user/entry-data", "dependencies": { "@motajs/legacy-common": "workspace:*", + "@user/data-common": "workspace:*", "@user/data-base": "workspace:*", + "@user/data-system": "workspace:*", "@user/data-fallback": "workspace:*", "@user/data-state": "workspace:*", - "@user/data-utils": "workspace:*", "@user/legacy-plugin-data": "workspace:*" } -} \ No newline at end of file +} diff --git a/packages-user/entry-data/src/create.ts b/packages-user/entry-data/src/create.ts index b52b60e..95be547 100644 --- a/packages-user/entry-data/src/create.ts +++ b/packages-user/entry-data/src/create.ts @@ -1,10 +1,11 @@ import { Mota } from './mota'; import * as Common from '@motajs/common'; import * as LegacyCommon from '@motajs/legacy-common'; +import * as DataCommon from '@user/data-common'; import * as DataBase from '@user/data-base'; +import * as DataSystem from '@user/data-system'; import * as DataFallback from '@user/data-fallback'; import * as DataState from '@user/data-state'; -import * as DataUtils from '@user/data-utils'; import * as LegacyPluginData from '@user/legacy-plugin-data'; export function create() { @@ -12,10 +13,11 @@ export function create() { Mota.register('@motajs/common', Common); Mota.register('@motajs/legacy-common', LegacyCommon); + Mota.register('@user/data-common', DataCommon); Mota.register('@user/data-base', DataBase); + Mota.register('@user/data-system', DataSystem); Mota.register('@user/data-fallback', DataFallback); Mota.register('@user/data-state', DataState); - Mota.register('@user/data-utils', DataUtils); Mota.register('@user/legacy-plugin-data', LegacyPluginData); DataBase.loading.emit('dataRegistered'); diff --git a/packages-user/entry-data/src/mota.ts b/packages-user/entry-data/src/mota.ts index 1a467e9..c9106e0 100644 --- a/packages-user/entry-data/src/mota.ts +++ b/packages-user/entry-data/src/mota.ts @@ -10,10 +10,11 @@ import type * as RenderVue from '@motajs/render-vue'; import type * as System from '@motajs/system'; import type * as UserClientBase from '@user/client-base'; import type * as ClientModules from '@user/client-modules'; +import type * as DataCommon from '@user/data-common'; import type * as DataBase from '@user/data-base'; -import type * as DataFallback from '@user/data-fallback'; +import type * as DataSystem from '@user/data-system'; import type * as DataState from '@user/data-state'; -import type * as DataUtils from '@user/data-utils'; +import type * as DataFallback from '@user/data-fallback'; import type * as LegacyPluginClient from '@user/legacy-plugin-client'; import type * as LegacyPluginData from '@user/legacy-plugin-data'; // ---------- 必要的第三方库 @@ -34,10 +35,11 @@ interface ModuleInterface { '@motajs/system': typeof System; '@user/client-base': typeof UserClientBase; '@user/client-modules': typeof ClientModules; + '@user/data-common': typeof DataCommon; '@user/data-base': typeof DataBase; + '@user/data-system': typeof DataSystem; '@user/data-fallback': typeof DataFallback; '@user/data-state': typeof DataState; - '@user/data-utils': typeof DataUtils; '@user/legacy-plugin-client': typeof LegacyPluginClient; '@user/legacy-plugin-data': typeof LegacyPluginData; // ---------- 必要的第三方库 diff --git a/packages-user/legacy-plugin-data/package.json b/packages-user/legacy-plugin-data/package.json index 2cd40c9..b04c0a0 100644 --- a/packages-user/legacy-plugin-data/package.json +++ b/packages-user/legacy-plugin-data/package.json @@ -2,7 +2,6 @@ "name": "@user/legacy-plugin-data", "dependencies": { "@user/data-state": "workspace:*", - "@user/data-base": "workspace:*", - "@user/data-utils": "workspace:*" + "@user/data-base": "workspace:*" } -} \ No newline at end of file +} diff --git a/packages-user/legacy-plugin-data/src/fallback.ts b/packages-user/legacy-plugin-data/src/fallback.ts index a69fb7b..1dde98a 100644 --- a/packages-user/legacy-plugin-data/src/fallback.ts +++ b/packages-user/legacy-plugin-data/src/fallback.ts @@ -325,8 +325,8 @@ export function initFallback() { callback?.(); }; - const layer = state.maps.getLayerByAlias('event')!; - layer.openDoor(x, y).then(cb); + // const layer = state.maps.getLayerByAlias('event')!; + // layer.openDoor(x, y).then(cb); const animate = fallbackIds++; core.animateFrame.lastAsyncId = animate; @@ -373,9 +373,9 @@ export function initFallback() { if (core.status.replay.speed === 24) { cb(); } else { - const num = state.tileStore.idToNumber(id)!; - const layer = state.maps.getLayerByAlias('event')!; - layer.closeDoor(num, x, y).then(cb); + // const num = state.tileStore.idToNumber(id)!; + // const layer = state.maps.getLayerByAlias('event')!; + // layer.closeDoor(num, x, y).then(cb); const animate = fallbackIds++; core.animateFrame.lastAsyncId = animate; @@ -515,20 +515,20 @@ export function initFallback() { // 先使用 mainMapRenderer 妥协 const { client } = Mota.require('@user/client-modules'); const renderer = client.mainMapRenderer; - if (renderer.layerState !== state.maps) { - callback?.(); - return; - } - const layer = state.maps.getLayerByAlias('event'); - if (!layer) { - callback?.(); - return; - } + // if (renderer.layerState !== state.maps) { + // callback?.(); + // return; + // } + // const layer = state.maps.getLayerByAlias('event'); + // if (!layer) { + // callback?.(); + // return; + // } core.removeBlock(sx, sy); - const moving = renderer.addMovingBlock(layer, block.id, sx, sy); + // const moving = renderer.addMovingBlock(layer, block.id, sx, sy); core.updateStatusBar(); - await moving.moveRelative(fn, time); - moving.destroy(); + // await moving.moveRelative(fn, time); + // moving.destroy(); if (keep) { core.setBlock(block.id, ex, ey); diff --git a/packages/legacy-ui/src/preset/uiIns.ts b/packages/legacy-ui/src/preset/uiIns.ts index aac5eef..79cf479 100644 --- a/packages/legacy-ui/src/preset/uiIns.ts +++ b/packages/legacy-ui/src/preset/uiIns.ts @@ -4,7 +4,6 @@ import { VirtualKey } from '@motajs/legacy-system'; export const mainUi = new UiController(); mainUi.register( - new GameUi('book', UI.Book), new GameUi('toolbox', UI.Toolbox), new GameUi('equipbox', UI.Equipbox), new GameUi('settings', UI.Settings), diff --git a/packages/legacy-ui/src/tools/fly.ts b/packages/legacy-ui/src/tools/fly.ts index a28a961..fc8fc1c 100644 --- a/packages/legacy-ui/src/tools/fly.ts +++ b/packages/legacy-ui/src/tools/fly.ts @@ -522,45 +522,45 @@ export class MinimapDrawer { ctx.textBaseline = 'middle'; ctx.font = `3px "normal"`; ctx.strokeStyle = 'black'; - Mota.require('@user/data-state').ensureFloorDamage(floorId); + // Mota.require('@user/data-state').ensureFloorDamage(floorId); ctx.fillStyle = 'rgba(0, 0, 0, 0.6)'; ctx.fillRect(x - 6, y - 2, 12, 4); ctx.fillStyle = 'white'; - const enemy = core.status.maps[floorId].enemy.list; - if (enemy.size === 0) { - ctx.strokeStyle = 'lightgreen'; - ctx.lineCap = 'round'; - ctx.lineJoin = 'round'; - ctx.beginPath(); - ctx.moveTo(x - 1.5, y); - ctx.lineTo(x - 0.5, y + 1); - ctx.lineTo(x + 1.5, y - 1); - ctx.stroke(); - } else if (enemy.size <= 2) { - const idSet = new Set(); - enemy.forEach(v => { - idSet.add(v.id); - }); - const ids: EnemyIds[] = [...idSet]; - if (ids.length === 1) { - core.drawIcon(ctx, ids[0], x - 2, y - 2, 4, 4); - } else if (ids.length === 2) { - core.drawIcon(ctx, ids[0], x - 4, y - 2, 4, 4); - core.drawIcon(ctx, ids[1], x, y - 2, 4, 4); - } else { - core.drawIcon(ctx, ids[0], x - 5, y - 2, 4, 4); - core.drawIcon(ctx, ids[1], x - 1, y - 2, 4, 4); - ctx.fillStyle = 'white'; - ctx.strokeStyle = 'black'; - ctx.strokeText('…', x + 4, y); - ctx.fillText('…', x + 4, y); - } - } else { - ctx.fillStyle = 'white'; - ctx.textAlign = 'center'; - ctx.textBaseline = 'middle'; - ctx.fillText(`+${enemy.size}`, x, y); - } + // const enemy = core.status.maps[floorId].enemy.list; + // if (enemy.size === 0) { + // ctx.strokeStyle = 'lightgreen'; + // ctx.lineCap = 'round'; + // ctx.lineJoin = 'round'; + // ctx.beginPath(); + // ctx.moveTo(x - 1.5, y); + // ctx.lineTo(x - 0.5, y + 1); + // ctx.lineTo(x + 1.5, y - 1); + // ctx.stroke(); + // } else if (enemy.size <= 2) { + // const idSet = new Set(); + // enemy.forEach(v => { + // idSet.add(v.id); + // }); + // const ids: EnemyIds[] = [...idSet]; + // if (ids.length === 1) { + // core.drawIcon(ctx, ids[0], x - 2, y - 2, 4, 4); + // } else if (ids.length === 2) { + // core.drawIcon(ctx, ids[0], x - 4, y - 2, 4, 4); + // core.drawIcon(ctx, ids[1], x, y - 2, 4, 4); + // } else { + // core.drawIcon(ctx, ids[0], x - 5, y - 2, 4, 4); + // core.drawIcon(ctx, ids[1], x - 1, y - 2, 4, 4); + // ctx.fillStyle = 'white'; + // ctx.strokeStyle = 'black'; + // ctx.strokeText('…', x + 4, y); + // ctx.fillText('…', x + 4, y); + // } + // } else { + // ctx.fillStyle = 'white'; + // ctx.textAlign = 'center'; + // ctx.textBaseline = 'middle'; + // ctx.fillText(`+${enemy.size}`, x, y); + // } ctx.restore(); } diff --git a/packages/legacy-ui/src/ui/book.vue b/packages/legacy-ui/src/ui/book.vue deleted file mode 100644 index ec0ca28..0000000 --- a/packages/legacy-ui/src/ui/book.vue +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - diff --git a/packages/legacy-ui/src/ui/index.ts b/packages/legacy-ui/src/ui/index.ts index cc85b9e..a24dbd3 100644 --- a/packages/legacy-ui/src/ui/index.ts +++ b/packages/legacy-ui/src/ui/index.ts @@ -1,4 +1,3 @@ -export { default as Book } from './book.vue'; export { default as BookDetail } from './bookDetail.vue'; export { default as Equipbox } from './equipbox.vue'; export { default as Fly } from './fly.vue'; From 03dc5ea60bce44d8d889223bb83698517e5dc6bc Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 22:56:01 +0800 Subject: [PATCH 23/26] =?UTF-8?q?feat:=20=E8=A7=A6=E5=8F=91=E5=99=A8?= =?UTF-8?q?=E6=94=B6=E9=9B=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/data-state/src/core.ts | 90 ++++++++------ .../data-system/src/trigger/collection.ts | 2 +- .../data-system/src/trigger/collector.ts | 112 ++++++++++++++++++ .../data-system/src/trigger/index.ts | 3 +- packages-user/data-system/src/types.ts | 5 + packages/common/src/logger.json | 6 +- 6 files changed, 176 insertions(+), 42 deletions(-) create mode 100644 packages-user/data-system/src/trigger/collector.ts diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 0bba55c..6d497d2 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -33,7 +33,11 @@ import { DamageSystem, EnemyContext, IEnemyContext, - MapDamage + ITriggerCollector, + ITriggerRegistry, + MapDamage, + TriggerCollector, + TriggerRegistry } from '@user/data-system'; import { CommonAuraConverter, @@ -78,6 +82,8 @@ export class CoreState implements ICoreState { // Layer 2 内容 readonly enemyContext: IEnemyContext; + readonly triggerRegistry: ITriggerRegistry; + readonly triggerCollector: ITriggerCollector; // 用户层内容 readonly loadProgress: ILoadProgressTotal; @@ -95,26 +101,43 @@ export class CoreState implements ICoreState { > = new Map(); constructor() { + //#region L0 初始化 + + // 朝向 + this.roleFace = new RoleFaceBinder(); + this.faceManager = new FaceManager(); + const dir4 = new Dir4FaceHandler(); + const dir8 = new Dir8FaceHandler(); + this.faceManager.register(FaceGroup.Dir4, dir4); + this.faceManager.registerById('dir4', dir4); + this.faceManager.register(FaceGroup.Dir8, dir8); + this.faceManager.registerById('dir8', dir8); + + // 图块 const tileStore = new TileStore(); tileStore.attachLegacyConverter(new TileLegacyBridge()); this.tileStore = tileStore; + + //#endregion + + //#region L1 初始化 + + // Flag 系统 + this.flags = new FlagSystem(); + + // 地图 this.maps = new MapStore(tileStore, this); - this.loadProgress = new LoadProgressTotal(); - this.dataLoader = new MotaDataLoader(this.loadProgress); - - //#region 勇士初始化 - + // 勇士 const heroMover = new HeroMover(); const heroAttribute = new HeroAttribute(HERO_DEFAULT_ATTRIBUTE); const heroState = new HeroState(heroMover, heroAttribute); this.hero = heroState; - //#endregion + this.loadProgress = new LoadProgressTotal(); + this.dataLoader = new MotaDataLoader(this.loadProgress); - //#region 怪物初始化 - - // 怪物管理器初始化 + // 怪物管理器 const comparer = new MainEnemyComparer(); const enemyManager = new EnemyManager(new EnemyLegacyBridge()); enemyManager.attachEnemyComparer(comparer); @@ -126,7 +149,12 @@ export class CoreState implements ICoreState { enemyManager.setAttributeDefaults('point', 0); registerSpecials(enemyManager); this.enemyManager = enemyManager; - // 怪物上下文初始化 + + //#endregion + + //#region L2 初始化 + + // 怪物上下文 const enemyContext = new EnemyContext(this); const damageSystem = new DamageSystem(enemyContext); const mapDamage = new MapDamage(enemyContext); @@ -142,10 +170,18 @@ export class CoreState implements ICoreState { enemyContext.bindHero(heroAttribute); this.enemyContext = enemyContext; + // 触发器注册与收集器 + const triggerRegistry = new TriggerRegistry(); + const triggerCollector = new TriggerCollector(); + triggerCollector.attachRegistry(triggerRegistry); + this.triggerRegistry = triggerRegistry; + this.triggerCollector = triggerCollector; + //#endregion - //#region 存档系统 + //#region 顶层初始化 + // 存档系统 this.saveSystem = new SaveSystem(); // 配置存档系统,一般情况下不建议动,除非你知道你在干什么 this.saveSystem.config({ @@ -155,29 +191,16 @@ export class CoreState implements ICoreState { saveTimeTolerance: 100, autosaveStackSize: 20 }); - + this.addSaveableContent('@system/hero', this.hero); + this.addSaveableContent('@system/flags', this.flags); + this.addSaveableContent('@system/maps', this.maps); + this.addSaveableContent('@system/enemy', this.enemyManager); // 初始化存档数据库,不要动 loading.once('coreInit', () => { this.saveSystem.init(`@game/${core.firstData.name}`); }); - //#endregion - - //#region 其他初始化 - - // 朝向 - this.roleFace = new RoleFaceBinder(); - this.faceManager = new FaceManager(); - const dir4 = new Dir4FaceHandler(); - const dir8 = new Dir8FaceHandler(); - this.faceManager.register(FaceGroup.Dir4, dir4); - this.faceManager.registerById('dir4', dir4); - this.faceManager.register(FaceGroup.Dir8, dir8); - this.faceManager.registerById('dir8', dir8); - - this.flags = new FlagSystem(); - - // 加载先使用兼容层实现 + // 加载初始化,先使用兼容层实现 loading.once('loaded', () => { this.initTileStore(core.maps.blocksInfo); this.initEnemyManager(enemys_fcae963b_31c9_42b4_b48c_bb48d09f3f80); @@ -186,13 +209,6 @@ export class CoreState implements ICoreState { core.floors as Record ); }); - - this.addSaveableContent('@system/hero', this.hero); - this.addSaveableContent('@system/flags', this.flags); - this.addSaveableContent('@system/maps', this.maps); - this.addSaveableContent('@system/enemy', this.enemyManager); - - //#endregion } /** diff --git a/packages-user/data-system/src/trigger/collection.ts b/packages-user/data-system/src/trigger/collection.ts index e76f69a..590e753 100644 --- a/packages-user/data-system/src/trigger/collection.ts +++ b/packages-user/data-system/src/trigger/collection.ts @@ -5,7 +5,7 @@ export class TriggerCollection implements ITriggerCollection { private readonly triggerList: ITrigger[]; constructor(triggers: Iterable) { - this.triggerList = Array.from(triggers); + this.triggerList = [...triggers]; } count(): number { diff --git a/packages-user/data-system/src/trigger/collector.ts b/packages-user/data-system/src/trigger/collector.ts new file mode 100644 index 0000000..94b13e6 --- /dev/null +++ b/packages-user/data-system/src/trigger/collector.ts @@ -0,0 +1,112 @@ +import { IMapLayer } from '@user/data-base'; +import { + ITrigger, + ITriggerCollection, + ITriggerCollector, + ITriggerRegistry +} from './types'; +import { logger } from '@motajs/common'; +import { TriggerCollection } from './collection'; + +export class TriggerCollector implements ITriggerCollector { + /** 当前收集器使用的注册对象 */ + private registry: ITriggerRegistry | null = null; + + collect(x: number, y: number, layer: IMapLayer): ITriggerCollection { + if (!this.registry) { + logger.warn(135); + return new TriggerCollection([]); + } + const staticType = layer.getTriggerType(x, y); + const staticTrigger = this.registry.create(staticType); + const dynamics = [...layer.dynamicLayer.getDynamicTilesAt(x, y)]; + + if (dynamics.length === 0) { + // 没有动态图块 + if (staticTrigger) { + return new TriggerCollection([staticTrigger]); + } else { + return new TriggerCollection([]); + } + } else if (dynamics.length === 1) { + // 一个动态图块,只需要进行一次额外判断即可 + const dynamic = dynamics[0]; + const dynamicTrigger = this.registry.create(dynamic.triggerType); + // 直接穷举所有可能情况 + if (!staticTrigger && !dynamicTrigger) { + return new TriggerCollection([]); + } else if (staticTrigger && !dynamicTrigger) { + return new TriggerCollection([staticTrigger]); + } else if (!staticTrigger && dynamicTrigger) { + return new TriggerCollection([dynamicTrigger]); + } else { + // 静态动态都有,则需要额外判断优先级,动态图层在前,因此包含等号 + if (dynamicTrigger!.priority >= staticTrigger!.priority) { + const arr = [dynamicTrigger!, staticTrigger!]; + return new TriggerCollection(arr); + } else { + const arr = [staticTrigger!, dynamicTrigger!]; + return new TriggerCollection(arr); + } + } + } else { + // 动态图块大于两个,使用通用方案,记录重复触发器并抛出警告 + const usedPriority = new Set(); + const duplicate = new Set(); + if (staticTrigger) { + // 有静态触发器 + const lessTriggers: ITrigger[] = []; + const greaterTriggers: ITrigger[] = []; + // 先收集所有的触发器,并记录重复情况 + for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { + const trigger = this.registry.create(tile.triggerType); + if (trigger) { + if (usedPriority.has(trigger.priority)) { + duplicate.add(trigger.priority); + } + usedPriority.add(trigger.priority); + + // 同优先级下动态在前,因此包含等号 + if (trigger.priority >= staticTrigger.priority) { + greaterTriggers.push(trigger); + } else { + lessTriggers.push(trigger); + } + } + } + if (duplicate.size > 0) { + logger.warn(136, [...duplicate].join(',')); + } + const arr = [ + ...greaterTriggers.sort((a, b) => b.priority - a.priority), + staticTrigger, + ...lessTriggers.sort((a, b) => b.priority - a.priority) + ]; + return new TriggerCollection(arr); + } else { + // 没有静态触发器 + const triggers: ITrigger[] = []; + for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { + const trigger = this.registry.create(tile.triggerType); + if (trigger) { + if (usedPriority.has(trigger.priority)) { + duplicate.add(trigger.priority); + } + usedPriority.add(trigger.priority); + triggers.push(trigger); + } + } + if (duplicate.size > 0) { + logger.warn(136, [...duplicate].join(',')); + } + return new TriggerCollection( + triggers.sort((a, b) => b.priority - a.priority) + ); + } + } + } + + attachRegistry(registry: ITriggerRegistry | null): void { + this.registry = registry; + } +} diff --git a/packages-user/data-system/src/trigger/index.ts b/packages-user/data-system/src/trigger/index.ts index 02077b8..c5307a9 100644 --- a/packages-user/data-system/src/trigger/index.ts +++ b/packages-user/data-system/src/trigger/index.ts @@ -1,3 +1,4 @@ -export * from './types'; export * from './collection'; +export * from './collector'; export * from './registry'; +export * from './types'; diff --git a/packages-user/data-system/src/types.ts b/packages-user/data-system/src/types.ts index f08ee0b..7160a98 100644 --- a/packages-user/data-system/src/types.ts +++ b/packages-user/data-system/src/types.ts @@ -1,9 +1,14 @@ import { IStateBase } from '@user/data-base'; import { IEnemyContext } from './combat'; +import { ITriggerCollector, ITriggerRegistry } from './trigger'; export interface IStateSystem extends IStateBase { /** 怪物上下文 */ readonly enemyContext: IEnemyContext; + /** 触发器注册 */ + readonly triggerRegistry: ITriggerRegistry; + /** 触发器收集器 */ + readonly triggerCollector: ITriggerCollector; } export interface IStateSystemExtended { diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 731b04c..520470b 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -55,8 +55,7 @@ "53": "Expected serializable value set as enemy's default attribute.", "54": "Legacy '$1' API has been removed, consider using new APIs: '$2'.", "55": "Cannot load MapStore state: reference data (compareWith) has not been set.", - "56": "Cannot convert legacy tile data since no tile legacy converter is attached to TileStore.", - "1201": "Floor-damage extension needs 'floor-binder' extension as dependency." + "56": "Cannot convert legacy tile data since no tile legacy converter is attached to TileStore." }, "warn": { "1": "Resource with type of 'none' is loaded.", @@ -193,6 +192,7 @@ "132": "Trigger registry entry of $1 '$2' already exists, new factory will override old factory.", "133": "TileStore.addTile: tile number $1 already exists (id: '$2'), old tile data will be overridden.", "134": "TileStore.addTile: tile id '$1' already maps to number $2, old tile data will be overridden.", - "1001": "Item-detail extension needs 'floor-binder' and 'floor-damage' extension as dependency." + "135": "Expected a trigger registry attched before collect triggers.", + "136": "Unexpected duplicate trigger priority $1, which may cause trigger executed in an unexpected order." } } From 13e8547a37f89bca9b779dbfba636a89d0ea9b3b Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 23:27:29 +0800 Subject: [PATCH 24/26] =?UTF-8?q?refactor:=20=E8=A7=A6=E5=8F=91=E5=99=A8?= =?UTF-8?q?=E7=B1=BB=E5=9E=8B=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/map/trigger-impl.md | 44 +++++++++ packages-user/data-state/src/core.ts | 19 ++-- .../data-system/src/trigger/collection.ts | 31 ++++--- .../data-system/src/trigger/collector.ts | 21 +++-- .../data-system/src/trigger/registry.ts | 44 +++------ .../data-system/src/trigger/types.ts | 89 +++++++++---------- packages-user/data-system/src/types.ts | 4 +- 7 files changed, 146 insertions(+), 106 deletions(-) create mode 100644 docs/dev/map/trigger-impl.md diff --git a/docs/dev/map/trigger-impl.md b/docs/dev/map/trigger-impl.md new file mode 100644 index 0000000..0d65120 --- /dev/null +++ b/docs/dev/map/trigger-impl.md @@ -0,0 +1,44 @@ +# 需求综述 + +触发器系统主体已经完成,下一步开始逐步补充内置触发器类型。当前第一批只先设计两个最基础的内置触发器:战斗触发器与开门触发器。 + +本文只确认这两个类型的职责、使用频率预期与当前待补充的设计边界,不展开实现思路,也不列涉及文件。后续如果继续新增对话、商店、自定义事件等内置触发器,再在此文档上继续补充即可。 + +--- + +# 共通约束 + +这两个内置触发器都只是 `ITrigger` 的内置实现。当前阶段不建议先给它们增加额外公共配置成员,怪物信息、门信息原则上应跟随当前触发位置上的图块或运行时载体,而不是在触发器实例里重复保存一份。 + +- `type`:预期频率**低频**。由注册表和类型定义决定,通常只在注册、调试或排查问题时关注。 +- `priority`:预期频率**低频**。大多数情况下使用固定默认值即可,只有极少数“同格混合触发”场景才需要显式调整。 +- `trigger(handler)`:预期频率**中频**。平时更多通过 `ITriggerCollection.trigger(...)` 间接触发,直接持有某个内置触发器并手动调用的场景相对有限。 +- `collection()`:预期频率**中频**。继承 `ITrigger` 的统一包装能力,使用方式与其他触发器一致,这里不做额外语义扩展。 + +--- + +# 类型设计与预期 + +## 战斗触发器(暂定 `IBattleTrigger`) + +- 核心职责:在当前触发位置执行一次与怪物的战斗。 +- `IBattleTrigger.trigger(handler)`:预期频率**中频**。典型使用场景:玩家移动到怪物格后,移动系统收集到该触发器并交给集合统一触发;或脚本手动触发某个战斗事件。 +- 校验要求:触发前必须确认当前指定图块或对应的运行时载体确实是怪物。若不是怪物,发出警告并终止本次触发,不进入战斗流程。 +- 数据要求:需要能从当前触发位置解析出“这是怪物”这一事实,以及后续进入战斗流程所需的怪物信息。 +- 职责边界:该触发器当前只先负责“确认目标是怪物并进入战斗分支”。战斗后怪物移除、地图更新、事件派发等后续职责,先不在本文中拍死。 + +## 开门触发器(暂定 `IOpenDoorTrigger`) + +- 核心职责:在当前触发位置执行一次开门行为。 +- `IOpenDoorTrigger.trigger(handler)`:预期频率**中频**。典型使用场景:玩家撞到门格或主动交互门格后,系统收集到该触发器并尝试开门;或脚本在演出中手动触发某扇门的开启。 +- 校验要求:触发前必须确认当前指定图块或对应的运行时载体包含门相关信息。若不包含,发出警告并终止本次触发,不执行开门行为。 +- 数据要求:需要能从当前触发位置读取门相关信息,并定位到既有的 `openDoor` 流程。 +- 职责边界:该触发器当前只先负责“确认目标是门并进入开门分支”。钥匙校验、动画等待、图块替换、开门后事件等具体流程,先依附既有开门系统,不在本文中提前拆开。 + +--- + +# 当前待补充设计 + +1. 运行时需要一条统一路径,让触发器能从 `handler` 提供的上下文中读取当前位置对应的怪物信息或门信息;这一层目前还没有最终定稿。 +2. 这两个内置触发器原则上都不应在实例上重复保存业务对象;更合理的方向是由当前位置的图块或运行时载体提供数据。若后续发现这条路线不够用,再单独讨论是否为内置触发器补配置成员。 +3. 这两个触发器当前都只先定义“校验 + 进入对应系统”的第一层职责。后续如果需要细分成更多内置类型,例如强制战斗、免钥匙开门、条件开门等,再在这个基础上继续扩展。 diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 6d497d2..01e7093 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -69,23 +69,23 @@ import { logger } from '@motajs/common'; import { ISaveSystem, SaveSystem } from './save'; export class CoreState implements ICoreState { - // Layer 0 内容 + // Layer 0 公共层 readonly roleFace: IRoleFaceBinder; readonly faceManager: IFaceManager; readonly tileStore: ITileStore; - // Layer 1 内容 + // Layer 1 数据层,所有可存档内容都在这 readonly maps: IMapStore; readonly hero: IHeroState; readonly enemyManager: IEnemyManager; readonly flags: IFlagSystem; - // Layer 2 内容 + // Layer 2 执行层,游戏逻辑对象都在这 readonly enemyContext: IEnemyContext; - readonly triggerRegistry: ITriggerRegistry; - readonly triggerCollector: ITriggerCollector; + readonly triggerRegistry: ITriggerRegistry; + readonly triggerCollector: ITriggerCollector; - // 用户层内容 + // 用户层内容,也就是最顶层的内容,一般仅用于初始化 readonly loadProgress: ILoadProgressTotal; readonly dataLoader: IMotaDataLoader; readonly saveSystem: ISaveSystem; @@ -171,8 +171,10 @@ export class CoreState implements ICoreState { this.enemyContext = enemyContext; // 触发器注册与收集器 - const triggerRegistry = new TriggerRegistry(); - const triggerCollector = new TriggerCollector(); + const triggerRegistry = new TriggerRegistry( + this + ); + const triggerCollector = new TriggerCollector(); triggerCollector.attachRegistry(triggerRegistry); this.triggerRegistry = triggerRegistry; this.triggerCollector = triggerCollector; @@ -247,7 +249,6 @@ export class CoreState implements ICoreState { * @param data 旧样板怪物存储对象 */ private initEnemyManager(data: Record) { - // TODO: 修改怪物模板并存入存档,即 core.setEnemy const manager = this.enemyManager; const reference = new Map>(); for (const [id, enemy] of Object.entries(structuredClone(data))) { diff --git a/packages-user/data-system/src/trigger/collection.ts b/packages-user/data-system/src/trigger/collection.ts index 590e753..005a245 100644 --- a/packages-user/data-system/src/trigger/collection.ts +++ b/packages-user/data-system/src/trigger/collection.ts @@ -1,10 +1,13 @@ import { ITrigger, ITriggerCollection, ITriggerHandler } from './types'; -export class TriggerCollection implements ITriggerCollection { +export class TriggerCollection< + TEnemy = unknown, + THero = unknown +> implements ITriggerCollection { /** 当前集合内部维护的触发器列表 */ - private readonly triggerList: ITrigger[]; + private readonly triggerList: ITrigger[]; - constructor(triggers: Iterable) { + constructor(triggers: Iterable>) { this.triggerList = [...triggers]; } @@ -12,17 +15,19 @@ export class TriggerCollection implements ITriggerCollection { return this.triggerList.length; } - async trigger( - handler: ITriggerHandler - ): Promise { + async trigger(handler: ITriggerHandler): Promise { for (const trigger of this.triggerList) { await trigger.trigger(handler); } } - async *triggerIter( + async *triggerIter( handler: ITriggerHandler - ): AsyncGenerator | null> { + ): AsyncGenerator< + ITrigger, + void, + ITriggerHandler | null + > { let currentHandler = handler; for (const trigger of this.triggerList) { await trigger.trigger(currentHandler); @@ -35,19 +40,21 @@ export class TriggerCollection implements ITriggerCollection { } } - iterate(): Iterable { + iterate(): Iterable> { return this.triggerList.values(); } - push(trigger: ITrigger): void { + push(trigger: ITrigger): void { this.triggerList.push(trigger); } - unshift(trigger: ITrigger): void { + unshift(trigger: ITrigger): void { this.triggerList.unshift(trigger); } - concat(...others: ITriggerCollection[]): ITriggerCollection { + concat( + ...others: ITriggerCollection[] + ): ITriggerCollection { const merged = [...this.triggerList]; for (const other of others) { merged.push(...other.iterate()); diff --git a/packages-user/data-system/src/trigger/collector.ts b/packages-user/data-system/src/trigger/collector.ts index 94b13e6..5be8589 100644 --- a/packages-user/data-system/src/trigger/collector.ts +++ b/packages-user/data-system/src/trigger/collector.ts @@ -8,11 +8,18 @@ import { import { logger } from '@motajs/common'; import { TriggerCollection } from './collection'; -export class TriggerCollector implements ITriggerCollector { +export class TriggerCollector< + TEnemy = unknown, + THero = unknown +> implements ITriggerCollector { /** 当前收集器使用的注册对象 */ - private registry: ITriggerRegistry | null = null; + private registry: ITriggerRegistry | null = null; - collect(x: number, y: number, layer: IMapLayer): ITriggerCollection { + collect( + x: number, + y: number, + layer: IMapLayer + ): ITriggerCollection { if (!this.registry) { logger.warn(135); return new TriggerCollection([]); @@ -55,8 +62,8 @@ export class TriggerCollector implements ITriggerCollector { const duplicate = new Set(); if (staticTrigger) { // 有静态触发器 - const lessTriggers: ITrigger[] = []; - const greaterTriggers: ITrigger[] = []; + const lessTriggers: ITrigger[] = []; + const greaterTriggers: ITrigger[] = []; // 先收集所有的触发器,并记录重复情况 for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { const trigger = this.registry.create(tile.triggerType); @@ -85,7 +92,7 @@ export class TriggerCollector implements ITriggerCollector { return new TriggerCollection(arr); } else { // 没有静态触发器 - const triggers: ITrigger[] = []; + const triggers: ITrigger[] = []; for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { const trigger = this.registry.create(tile.triggerType); if (trigger) { @@ -106,7 +113,7 @@ export class TriggerCollector implements ITriggerCollector { } } - attachRegistry(registry: ITriggerRegistry | null): void { + attachRegistry(registry: ITriggerRegistry | null): void { this.registry = registry; } } diff --git a/packages-user/data-system/src/trigger/registry.ts b/packages-user/data-system/src/trigger/registry.ts index 6b2a86a..3b161b7 100644 --- a/packages-user/data-system/src/trigger/registry.ts +++ b/packages-user/data-system/src/trigger/registry.ts @@ -1,49 +1,31 @@ import { logger } from '@motajs/common'; -import { - ITrigger, - ITriggerRegistry, - TriggerFactory, - TriggerStringFactory -} from './types'; +import { ITrigger, ITriggerRegistry, TriggerFactory } from './types'; +import { IStateBase } from '@user/data-base'; -export class TriggerRegistry implements ITriggerRegistry { +export class TriggerRegistry< + TEnemy = unknown, + THero = unknown +> implements ITriggerRegistry { /** 数字类型到触发器工厂的映射 */ - private readonly typeMap: Map = new Map(); + private readonly typeMap: Map> = + new Map(); - /** 字符串 id 到触发器工厂的映射 */ - private readonly stringMap: Map = new Map(); + constructor(public readonly state: IStateBase) {} - register(type: number, factory: TriggerFactory): void { + register(type: number, factory: TriggerFactory): void { if (this.typeMap.has(type)) { logger.warn(132, 'type', type.toString()); } this.typeMap.set(type, factory); } - get(type: number): TriggerFactory | null { + get(type: number): TriggerFactory | null { return this.typeMap.get(type) ?? null; } - create(num: number): ITrigger | null { + create(num: number): ITrigger | null { const factory = this.get(num); if (!factory) return null; - return factory(num); - } - - registerString(id: string, factory: TriggerStringFactory): void { - if (this.stringMap.has(id)) { - logger.warn(132, 'id', id); - } - this.stringMap.set(id, factory); - } - - getString(id: string): TriggerStringFactory | null { - return this.stringMap.get(id) ?? null; - } - - createByString(id: string): ITrigger | null { - const factory = this.getString(id); - if (!factory) return null; - return factory(); + return factory(num, this.state); } } diff --git a/packages-user/data-system/src/trigger/types.ts b/packages-user/data-system/src/trigger/types.ts index 2e75673..db4bcff 100644 --- a/packages-user/data-system/src/trigger/types.ts +++ b/packages-user/data-system/src/trigger/types.ts @@ -1,5 +1,10 @@ import { ITileLocator } from '@motajs/common'; -import { ILayerState, IMapLayer, IStateBase } from '@user/data-base'; +import { + ILayerState, + IMapLayer, + IStateBase, + IStateBaseExtended +} from '@user/data-base'; export interface ITriggerHandler { /** 当前全局状态对象 */ @@ -12,11 +17,15 @@ export interface ITriggerHandler { readonly locator?: ITileLocator; } -export type TriggerFactory = (type: number) => ITrigger; +export type TriggerFactory = ( + type: number, + state: IStateBase +) => ITrigger; -export type TriggerStringFactory = () => ITrigger; - -export interface ITrigger { +export interface ITrigger< + TEnemy = unknown, + THero = unknown +> extends IStateBaseExtended { /** 触发器类型标识 */ readonly type: number; /** 触发器优先级 */ @@ -26,57 +35,39 @@ export interface ITrigger { * 使用给定上下文触发当前触发器 * @param handler 触发上下文对象 */ - trigger( - handler: ITriggerHandler - ): Promise; + trigger(handler: ITriggerHandler): Promise; /** * 将当前触发器包装为单元素触发器集合 */ - collection(): ITriggerCollection; + collection(): ITriggerCollection; } -export interface ITriggerRegistry { +export interface ITriggerRegistry< + TEnemy = unknown, + THero = unknown +> extends IStateBaseExtended { /** * 注册一个按类型创建的触发器工厂 * @param type 触发器类型 * @param factory 触发器工厂函数 */ - register(type: number, factory: TriggerFactory): void; + register(type: number, factory: TriggerFactory): void; /** * 获取指定类型的触发器工厂 * @param type 触发器类型 */ - get(type: number): TriggerFactory | null; + get(type: number): TriggerFactory | null; /** * 根据触发器类型创建一个触发器实例,如果对应工厂不存在则返回 `null` * @param num 触发器类型 */ - create(num: number): ITrigger | null; - - /** - * 注册一个按字符串 id 查询的触发器工厂 - * @param id 触发器字符串 id - * @param factory 触发器工厂函数 - */ - registerString(id: string, factory: TriggerStringFactory): void; - - /** - * 获取指定字符串 id 对应的触发器工厂 - * @param id 触发器字符串 id - */ - getString(id: string): TriggerStringFactory | null; - - /** - * 根据字符串 id 创建一个触发器实例,如果对应工厂不存在则返回 `null` - * @param id 触发器字符串 id - */ - createByString(id: string): ITrigger | null; + create(num: number): ITrigger | null; } -export interface ITriggerCollection { +export interface ITriggerCollection { /** * 当前集合中的触发器数量 */ @@ -86,54 +77,62 @@ export interface ITriggerCollection { * 顺序触发当前集合中的所有触发器 * @param handler 初始触发上下文对象 */ - trigger( - handler: ITriggerHandler - ): Promise; + trigger(handler: ITriggerHandler): Promise; /** * 逐个触发当前集合中的触发器,并允许为下一次推进提供新上下文 * @param handler 初始触发上下文对象 */ - triggerIter( + triggerIter( handler: ITriggerHandler - ): AsyncGenerator | null>; + ): AsyncGenerator< + ITrigger, + void, + ITriggerHandler | null + >; /** * 迭代当前集合中的所有触发器 */ - iterate(): Iterable; + iterate(): Iterable>; /** * 向集合末尾追加一个触发器 * @param trigger 要追加的触发器 */ - push(trigger: ITrigger): void; + push(trigger: ITrigger): void; /** * 向集合头部插入一个触发器 * @param trigger 要插入的触发器 */ - unshift(trigger: ITrigger): void; + unshift(trigger: ITrigger): void; /** * 将当前集合与其他集合顺序拼接为一个新集合 * @param others 要拼接的其他集合 */ - concat(...others: ITriggerCollection[]): ITriggerCollection; + concat( + ...others: ITriggerCollection[] + ): ITriggerCollection; } -export interface ITriggerCollector { +export interface ITriggerCollector { /** * 收集指定图层中某一点的所有触发器 * @param x 横坐标 * @param y 纵坐标 * @param layer 目标图层 */ - collect(x: number, y: number, layer: IMapLayer): ITriggerCollection; + collect( + x: number, + y: number, + layer: IMapLayer + ): ITriggerCollection; /** * 绑定或清除当前 collector 使用的注册表 * @param registry 触发器注册表 */ - attachRegistry(registry: ITriggerRegistry | null): void; + attachRegistry(registry: ITriggerRegistry | null): void; } diff --git a/packages-user/data-system/src/types.ts b/packages-user/data-system/src/types.ts index 7160a98..60f075c 100644 --- a/packages-user/data-system/src/types.ts +++ b/packages-user/data-system/src/types.ts @@ -6,9 +6,9 @@ export interface IStateSystem extends IStateBase { /** 怪物上下文 */ readonly enemyContext: IEnemyContext; /** 触发器注册 */ - readonly triggerRegistry: ITriggerRegistry; + readonly triggerRegistry: ITriggerRegistry; /** 触发器收集器 */ - readonly triggerCollector: ITriggerCollector; + readonly triggerCollector: ITriggerCollector; } export interface IStateSystemExtended { From 370f285964aff3a7a9f9e7adf0c72466d61154d5 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Sun, 17 May 2026 23:56:40 +0800 Subject: [PATCH 25/26] =?UTF-8?q?refactor:=20=E5=88=A0=E9=99=A4=E6=B1=A1?= =?UTF-8?q?=E6=9F=93=E4=B8=A5=E9=87=8D=E7=9A=84=20TEnemy=20=E5=92=8C=20THe?= =?UTF-8?q?ro=EF=BC=8C=E4=BB=85=E5=9C=A8=E6=88=98=E6=96=97=E7=B3=BB?= =?UTF-8?q?=E7=BB=9F=E4=B8=AD=E5=8C=85=E5=90=AB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/data-base/src/enemy/manager.ts | 66 ++++---- packages-user/data-base/src/types.ts | 17 +- packages-user/data-common/src/types.ts | 41 +++++ packages-user/data-state/src/core.ts | 18 +- packages-user/data-state/src/enemy/aura.ts | 5 +- .../data-state/src/enemy/calculator.ts | 12 +- .../data-state/src/enemy/comparer.ts | 2 +- packages-user/data-state/src/enemy/final.ts | 3 +- packages-user/data-state/src/enemy/legacy.ts | 2 +- .../data-state/src/enemy/mapDamage.ts | 4 +- packages-user/data-state/src/enemy/special.ts | 2 +- packages-user/data-state/src/enemy/types.ts | 6 +- packages-user/data-state/src/hero/types.ts | 23 +-- packages-user/data-state/src/shared.ts | 2 +- packages-user/data-state/src/types.ts | 8 +- .../data-system/src/combat/context.ts | 10 +- .../data-system/src/combat/damage.ts | 10 +- .../data-system/src/combat/mapDamage.ts | 3 +- packages-user/data-system/src/combat/types.ts | 156 ++++++++++-------- .../data-system/src/trigger/collection.ts | 29 ++-- .../data-system/src/trigger/collector.ts | 21 +-- .../data-system/src/trigger/registry.ts | 16 +- .../data-system/src/trigger/types.ts | 61 +++---- packages-user/data-system/src/types.ts | 13 +- packages/common/src/logger.json | 3 +- 25 files changed, 276 insertions(+), 257 deletions(-) diff --git a/packages-user/data-base/src/enemy/manager.ts b/packages-user/data-base/src/enemy/manager.ts index 2cdff49..de12685 100644 --- a/packages-user/data-base/src/enemy/manager.ts +++ b/packages-user/data-base/src/enemy/manager.ts @@ -12,16 +12,18 @@ import { } from './types'; import { SaveCompression } from '@user/data-common'; -export class EnemyManager implements IEnemyManager { +export class EnemyManager implements IEnemyManager { /** 特殊属性注册表,code -> 创建函数 */ - private readonly specialRegistry: Map> = - new Map(); + private readonly specialRegistry: Map< + number, + SpecialCreation + > = new Map(); /** 自定义怪物属性注册表,name -> 默认值 */ - private readonly attributeRegistry: Map = new Map(); + private readonly attributeRegistry: Map = new Map(); /** 怪物模板表,code -> IEnemy */ - private readonly prefabByCode: Map> = new Map(); + private readonly prefabByCode: Map> = new Map(); /** 怪物模板表,id -> IEnemy */ - private readonly prefabById: Map> = new Map(); + private readonly prefabById: Map> = new Map(); /** 旧样板怪物 id 到 code 的映射,用于 fromLegacyEnemy 快速查找已有模板 */ private readonly legacyIdToCode: Map = new Map(); /** 复用映射,reusedCode -> sourceCode */ @@ -31,21 +33,21 @@ export class EnemyManager implements IEnemyManager { /** 脏模板集合,存储发生了变化的模板 code */ private readonly dirtySet: Set = new Set(); /** 参考快照,code -> IReadonlyEnemy,由 compareWith 提供 */ - private referenceByCode: Map> = new Map(); + private referenceByCode: Map> = new Map(); /** 当前附加的怪物比较器 */ - private comparer: IEnemyComparer | null = null; + private comparer: IEnemyComparer | null = null; /** 是否已首次调用 compareWith */ private hasReference: boolean = false; - constructor(readonly bridge: IEnemyLegacyBridge) {} + constructor(readonly bridge: IEnemyLegacyBridge) {} - registerSpecial(code: number, cons: SpecialCreation): void { + registerSpecial(code: number, cons: SpecialCreation): void { this.specialRegistry.set(code, cons); } - setAttributeDefaults( + setAttributeDefaults( name: K, - defaultValue: TAttr[K] + defaultValue: TEnemy[K] ): void { if ( typeof defaultValue === 'function' || @@ -59,7 +61,7 @@ export class EnemyManager implements IEnemyManager { this.attributeRegistry.set(name, defaultValue); } - fromLegacyEnemy(code: number, enemy: Enemy): IEnemy { + fromLegacyEnemy(code: number, enemy: Enemy): IEnemy { // 如果该旧样板怪物已经通过 addPrefabFromLegacy 注册为模板,直接克隆模板 const existingCode = this.legacyIdToCode.get(enemy.id); if (existingCode) { @@ -76,15 +78,15 @@ export class EnemyManager implements IEnemyManager { * 根据旧样板怪物与注册过的默认属性构造属性对象 * @param enemy 旧样板怪物对象 */ - private createAttributes(enemy: Enemy): TAttr { - const attrs: Partial = {}; + private createAttributes(enemy: Enemy): TEnemy { + const attrs: Partial = {}; for (const [name, defaultValue] of this.attributeRegistry) { attrs[name] = structuredClone(defaultValue); } Object.assign(attrs, this.bridge.fromLegacyEnemy(enemy, attrs)); - return attrs as TAttr; + return attrs as TEnemy; } /** @@ -92,9 +94,9 @@ export class EnemyManager implements IEnemyManager { * @param code 怪物图块数字 * @param enemy 旧样板怪物对象 */ - private convertLegacyEnemy(code: number, enemy: Enemy): IEnemy { + private convertLegacyEnemy(code: number, enemy: Enemy): IEnemy { const attrs = this.createAttributes(enemy); - const result = new EnemyImpl( + const result = new EnemyImpl( enemy.id, code, structuredClone(attrs) @@ -114,13 +116,13 @@ export class EnemyManager implements IEnemyManager { return result; } - createEnemy(code: number): IEnemy | null { + createEnemy(code: number): IEnemy | null { const prefab = this.prefabByCode.get(code); if (!prefab) return null; return prefab.clone(); } - createEnemyById(id: string): IEnemy | null { + createEnemyById(id: string): IEnemy | null { const prefab = this.prefabById.get(id); if (!prefab) return null; return prefab.clone(); @@ -136,7 +138,7 @@ export class EnemyManager implements IEnemyManager { } } - addPrefab(enemy: IEnemy): void { + addPrefab(enemy: IEnemy): void { if ( this.prefabByCode.has(enemy.code) || this.prefabById.has(enemy.id) @@ -160,12 +162,12 @@ export class EnemyManager implements IEnemyManager { this.updateDirty(code, prefab); } - getPrefab(code: number): IReadonlyEnemy | null { + getPrefab(code: number): IReadonlyEnemy | null { const sourceCode = this.reuseByCode.get(code) ?? code; return this.prefabByCode.get(sourceCode) ?? null; } - getPrefabById(id: string): IReadonlyEnemy | null { + getPrefabById(id: string): IReadonlyEnemy | null { const sourceId = this.reuseById.get(id) ?? id; return this.prefabById.get(sourceId) ?? null; } @@ -177,7 +179,7 @@ export class EnemyManager implements IEnemyManager { this.prefabById.delete(prefab.id); } - changePrefab(code: number | string, enemy: IEnemy): void { + changePrefab(code: number | string, enemy: IEnemy): void { // 先删除旧的模板(如果存在) this.deletePrefab(code); // 再添加新的模板 @@ -193,7 +195,7 @@ export class EnemyManager implements IEnemyManager { this.reuseById.set(id, prefab.id); } - compareWith(reference: ReadonlyMap>): void { + compareWith(reference: ReadonlyMap>): void { const isSubsequentCall = this.hasReference; if (isSubsequentCall) { logger.warn(117); @@ -211,7 +213,7 @@ export class EnemyManager implements IEnemyManager { modifyPrefabAttribute( code: number | string, - modify: (prefab: IEnemy) => IEnemy + modify: (prefab: IEnemy) => IEnemy ): void { const prefab = this.internalGetPrefab(code); if (!prefab) return; @@ -230,16 +232,16 @@ export class EnemyManager implements IEnemyManager { this.updateDirty(result.code, result); } - attachEnemyComparer(comparer: IEnemyComparer): void { + attachEnemyComparer(comparer: IEnemyComparer): void { this.comparer = comparer; } - getEnemyComparer(): IEnemyComparer | null { + getEnemyComparer(): IEnemyComparer | null { return this.comparer; } - saveState(compression: SaveCompression): IEnemyManagerSaveState { - const modified: Map> = new Map(); + saveState(compression: SaveCompression): IEnemyManagerSaveState { + const modified: Map> = new Map(); for (const code of this.dirtySet) { const prefab = this.prefabByCode.get(code); if (!prefab) continue; @@ -249,7 +251,7 @@ export class EnemyManager implements IEnemyManager { } loadState( - state: IEnemyManagerSaveState, + state: IEnemyManagerSaveState, compression: SaveCompression ): void { for (const [code, enemyState] of state.modified) { @@ -269,7 +271,7 @@ export class EnemyManager implements IEnemyManager { * @param code 怪物图块数字 * @param current 当前模板对象 */ - private updateDirty(code: number, current: IEnemy): void { + private updateDirty(code: number, current: IEnemy): void { if (!this.hasReference) return; if (!this.comparer) { logger.warn(118); diff --git a/packages-user/data-base/src/types.ts b/packages-user/data-base/src/types.ts index 796a4b6..5ac7cc1 100644 --- a/packages-user/data-base/src/types.ts +++ b/packages-user/data-base/src/types.ts @@ -2,21 +2,26 @@ import { IHeroFollower, IHeroState } from './hero'; import { IEnemyManager } from './enemy'; import { IFlagSystem } from './flag'; import { IMapStore } from './map'; -import { IDataCommon, ISaveableContent } from '@user/data-common'; +import { + IDataCommon, + IEnemyAttr, + IHeroAttr, + ISaveableContent +} from '@user/data-common'; export interface IStateSaveData { /** 跟随者列表 */ readonly followers: readonly IHeroFollower[]; } -export interface IStateBase extends IDataCommon { +export interface IStateBase extends IDataCommon { /** 地图状态 */ readonly maps: IMapStore; /** 勇士状态 */ - readonly hero: IHeroState; + readonly hero: IHeroState; /** 怪物管理器 */ - readonly enemyManager: IEnemyManager; + readonly enemyManager: IEnemyManager; /** Flag 系统 */ readonly flags: IFlagSystem; @@ -35,7 +40,7 @@ export interface IStateBase extends IDataCommon { getSaveableContent(id: string): ISaveableContent | null; } -export interface IStateBaseExtended { +export interface IStateBaseExtended { /** 当前对象对应的数据层对象(Layer 1 对象) */ - readonly state: IStateBase; + readonly state: IStateBase; } diff --git a/packages-user/data-common/src/types.ts b/packages-user/data-common/src/types.ts index dffe3f9..75efc3c 100644 --- a/packages-user/data-common/src/types.ts +++ b/packages-user/data-common/src/types.ts @@ -1,6 +1,47 @@ +import { ITileLocator } from '@motajs/common'; import { IFaceManager, IRoleFaceBinder } from './common'; import { ITileStore } from './store'; +export interface IEnemyAttr { + /** 怪物生命值 */ + hp: number; + /** 怪物攻击力 */ + atk: number; + /** 怪物防御力 */ + def: number; + /** 怪物金币 */ + money: number; + /** 怪物经验值 */ + exp: number; + /** 怪物加点量 */ + point: number; + /** 支援来源怪物坐标索引列表 */ + guard: Set; +} + +export interface IHeroAttr { + /** 勇士名称 */ + name: string; + /** 勇士生命值 */ + hp: number; + /** 勇士生命值上限 */ + hpmax: number; + /** 勇士攻击力 */ + atk: number; + /** 勇士防御力 */ + def: number; + /** 勇士护盾 */ + mdef: number; + /** 勇士魔法值 */ + mana: number; + /** 勇士魔法上限 */ + manamax: number; + /** 勇士拥有的金币 */ + money: number; + /** 勇士拥有的经验 */ + exp: number; +} + export interface IDataCommon { /** 图块定义存储 */ readonly tileStore: ITileStore>; diff --git a/packages-user/data-state/src/core.ts b/packages-user/data-state/src/core.ts index 01e7093..37aefd2 100644 --- a/packages-user/data-state/src/core.ts +++ b/packages-user/data-state/src/core.ts @@ -11,7 +11,9 @@ import { Dir4FaceHandler, Dir8FaceHandler, FaceGroup, - FaceDirection + FaceDirection, + IHeroAttr, + IEnemyAttr } from '@user/data-common'; import { EnemyManager, @@ -48,8 +50,7 @@ import { MainMapDamageConverter, MainMapDamageReducer, registerSpecials, - MainEnemyComparer, - IEnemyAttr + MainEnemyComparer } from './enemy'; import { BG2_ZINDEX, @@ -61,7 +62,6 @@ import { TILE_HEIGHT, TILE_WIDTH } from './shared'; -import { IHeroAttr } from './hero'; import { LegacyTileData, TileLegacyBridge } from './legacy'; import { ILoadProgressTotal, LoadProgressTotal } from '@motajs/loader'; import { isNil } from 'lodash-es'; @@ -82,8 +82,8 @@ export class CoreState implements ICoreState { // Layer 2 执行层,游戏逻辑对象都在这 readonly enemyContext: IEnemyContext; - readonly triggerRegistry: ITriggerRegistry; - readonly triggerCollector: ITriggerCollector; + readonly triggerRegistry: ITriggerRegistry; + readonly triggerCollector: ITriggerCollector; // 用户层内容,也就是最顶层的内容,一般仅用于初始化 readonly loadProgress: ILoadProgressTotal; @@ -171,10 +171,8 @@ export class CoreState implements ICoreState { this.enemyContext = enemyContext; // 触发器注册与收集器 - const triggerRegistry = new TriggerRegistry( - this - ); - const triggerCollector = new TriggerCollector(); + const triggerRegistry = new TriggerRegistry(this); + const triggerCollector = new TriggerCollector(); triggerCollector.attachRegistry(triggerRegistry); this.triggerRegistry = triggerRegistry; this.triggerCollector = triggerCollector; diff --git a/packages-user/data-state/src/enemy/aura.ts b/packages-user/data-state/src/enemy/aura.ts index eae1149..f3c4f64 100644 --- a/packages-user/data-state/src/enemy/aura.ts +++ b/packages-user/data-state/src/enemy/aura.ts @@ -18,8 +18,7 @@ import { } from '@user/data-system'; import { IReadonlyEnemy, ISpecial } from '@user/data-base'; import { IHaloValue } from './special'; -import { IEnemyAttr } from './types'; -import { IHeroAttr } from '../hero'; +import { IHeroAttr, IEnemyAttr } from '@user/data-common'; const FULL_RANGE = new FullRange(); const RECT_RANGE = new RectRange(); @@ -176,7 +175,7 @@ export class GuardAura implements IEnemyAuraView< if (locator.x === this.locator.x && locator.y === this.locator.y) { return; } - enemy.getAttribute('guard').add(this.sourceView); + enemy.getAttribute('guard').add(this.locator); } applySpecial(): IEnemySpecialModifier | null { diff --git a/packages-user/data-state/src/enemy/calculator.ts b/packages-user/data-state/src/enemy/calculator.ts index 3d67f08..edd5bb5 100644 --- a/packages-user/data-state/src/enemy/calculator.ts +++ b/packages-user/data-state/src/enemy/calculator.ts @@ -4,10 +4,10 @@ import { IEnemyDamageInfo, IReadonlyEnemyHandler } from '@user/data-system'; -import { IEnemyAttr } from './types'; +import { IEnemyAttr, IHeroAttr } from '@user/data-common'; import { IVampireValue } from './special'; -import { IHeroAttr } from '../hero'; import { state } from '../ins'; +import { logger } from '@motajs/common'; export class MainDamageCalculator implements IDamageCalculator< IEnemyAttr, @@ -87,8 +87,14 @@ export class MainDamageCalculator implements IDamageCalculator< // 因此回合数需要加上打支援怪的回合数 for (const guard of guards) { // 直接把 enemy 传过去,因此支援的 enemy 会吃到其原本所在位置的光环加成 + const view = handler.context.getEnemyByLocator(guard); + if (!view) { + logger.warn(137, guard.x.toString(), guard.y.toString()); + continue; + } const extraInfo = this.calculate({ - enemy: guard.getComputedEnemy(), + enemy: view.getComputedEnemy(), + context: handler.context, locator, hero, data: handler.data diff --git a/packages-user/data-state/src/enemy/comparer.ts b/packages-user/data-state/src/enemy/comparer.ts index a04bef7..21260b7 100644 --- a/packages-user/data-state/src/enemy/comparer.ts +++ b/packages-user/data-state/src/enemy/comparer.ts @@ -1,5 +1,5 @@ import { IEnemyComparer, IReadonlyEnemy } from '@user/data-base'; -import { IEnemyAttr } from './types'; +import { IEnemyAttr } from '@user/data-common'; export class MainEnemyComparer implements IEnemyComparer { compare( diff --git a/packages-user/data-state/src/enemy/final.ts b/packages-user/data-state/src/enemy/final.ts index dbd3e01..2ec0fbb 100644 --- a/packages-user/data-state/src/enemy/final.ts +++ b/packages-user/data-state/src/enemy/final.ts @@ -1,6 +1,5 @@ import { IEnemyFinalEffect, IEnemyHandler } from '@user/data-system'; -import { IEnemyAttr } from './types'; -import { IHeroAttr } from '../hero'; +import { IEnemyAttr, IHeroAttr } from '@user/data-common'; export class MainEnemyFinalEffect implements IEnemyFinalEffect< IEnemyAttr, diff --git a/packages-user/data-state/src/enemy/legacy.ts b/packages-user/data-state/src/enemy/legacy.ts index 60ddb52..3c4aca6 100644 --- a/packages-user/data-state/src/enemy/legacy.ts +++ b/packages-user/data-state/src/enemy/legacy.ts @@ -1,5 +1,5 @@ import { IEnemyLegacyBridge } from '@user/data-base'; -import { IEnemyAttr } from './types'; +import { IEnemyAttr } from '@user/data-common'; export class EnemyLegacyBridge implements IEnemyLegacyBridge { fromLegacyEnemy( diff --git a/packages-user/data-state/src/enemy/mapDamage.ts b/packages-user/data-state/src/enemy/mapDamage.ts index b0659e8..ca10d4f 100644 --- a/packages-user/data-state/src/enemy/mapDamage.ts +++ b/packages-user/data-state/src/enemy/mapDamage.ts @@ -24,8 +24,8 @@ import { IReadonlyEnemy } from '@user/data-base'; import { IZoneValue } from './special'; -import { IEnemyAttr, MapDamageType } from './types'; -import { IHeroAttr } from '../hero'; +import { MapDamageType } from './types'; +import { IHeroAttr, IEnemyAttr } from '@user/data-common'; import { IFaceHandler, FaceGroup } from '@user/data-common'; const RECT_RANGE = new RectRange(); diff --git a/packages-user/data-state/src/enemy/special.ts b/packages-user/data-state/src/enemy/special.ts index 650dea4..bf5959c 100644 --- a/packages-user/data-state/src/enemy/special.ts +++ b/packages-user/data-state/src/enemy/special.ts @@ -4,7 +4,7 @@ import { IEnemyManager } from '@user/data-base'; import { getHeroStatusOn } from '../legacy/hero'; -import { IEnemyAttr } from './types'; +import { IEnemyAttr } from '@user/data-common'; //#region 复合属性值类型 diff --git a/packages-user/data-state/src/enemy/types.ts b/packages-user/data-state/src/enemy/types.ts index 59a2d32..1c55277 100644 --- a/packages-user/data-state/src/enemy/types.ts +++ b/packages-user/data-state/src/enemy/types.ts @@ -1,5 +1,3 @@ -import { IEnemyView } from '@user/data-system'; - export interface IEnemyAttr { /** 怪物生命值 */ hp: number; @@ -13,8 +11,8 @@ export interface IEnemyAttr { exp: number; /** 怪物加点量 */ point: number; - /** 支援来源怪物视图列表 */ - guard: Set>; + /** 支援来源怪物坐标索引列表 */ + guard: Set; } export const enum MapDamageType { diff --git a/packages-user/data-state/src/hero/types.ts b/packages-user/data-state/src/hero/types.ts index 98147da..138051c 100644 --- a/packages-user/data-state/src/hero/types.ts +++ b/packages-user/data-state/src/hero/types.ts @@ -1,26 +1,5 @@ //#region 勇士属性 -export interface IHeroAttr { - /** 勇士名称 */ - name: string; - /** 勇士生命值 */ - hp: number; - /** 勇士生命值上限 */ - hpmax: number; - /** 勇士攻击力 */ - atk: number; - /** 勇士防御力 */ - def: number; - /** 勇士护盾 */ - mdef: number; - /** 勇士魔法值 */ - mana: number; - /** 勇士魔法上限 */ - manamax: number; - /** 勇士拥有的金币 */ - money: number; - /** 勇士拥有的经验 */ - exp: number; -} +export interface IHeroAttr {} //#endregion diff --git a/packages-user/data-state/src/shared.ts b/packages-user/data-state/src/shared.ts index 0f4b609..8a3206a 100644 --- a/packages-user/data-state/src/shared.ts +++ b/packages-user/data-state/src/shared.ts @@ -1,4 +1,4 @@ -import { IHeroAttr } from './hero'; +import { IHeroAttr } from '@user/data-common'; //#region 地图相关 diff --git a/packages-user/data-state/src/types.ts b/packages-user/data-state/src/types.ts index 73de768..b1cd795 100644 --- a/packages-user/data-state/src/types.ts +++ b/packages-user/data-state/src/types.ts @@ -1,21 +1,19 @@ import { IMotaDataLoader, IStateBase } from '@user/data-base'; -import { IEnemyAttr } from './enemy'; -import { IHeroAttr } from './hero'; import { ILoadProgressTotal } from '@motajs/loader'; import { ISaveSystem } from './save'; import { IStateSystem } from '@user/data-system'; import { ISaveableContent } from '@user/data-common'; -export interface ISaveableExecutor { +export interface ISaveableExecutor { /** * 当数据读取后执行的函数,允许对其他存档对象进行读取 * @param data 对应可存档对象的存档数据 * @param state 当前的基础状态 */ - afterLoad(data: T, state: IStateBase): void; + afterLoad(data: T, state: IStateBase): void; } -export interface ICoreState extends IStateSystem { +export interface ICoreState extends IStateSystem { /** 加载进度对象 */ readonly loadProgress: ILoadProgressTotal; /** 数据端加载对象 */ diff --git a/packages-user/data-system/src/combat/context.ts b/packages-user/data-system/src/combat/context.ts index 22dbb4f..af6746d 100644 --- a/packages-user/data-system/src/combat/context.ts +++ b/packages-user/data-system/src/combat/context.ts @@ -100,7 +100,7 @@ export class EnemyContext implements IEnemyContext< width: number = 0; height: number = 0; - constructor(readonly dataState: IStateBase) {} + constructor(readonly dataState: IStateBase) {} resize(width: number, height: number): void { this.clear(); @@ -210,7 +210,13 @@ export class EnemyContext implements IEnemyContext< enemy: IEnemy, locator: ITileLocator ): IEnemyHandler { - return { enemy, locator, hero: this.bindedHero!, data: this.dataState }; + return { + enemy, + context: this, + locator, + hero: this.bindedHero!, + data: this.dataState + }; } getEnemyLocator(enemy: IEnemy): Readonly | null { diff --git a/packages-user/data-system/src/combat/damage.ts b/packages-user/data-system/src/combat/damage.ts index 2b83a7e..423ac6d 100644 --- a/packages-user/data-system/src/combat/damage.ts +++ b/packages-user/data-system/src/combat/damage.ts @@ -34,7 +34,7 @@ export class DamageContext implements IDamageContext< /** 当前勇士属性 */ protected heroStatus: IReadonlyHeroAttribute | null; - readonly dataState: IStateBase; + readonly dataState: IStateBase; constructor( readonly context: IEnemyContext, @@ -57,7 +57,13 @@ export class DamageContext implements IDamageContext< locator: ITileLocator, hero: IReadonlyHeroAttribute ): IReadonlyEnemyHandler { - return { enemy, locator, hero, data: this.dataState }; + return { + enemy, + context: this.context, + locator, + hero, + data: this.dataState + }; } getDamageInfo(enemy: IEnemyView): IEnemyDamageInfo | null { diff --git a/packages-user/data-system/src/combat/mapDamage.ts b/packages-user/data-system/src/combat/mapDamage.ts index e68249a..6cfb22d 100644 --- a/packages-user/data-system/src/combat/mapDamage.ts +++ b/packages-user/data-system/src/combat/mapDamage.ts @@ -64,7 +64,7 @@ export class MapDamage implements IMapDamage { /** 坐标索引对象 */ private readonly indexer: ILocationHelper; - readonly dataState: IStateBase; + readonly dataState: IStateBase; constructor(readonly context: IEnemyContext) { this.indexer = context.indexer; @@ -89,6 +89,7 @@ export class MapDamage implements IMapDamage { if (!hero) return null; return { enemy: view.getComputedEnemy(), + context: this.context, locator, hero, data: this.context.dataState diff --git a/packages-user/data-system/src/combat/types.ts b/packages-user/data-system/src/combat/types.ts index 044cafe..171d58f 100644 --- a/packages-user/data-system/src/combat/types.ts +++ b/packages-user/data-system/src/combat/types.ts @@ -14,23 +14,27 @@ import { ILocationHelper } from '@user/data-common'; export interface IEnemyHandler { /** 怪物属性信息 */ readonly enemy: IEnemy; + /** 怪物上下文 */ + readonly context: IEnemyContext; /** 怪物定位符 */ readonly locator: ITileLocator; /** 勇士属性信息 */ readonly hero: IReadonlyHeroAttribute; /** 当前全局状态对象 */ - readonly data: IStateBase; + readonly data: IStateBase; } export interface IReadonlyEnemyHandler { /** 怪物属性信息 */ readonly enemy: IReadonlyEnemy; + /** 怪物上下文 */ + readonly context: IReadonlyEnemyContext; /** 怪物定位符 */ readonly locator: ITileLocator; /** 勇士属性信息 */ readonly hero: IReadonlyHeroAttribute; /** 当前全局状态对象 */ - readonly data: IStateBase; + readonly data: IStateBase; } //#endregion @@ -282,7 +286,7 @@ export interface IMapDamage { /** 当前绑定的怪物上下文 */ readonly context: IEnemyContext; /** 地图伤害系统绑定的全局状态对象 */ - readonly dataState: IStateBase; + readonly dataState: IStateBase; /** * 设置地图伤害转换器,并基于当前上下文重建所有地图伤害视图 @@ -398,7 +402,7 @@ export interface IDamageCalculator { export interface IDamageContext { /** 伤害上下文所属的全局状态对象 */ - readonly dataState: IStateBase; + readonly dataState: IStateBase; /** * 获取战斗伤害信息 @@ -479,7 +483,7 @@ export interface IDamageSystem extends IDamageContext< //#region 上下文 -export interface IEnemyContext { +export interface IReadonlyEnemyContext { /** 怪物上下文宽度 */ readonly width: number; /** 怪物上下文高度 */ @@ -487,7 +491,84 @@ export interface IEnemyContext { /** 此上下文使用的索引对象 */ readonly indexer: ILocationHelper; /** 当前怪物上下文绑定的全局状态对象 */ - readonly dataState: IStateBase; + readonly dataState: IStateBase; + + /** + * 获取当前绑定的勇士属性对象 + */ + getBindedHero(): IReadonlyHeroAttribute | null; + + /** + * 获取指定怪物对象当前所在位置 + * @param enemy 怪物对象 + */ + getEnemyLocator(enemy: IEnemy): Readonly | null; + + /** + * 获取指定怪物视图当前所在位置 + * @param view 怪物视图 + */ + getEnemyLocatorByView( + view: IEnemyView + ): Readonly | null; + + /** + * 根据定位符获取怪物视图 + * @param locator 地图定位符 + */ + getEnemyByLocator(locator: ITileLocator): IEnemyView | null; + + /** + * 根据坐标获取怪物视图 + * @param x 横坐标 + * @param y 纵坐标 + */ + getEnemyByLoc(x: number, y: number): IEnemyView | null; + + /** + * 根据计算后怪物对象反查怪物视图 + * @param enemy 计算后怪物对象 + */ + getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; + + /** + * 扫描指定范围内的怪物视图 + * @param range 范围对象 + * @param param 范围参数 + */ + scanRange( + range: IRange, + param: T + ): Iterable<[ITileLocator, IEnemyView]>; + + /** + * 迭代上下文中的全部怪物 + */ + iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; + + /** + * 获取当前绑定的地图伤害管理器 + */ + getMapDamage(): IMapDamage | null; + + /** + * 获取当前绑定的伤害计算系统 + */ + getDamageSystem(): IDamageSystem | null; +} + +export interface IEnemyContext extends IReadonlyEnemyContext< + TEnemy, + THero +> { + /** 怪物上下文宽度 */ + readonly width: number; + /** 怪物上下文高度 */ + readonly height: number; + /** 此上下文使用的索引对象 */ + readonly indexer: ILocationHelper; + /** 当前怪物上下文绑定的全局状态对象 */ + readonly dataState: IStateBase; /** * 调整上下文尺寸,并清空当前上下文中的所有怪物与状态 @@ -572,44 +653,6 @@ export interface IEnemyContext { */ bindHero(hero: IReadonlyHeroAttribute | null): void; - /** - * 获取当前绑定的勇士属性对象 - */ - getBindedHero(): IReadonlyHeroAttribute | null; - - /** - * 获取指定怪物对象当前所在位置 - * @param enemy 怪物对象 - */ - getEnemyLocator(enemy: IEnemy): Readonly | null; - - /** - * 获取指定怪物视图当前所在位置 - * @param view 怪物视图 - */ - getEnemyLocatorByView( - view: IEnemyView - ): Readonly | null; - - /** - * 根据定位符获取怪物视图 - * @param locator 地图定位符 - */ - getEnemyByLocator(locator: ITileLocator): IEnemyView | null; - - /** - * 根据坐标获取怪物视图 - * @param x 横坐标 - * @param y 纵坐标 - */ - getEnemyByLoc(x: number, y: number): IEnemyView | null; - - /** - * 根据计算后怪物对象反查怪物视图 - * @param enemy 计算后怪物对象 - */ - getViewByComputed(enemy: IReadonlyEnemy): IEnemyView | null; - /** * 在指定位置放置一个怪物对象 * @param locator 地图定位符 @@ -623,21 +666,6 @@ export interface IEnemyContext { */ deleteEnemy(locator: ITileLocator): void; - /** - * 扫描指定范围内的怪物视图 - * @param range 范围对象 - * @param param 范围参数 - */ - scanRange( - range: IRange, - param: T - ): Iterable<[ITileLocator, IEnemyView]>; - - /** - * 迭代上下文中的全部怪物 - */ - iterateEnemy(): Iterable<[ITileLocator, IEnemyView]>; - /** * 添加一个全局光环视图 * @param aura 光环视图 @@ -656,22 +684,12 @@ export interface IEnemyContext { */ attachMapDamage(damage: IMapDamage | null): void; - /** - * 获取当前绑定的地图伤害管理器 - */ - getMapDamage(): IMapDamage | null; - /** * 绑定伤害计算系统 * @param system 伤害系统 */ attachDamageSystem(system: IDamageSystem | null): void; - /** - * 获取当前绑定的伤害计算系统 - */ - getDamageSystem(): IDamageSystem | null; - /** * 重建当前上下文中的全部怪物计算结果 * diff --git a/packages-user/data-system/src/trigger/collection.ts b/packages-user/data-system/src/trigger/collection.ts index 005a245..a1fe3cd 100644 --- a/packages-user/data-system/src/trigger/collection.ts +++ b/packages-user/data-system/src/trigger/collection.ts @@ -1,13 +1,10 @@ import { ITrigger, ITriggerCollection, ITriggerHandler } from './types'; -export class TriggerCollection< - TEnemy = unknown, - THero = unknown -> implements ITriggerCollection { +export class TriggerCollection implements ITriggerCollection { /** 当前集合内部维护的触发器列表 */ - private readonly triggerList: ITrigger[]; + private readonly triggerList: ITrigger[]; - constructor(triggers: Iterable>) { + constructor(triggers: Iterable) { this.triggerList = [...triggers]; } @@ -15,19 +12,15 @@ export class TriggerCollection< return this.triggerList.length; } - async trigger(handler: ITriggerHandler): Promise { + async trigger(handler: ITriggerHandler): Promise { for (const trigger of this.triggerList) { await trigger.trigger(handler); } } async *triggerIter( - handler: ITriggerHandler - ): AsyncGenerator< - ITrigger, - void, - ITriggerHandler | null - > { + handler: ITriggerHandler + ): AsyncGenerator { let currentHandler = handler; for (const trigger of this.triggerList) { await trigger.trigger(currentHandler); @@ -40,21 +33,19 @@ export class TriggerCollection< } } - iterate(): Iterable> { + iterate(): Iterable { return this.triggerList.values(); } - push(trigger: ITrigger): void { + push(trigger: ITrigger): void { this.triggerList.push(trigger); } - unshift(trigger: ITrigger): void { + unshift(trigger: ITrigger): void { this.triggerList.unshift(trigger); } - concat( - ...others: ITriggerCollection[] - ): ITriggerCollection { + concat(...others: ITriggerCollection[]): ITriggerCollection { const merged = [...this.triggerList]; for (const other of others) { merged.push(...other.iterate()); diff --git a/packages-user/data-system/src/trigger/collector.ts b/packages-user/data-system/src/trigger/collector.ts index 5be8589..94b13e6 100644 --- a/packages-user/data-system/src/trigger/collector.ts +++ b/packages-user/data-system/src/trigger/collector.ts @@ -8,18 +8,11 @@ import { import { logger } from '@motajs/common'; import { TriggerCollection } from './collection'; -export class TriggerCollector< - TEnemy = unknown, - THero = unknown -> implements ITriggerCollector { +export class TriggerCollector implements ITriggerCollector { /** 当前收集器使用的注册对象 */ - private registry: ITriggerRegistry | null = null; + private registry: ITriggerRegistry | null = null; - collect( - x: number, - y: number, - layer: IMapLayer - ): ITriggerCollection { + collect(x: number, y: number, layer: IMapLayer): ITriggerCollection { if (!this.registry) { logger.warn(135); return new TriggerCollection([]); @@ -62,8 +55,8 @@ export class TriggerCollector< const duplicate = new Set(); if (staticTrigger) { // 有静态触发器 - const lessTriggers: ITrigger[] = []; - const greaterTriggers: ITrigger[] = []; + const lessTriggers: ITrigger[] = []; + const greaterTriggers: ITrigger[] = []; // 先收集所有的触发器,并记录重复情况 for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { const trigger = this.registry.create(tile.triggerType); @@ -92,7 +85,7 @@ export class TriggerCollector< return new TriggerCollection(arr); } else { // 没有静态触发器 - const triggers: ITrigger[] = []; + const triggers: ITrigger[] = []; for (const tile of layer.dynamicLayer.getDynamicTilesAt(x, y)) { const trigger = this.registry.create(tile.triggerType); if (trigger) { @@ -113,7 +106,7 @@ export class TriggerCollector< } } - attachRegistry(registry: ITriggerRegistry | null): void { + attachRegistry(registry: ITriggerRegistry | null): void { this.registry = registry; } } diff --git a/packages-user/data-system/src/trigger/registry.ts b/packages-user/data-system/src/trigger/registry.ts index 3b161b7..87db139 100644 --- a/packages-user/data-system/src/trigger/registry.ts +++ b/packages-user/data-system/src/trigger/registry.ts @@ -2,28 +2,24 @@ import { logger } from '@motajs/common'; import { ITrigger, ITriggerRegistry, TriggerFactory } from './types'; import { IStateBase } from '@user/data-base'; -export class TriggerRegistry< - TEnemy = unknown, - THero = unknown -> implements ITriggerRegistry { +export class TriggerRegistry implements ITriggerRegistry { /** 数字类型到触发器工厂的映射 */ - private readonly typeMap: Map> = - new Map(); + private readonly typeMap: Map = new Map(); - constructor(public readonly state: IStateBase) {} + constructor(public readonly state: IStateBase) {} - register(type: number, factory: TriggerFactory): void { + register(type: number, factory: TriggerFactory): void { if (this.typeMap.has(type)) { logger.warn(132, 'type', type.toString()); } this.typeMap.set(type, factory); } - get(type: number): TriggerFactory | null { + get(type: number): TriggerFactory | null { return this.typeMap.get(type) ?? null; } - create(num: number): ITrigger | null { + create(num: number): ITrigger | null { const factory = this.get(num); if (!factory) return null; return factory(num, this.state); diff --git a/packages-user/data-system/src/trigger/types.ts b/packages-user/data-system/src/trigger/types.ts index db4bcff..ee25119 100644 --- a/packages-user/data-system/src/trigger/types.ts +++ b/packages-user/data-system/src/trigger/types.ts @@ -6,9 +6,9 @@ import { IStateBaseExtended } from '@user/data-base'; -export interface ITriggerHandler { +export interface ITriggerHandler { /** 当前全局状态对象 */ - readonly state: IStateBase; + readonly state: IStateBase; /** 当前楼层状态对象 */ readonly layer?: ILayerState; /** 当前参与触发的图层对象 */ @@ -17,15 +17,9 @@ export interface ITriggerHandler { readonly locator?: ITileLocator; } -export type TriggerFactory = ( - type: number, - state: IStateBase -) => ITrigger; +export type TriggerFactory = (type: number, state: IStateBase) => ITrigger; -export interface ITrigger< - TEnemy = unknown, - THero = unknown -> extends IStateBaseExtended { +export interface ITrigger extends IStateBaseExtended { /** 触发器类型标识 */ readonly type: number; /** 触发器优先级 */ @@ -35,39 +29,36 @@ export interface ITrigger< * 使用给定上下文触发当前触发器 * @param handler 触发上下文对象 */ - trigger(handler: ITriggerHandler): Promise; + trigger(handler: ITriggerHandler): Promise; /** * 将当前触发器包装为单元素触发器集合 */ - collection(): ITriggerCollection; + collection(): ITriggerCollection; } -export interface ITriggerRegistry< - TEnemy = unknown, - THero = unknown -> extends IStateBaseExtended { +export interface ITriggerRegistry extends IStateBaseExtended { /** * 注册一个按类型创建的触发器工厂 * @param type 触发器类型 * @param factory 触发器工厂函数 */ - register(type: number, factory: TriggerFactory): void; + register(type: number, factory: TriggerFactory): void; /** * 获取指定类型的触发器工厂 * @param type 触发器类型 */ - get(type: number): TriggerFactory | null; + get(type: number): TriggerFactory | null; /** * 根据触发器类型创建一个触发器实例,如果对应工厂不存在则返回 `null` * @param num 触发器类型 */ - create(num: number): ITrigger | null; + create(num: number): ITrigger | null; } -export interface ITriggerCollection { +export interface ITriggerCollection { /** * 当前集合中的触发器数量 */ @@ -77,62 +68,52 @@ export interface ITriggerCollection { * 顺序触发当前集合中的所有触发器 * @param handler 初始触发上下文对象 */ - trigger(handler: ITriggerHandler): Promise; + trigger(handler: ITriggerHandler): Promise; /** * 逐个触发当前集合中的触发器,并允许为下一次推进提供新上下文 * @param handler 初始触发上下文对象 */ triggerIter( - handler: ITriggerHandler - ): AsyncGenerator< - ITrigger, - void, - ITriggerHandler | null - >; + handler: ITriggerHandler + ): AsyncGenerator; /** * 迭代当前集合中的所有触发器 */ - iterate(): Iterable>; + iterate(): Iterable; /** * 向集合末尾追加一个触发器 * @param trigger 要追加的触发器 */ - push(trigger: ITrigger): void; + push(trigger: ITrigger): void; /** * 向集合头部插入一个触发器 * @param trigger 要插入的触发器 */ - unshift(trigger: ITrigger): void; + unshift(trigger: ITrigger): void; /** * 将当前集合与其他集合顺序拼接为一个新集合 * @param others 要拼接的其他集合 */ - concat( - ...others: ITriggerCollection[] - ): ITriggerCollection; + concat(...others: ITriggerCollection[]): ITriggerCollection; } -export interface ITriggerCollector { +export interface ITriggerCollector { /** * 收集指定图层中某一点的所有触发器 * @param x 横坐标 * @param y 纵坐标 * @param layer 目标图层 */ - collect( - x: number, - y: number, - layer: IMapLayer - ): ITriggerCollection; + collect(x: number, y: number, layer: IMapLayer): ITriggerCollection; /** * 绑定或清除当前 collector 使用的注册表 * @param registry 触发器注册表 */ - attachRegistry(registry: ITriggerRegistry | null): void; + attachRegistry(registry: ITriggerRegistry | null): void; } diff --git a/packages-user/data-system/src/types.ts b/packages-user/data-system/src/types.ts index 60f075c..2854eea 100644 --- a/packages-user/data-system/src/types.ts +++ b/packages-user/data-system/src/types.ts @@ -1,17 +1,18 @@ import { IStateBase } from '@user/data-base'; import { IEnemyContext } from './combat'; import { ITriggerCollector, ITriggerRegistry } from './trigger'; +import { IEnemyAttr, IHeroAttr } from '@user/data-common'; -export interface IStateSystem extends IStateBase { +export interface IStateSystem extends IStateBase { /** 怪物上下文 */ - readonly enemyContext: IEnemyContext; + readonly enemyContext: IEnemyContext; /** 触发器注册 */ - readonly triggerRegistry: ITriggerRegistry; + readonly triggerRegistry: ITriggerRegistry; /** 触发器收集器 */ - readonly triggerCollector: ITriggerCollector; + readonly triggerCollector: ITriggerCollector; } -export interface IStateSystemExtended { +export interface IStateSystemExtended { /** 当前对象对应的执行层对象(Layer 2 对象) */ - readonly state: IStateSystem; + readonly state: IStateSystem; } diff --git a/packages/common/src/logger.json b/packages/common/src/logger.json index 520470b..4bffa98 100644 --- a/packages/common/src/logger.json +++ b/packages/common/src/logger.json @@ -193,6 +193,7 @@ "133": "TileStore.addTile: tile number $1 already exists (id: '$2'), old tile data will be overridden.", "134": "TileStore.addTile: tile id '$1' already maps to number $2, old tile data will be overridden.", "135": "Expected a trigger registry attched before collect triggers.", - "136": "Unexpected duplicate trigger priority $1, which may cause trigger executed in an unexpected order." + "136": "Unexpected duplicate trigger priority $1, which may cause trigger executed in an unexpected order.", + "137": "Unknown guard enemy at locator '$1,$2'." } } From 2c89a4ac37cf83a981a258b04bc15d6e732629d7 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Mon, 18 May 2026 15:41:33 +0800 Subject: [PATCH 26/26] =?UTF-8?q?chore:=20=E7=A7=BB=E9=99=A4=E6=97=A0?= =?UTF-8?q?=E7=94=A8=E6=96=87=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages-user/legacy-plugin-data/src/index.ts | 4 - .../legacy-plugin-data/src/removeMap.ts | 111 ------------------ packages-user/legacy-plugin-data/src/ui.ts | 51 -------- 3 files changed, 166 deletions(-) delete mode 100644 packages-user/legacy-plugin-data/src/removeMap.ts delete mode 100644 packages-user/legacy-plugin-data/src/ui.ts diff --git a/packages-user/legacy-plugin-data/src/index.ts b/packages-user/legacy-plugin-data/src/index.ts index fb04005..bf81eaa 100644 --- a/packages-user/legacy-plugin-data/src/index.ts +++ b/packages-user/legacy-plugin-data/src/index.ts @@ -3,7 +3,6 @@ import { initFallback } from './fallback'; import { initFiveLayer } from './fiveLayer'; import { createHook } from './hook'; import { initReplay } from './replay'; -import { initUI } from './ui'; export function createLegacy() { initFallback(); @@ -11,13 +10,10 @@ export function createLegacy() { initFiveLayer(); createHook(); initReplay(); - initUI(); }); } export * from './fallback'; export * from './fiveLayer'; -export * from './removeMap'; export * from './replay'; export * from './shop'; -export * from './ui'; diff --git a/packages-user/legacy-plugin-data/src/removeMap.ts b/packages-user/legacy-plugin-data/src/removeMap.ts deleted file mode 100644 index e8e064c..0000000 --- a/packages-user/legacy-plugin-data/src/removeMap.ts +++ /dev/null @@ -1,111 +0,0 @@ -export function removeMaps( - fromId: FloorIds, - toId: FloorIds, - force: boolean = false -) { - toId = toId || fromId; - var fromIndex = core.floorIds.indexOf(fromId), - toIndex = core.floorIds.indexOf(toId); - if (toIndex < 0) toIndex = core.floorIds.length - 1; - // @ts-ignore - flags.__visited__ ??= {}; - flags.__removed__ ??= []; - flags.__disabled__ ??= {}; - // @ts-ignore - flags.__leaveLoc__ ??= {}; - flags.__forceDelete__ ??= {}; - let deleted = false; - for (var i = fromIndex; i <= toIndex; ++i) { - var floorId = core.floorIds[i]; - if (core.status.maps[floorId].deleted) continue; - delete flags.__visited__[floorId]; - flags.__removed__.push(floorId); - delete flags.__disabled__[floorId]; - delete flags.__leaveLoc__[floorId]; - (core.status.autoEvents || []).forEach(event => { - if (event.floorId == floorId && event.currentFloor) { - core.autoEventExecuting(event.symbol, false); - core.autoEventExecuted(event.symbol, false); - } - }); - core.status.maps[floorId].deleted = true; - core.status.maps[floorId].canFlyTo = false; - core.status.maps[floorId].canFlyFrom = false; - core.status.maps[floorId].cannotViewMap = true; - if (force) { - core.status.maps[floorId].forceDelete = true; - flags.__forceDelete__[floorId] = true; - } - deleteFlags(floorId); - deleted = true; - } - if (deleted && !main.replayChecking) { - Mota.require('@motajs/legacy-ui').splitArea(); - } -} - -export function deleteFlags(floorId: FloorIds) { - delete flags[`jump_${floorId}`]; - delete flags[`inte_${floorId}`]; - delete flags[`loop_${floorId}`]; - delete flags[`melt_${floorId}`]; - delete flags[`night_${floorId}`]; -} - -// 恢复楼层 -// core.plugin.removeMap.resumeMaps("MT1", "MT300") 恢复MT1~MT300之间的全部层 -// core.plugin.removeMap.resumeMaps("MT10") 只恢复MT10层 -export function resumeMaps(fromId: FloorIds, toId: FloorIds) { - toId = toId || fromId; - var fromIndex = core.floorIds.indexOf(fromId), - toIndex = core.floorIds.indexOf(toId); - if (toIndex < 0) toIndex = core.floorIds.length - 1; - flags.__removed__ = flags.__removed__ || []; - for (var i = fromIndex; i <= toIndex; ++i) { - var floorId = core.floorIds[i]; - if (!core.status.maps[floorId].deleted) continue; - if ( - core.status.maps[floorId].forceDelete || - flags.__forceDelete__[floorId] - ) - continue; - // @ts-ignore - flags.__removed__ = flags.__removed__.filter(f => { - return f != floorId; - }); - // @ts-ignore - core.status.maps[floorId] = core.loadFloor(floorId); - } -} - -// 分区砍层相关 -var inAnyPartition = (floorId: FloorIds) => { - var inPartition = false; - (core.floorPartitions || []).forEach(floor => { - var fromIndex = core.floorIds.indexOf(floor[0]); - var toIndex = core.floorIds.indexOf(floor[1]!); - var index = core.floorIds.indexOf(floorId); - if (fromIndex < 0 || index < 0) return; - if (toIndex < 0) toIndex = core.floorIds.length - 1; - if (index >= fromIndex && index <= toIndex) inPartition = true; - }); - return inPartition; -}; - -// 分区砍层 -export function autoRemoveMaps(floorId: FloorIds) { - if (main.mode != 'play' || !inAnyPartition(floorId)) return; - // 根据分区信息自动砍层与恢复 - (core.floorPartitions || []).forEach(floor => { - var fromIndex = core.floorIds.indexOf(floor[0]); - var toIndex = core.floorIds.indexOf(floor[1]!); - var index = core.floorIds.indexOf(floorId); - if (fromIndex < 0 || index < 0) return; - if (toIndex < 0) toIndex = core.floorIds.length - 1; - if (index >= fromIndex && index <= toIndex) { - resumeMaps(core.floorIds[fromIndex], core.floorIds[toIndex]); - } else { - removeMaps(core.floorIds[fromIndex], core.floorIds[toIndex]); - } - }); -} diff --git a/packages-user/legacy-plugin-data/src/ui.ts b/packages-user/legacy-plugin-data/src/ui.ts deleted file mode 100644 index f53bd9e..0000000 --- a/packages-user/legacy-plugin-data/src/ui.ts +++ /dev/null @@ -1,51 +0,0 @@ -// @ts-nocheck - -export function initUI() { - if (main.mode === 'editor') return; - if (!main.replayChecking) { - const { mainUi } = Mota.require('@motajs/legacy-ui'); - - ui.prototype.drawBook = function () { - if (!core.isReplaying()) return mainUi.open('book'); - }; - - ui.prototype._drawToolbox = function () { - if (!core.isReplaying()) return mainUi.open('toolbox'); - }; - - ui.prototype._drawEquipbox = function () { - if (!core.isReplaying()) return mainUi.open('equipbox'); - }; - - ui.prototype.drawFly = function () { - if (!core.isReplaying()) return mainUi.open('fly'); - }; - - control.prototype.showStatusBar = function () { - if (main.mode === 'editor') return; - core.removeFlag('hideStatusBar'); - core.updateStatusBar(); - }; - - control.prototype.hideStatusBar = function (showToolbox) { - if (main.mode === 'editor') return; - - // 如果原本就是隐藏的,则先显示 - if (!core.domStyle.showStatusBar) this.showStatusBar(); - if (core.isReplaying()) showToolbox = true; - core.setFlag('hideStatusBar', true); - core.setFlag('showToolbox', showToolbox || null); - core.updateStatusBar(); - }; - } - - control.prototype.updateStatusBar_update = function () { - core.control.updateNextFrame = false; - if (!core.isPlaying() || core.hasFlag('__statistics__')) return; - core.control.controldata.updateStatusBar(); - if (!core.control.noAutoEvents) core.checkAutoEvents(); - core.control._updateStatusBar_setToolboxIcon(); - core.control.noAutoEvents = true; - Mota.require('@user/data-base').hook.emit('statusBarUpdate'); - }; -}