mirror of
https://github.com/motajs/template.git
synced 2026-11-19 10:44:30 +08:00
docs(10-19): 按 D-58 调整高级教程模板与定位
- 高级 I 不再强制模板章节:移除 declarative、replay、hooks 的泛化骨架,保留 plugin、saveable 与精简后的 data-stores - 移除「不懂代码就改内置」类中级提示,改为 D-55(新增系统优先插件,必要时才改内置) - 补充 D-58 修订记录
This commit is contained in:
1 parent
e449579f25
commit
f1c0f8b2a4
8 files changed
+110
-221
No files matched your search
@@ -242,7 +242,7 @@ if (holder && holder.status === PluginStatus.Loaded) {
|
||||
|
||||
然后在 `list.ts` 里 `new` 出来加进 `dataPlugins`。最终传给 `CoreState` 的插件数组在 `src/data/entry.ts` 里拼成:主插件在前,`dataPlugins` 展开在后。日常只需要改 `list.ts`,不必动 `entry.ts`。
|
||||
|
||||
这是少数<strong>应该新建文件与目录</strong>的场景:插件本身就是一个独立单元,把它的类、接口和对象放在一起,比全部塞进 `initialize.ts` 更容易维护。除此之外的普通效果仍然优先改内置文件,不要为每个效果新建目录。
|
||||
这是少数<strong>应该新建文件与目录</strong>的场景:插件本身就是一个独立单元,把它的类、接口和对象放在一起,比全部塞进 `initialize.ts` 更容易维护。除此之外的普通效果直接写在对应的内置实现文件里,不要为每个效果新建目录。
|
||||
|
||||
## 模板:一个插件的最小骨架
|
||||
|
||||
@@ -374,16 +374,14 @@ async afterLoad(state: ICoreState): Promise<void> {
|
||||
|
||||
它同时说明了另一个点:`afterLoad` 拿到的 `state` 与 `awake` 是同一个主对象,`awake` 里存下的引用(如 `this.heroFace`)此时仍然可用。
|
||||
|
||||
## 改内置还是自己写
|
||||
## 改现有插件还是新建插件
|
||||
|
||||
先分清两种改动:
|
||||
|
||||
- 只是给现有插件加一点行为,例如给商店多一个查询接口、调整某个系统的默认值——<strong>直接改现有插件的代码</strong>,在它的类里加方法或改实现;
|
||||
- 要加一组独立的功能,有自己的状态、自己的管理器、自己的存档内容——<strong>新建插件</strong>。
|
||||
- 要加一组独立的功能,有自己的状态、自己的管理器、自己的存档内容——<strong>新建插件</strong>。新建的插件同样留在 `src` 里,升级时不用跟着内置包的差异走。
|
||||
|
||||
新建插件比改内置多出不少工作:目录、注册、依赖声明、存档 id、加载时机都要自己定。能改内置解决的问题,不值得再包一层。
|
||||
|
||||
<strong>如果你不怎么懂代码,建议直接改内置,而不是自己写新的插件</strong>。在内置类的方法里加几行,出问题时对照原有代码就能看出差异;新建插件则要同时处理注册、依赖与时机,排查面大得多。
|
||||
这里说的「改内置」只指改 `packages` / `packages-user` 里的代码。新增系统优先做成插件,正是为了不碰它们;只有现有插件与扩展点都覆盖不了、必须替换内置行为时,才去动内置包。
|
||||
|
||||
## 常见错误
|
||||
|
||||
@@ -446,6 +444,6 @@ console.log(holder?.status === PluginStatus.Loaded, holder?.plugin);
|
||||
- `awake` 在构造期同步执行,不能等异步;`initialize` 在加载前、`afterLoad` 在加载后,二者都会阻塞。
|
||||
- 三个阶段都按依赖顺序走;循环依赖、缺失依赖会连同下游一起被阻断。
|
||||
- 插件 id 是对外契约,不要随意改名或复用;它与可存档 id 是两套命名。
|
||||
- 优先改内置;需要独立成组的功能时再写插件。
|
||||
- 新增系统优先写成插件;只有必要时才改内置包。
|
||||
|
||||
返回[高级 I 导览](./index.md)。
|
||||
Reference in new issue
Block a user