update
This commit is contained in:
63
README.md
63
README.md
@@ -1,7 +1,5 @@
|
||||
# lonese 项目文档
|
||||
|
||||
> **维护者必读**:[HOWTO_REGENERATE_DOCS.md](HOWTO_REGENERATE_DOCS.md) — 文档是怎么生成的、踩过什么坑、如何复现。修改本文档之前请先看这篇。
|
||||
|
||||
## 文档索引
|
||||
|
||||
### 一、Source/lonese/(4 单位)
|
||||
@@ -73,28 +71,57 @@
|
||||
|
||||
依赖关系:[Plugins/CharacterControl/_relationships.md](Plugins/CharacterControl/_relationships.md)
|
||||
|
||||
### 五、Content/Blueprints/(15 单位)
|
||||
### 五、Content/Blueprints/(32 单位)
|
||||
|
||||
| 单位 | 文件 | 类型 | 父类 |
|
||||
|------|------|------|------|
|
||||
| ABP_TestChar | [ABP_TestChar.md](Content/Blueprints/ABP_TestChar.md) | AnimBlueprint | AnimInstance |
|
||||
| BP_Barrel | [BP_Barrel.md](Content/Blueprints/BP_Barrel.md) | Blueprint | Actor |
|
||||
| BP_Bomb | [BP_Bomb.md](Content/Blueprints/BP_Bomb.md) | Blueprint | Actor |
|
||||
| BP_CameraPawn | [BP_CameraPawn.md](Content/Blueprints/BP_CameraPawn.md) | Blueprint | ACameraPawn |
|
||||
| BP_ControllerComp | [BP_ControllerComp.md](Content/Blueprints/BP_ControllerComp.md) | Blueprint | UEndpointComponent |
|
||||
| BP_DefaultContainer | [BP_DefaultContainer.md](Content/Blueprints/BP_DefaultContainer.md) | Blueprint | UDefaultContainer |
|
||||
| BP_DropItemInvComp | [BP_DropItemInvComp.md](Content/Blueprints/BP_DropItemInvComp.md) | Blueprint | BP_InventoryComp |
|
||||
| BP_Hud | [BP_Hud.md](Content/Blueprints/BP_Hud.md) | Blueprint | HUD |
|
||||
| BP_InventoryComp | [BP_InventoryComp.md](Content/Blueprints/BP_InventoryComp.md) | Blueprint | ActorComponent |
|
||||
| BP_InventoryDrop | [BP_InventoryDrop.md](Content/Blueprints/BP_InventoryDrop.md) | Blueprint | Actor |
|
||||
| BP_ItemTrap | [BP_ItemTrap.md](Content/Blueprints/BP_ItemTrap.md) | Blueprint | Actor |
|
||||
| BP_ItemViewDataView | [BP_ItemViewDataView.md](Content/Blueprints/BP_ItemViewDataView.md) | Blueprint | Object |
|
||||
| BP_MoveInput | [BP_MoveInput.md](Content/Blueprints/BP_MoveInput.md) | Blueprint | UEndpointComponent |
|
||||
| BP_NewChar | [BP_NewChar.md](Content/Blueprints/BP_NewChar.md) | Blueprint | Character |
|
||||
| BP_SayHello | [BP_SayHello.md](Content/Blueprints/BP_SayHello.md) | Blueprint | UEndpointComponent |
|
||||
| BP_TestChar | [BP_TestChar.md](Content/Blueprints/BP_TestChar.md) | Blueprint | AMyCharacter |
|
||||
| BP_TestCtl | [BP_TestCtl.md](Content/Blueprints/BP_TestCtl.md) | Blueprint | AMyPlayerController |
|
||||
| BP_CameraPawn | [BP_CameraPawn.md](Content/Blueprints/BP_CameraPawn.md) | Blueprint | ACameraPawn |
|
||||
| BP_TestItem | [BP_TestItem.md](Content/Blueprints/BP_TestItem.md) | Blueprint | Actor |
|
||||
| BP_TestItemCluster | [BP_TestItemCluster.md](Content/Blueprints/BP_TestItemCluster.md) | Blueprint | Actor |
|
||||
| BP_TestMode | [BP_TestMode.md](Content/Blueprints/BP_TestMode.md) | Blueprint | GameModeBase |
|
||||
| BP_Hud | [BP_Hud.md](Content/Blueprints/BP_Hud.md) | Blueprint | HUD |
|
||||
| BP_Trap | [BP_Trap.md](Content/Blueprints/BP_Trap.md) | Blueprint | Actor |
|
||||
| BP_UniversalEndpointComp | [BP_UniversalEndpointComp.md](Content/Blueprints/BP_UniversalEndpointComp.md) | Blueprint | UEndpointComponent |
|
||||
| BP_MoveInput | [BP_MoveInput.md](Content/Blueprints/BP_MoveInput.md) | Blueprint | UEndpointComponent |
|
||||
| BP_ControllerComp | [BP_ControllerComp.md](Content/Blueprints/BP_ControllerComp.md) | Blueprint | UEndpointComponent |
|
||||
| BP_SayHello | [BP_SayHello.md](Content/Blueprints/BP_SayHello.md) | Blueprint | UEndpointComponent |
|
||||
| BP_DefaultContainer | [BP_DefaultContainer.md](Content/Blueprints/BP_DefaultContainer.md) | Blueprint | UDefaultContainer |
|
||||
| BP_InventoryComp | [BP_InventoryComp.md](Content/Blueprints/BP_InventoryComp.md) | Blueprint | ActorComponent |
|
||||
| BP_DropItemInvComp | [BP_DropItemInvComp.md](Content/Blueprints/BP_DropItemInvComp.md) | Blueprint | BP_InventoryComp |
|
||||
| BP_Bomb | [BP_Bomb.md](Content/Blueprints/BP_Bomb.md) | Blueprint | Actor |
|
||||
| WBP_TestUI | [WBP_TestUI.md](Content/Blueprints/WBP_TestUI.md) | Blueprint | UserWidget |
|
||||
| WBP_InventoryView | [WBP_InventoryView.md](Content/Blueprints/WBP_InventoryView.md) | Blueprint | UserWidget |
|
||||
| WBP_ChoiceButton | [WBP_ChoiceButton.md](Content/Blueprints/WBP_ChoiceButton.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Circle | [WBP_Circle.md](Content/Blueprints/WBP_Circle.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Hint | [WBP_Hint.md](Content/Blueprints/WBP_Hint.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_InventoryView | [WBP_InventoryView.md](Content/Blueprints/WBP_InventoryView.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_ItemViewBox | [WBP_ItemViewBox.md](Content/Blueprints/WBP_ItemViewBox.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Module1 | [WBP_Module1.md](Content/Blueprints/WBP_Module1.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Module2 | [WBP_Module2.md](Content/Blueprints/WBP_Module2.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Resources | [WBP_Resources.md](Content/Blueprints/WBP_Resources.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_TestUI | [WBP_TestUI.md](Content/Blueprints/WBP_TestUI.md) | WidgetBlueprint | UserWidget |
|
||||
| WBP_Window | [WBP_Window.md](Content/Blueprints/WBP_Window.md) | WidgetBlueprint | UserWidget |
|
||||
|
||||
依赖关系:[Content/Blueprints/_relationships.md](Content/Blueprints/_relationships.md)
|
||||
|
||||
### 六、Content/Data/(5 单位)
|
||||
|
||||
| 单位 | 文件 | 类型 | 父类 |
|
||||
|------|------|------|------|
|
||||
| DA_InputCommands | [DA_InputCommands.md](Content/Data/DA_InputCommands.md) | InputCommandData | — |
|
||||
| NewGraph | [NewGraph.md](Content/Data/NewGraph.md) | DialogGraphDataAsset | — |
|
||||
| TestDialog | [TestDialog.md](Content/Data/TestDialog.md) | DataTable | — |
|
||||
| TestDialogMap | [TestDialogMap.md](Content/Data/TestDialogMap.md) | DataTable | — |
|
||||
| TestItemDefTable | [TestItemDefTable.md](Content/Data/TestItemDefTable.md) | DataTable | — |
|
||||
|
||||
依赖关系:[Content/Data/_relationships.md](Content/Data/_relationships.md)
|
||||
|
||||
---
|
||||
|
||||
## 文档模板说明
|
||||
@@ -106,7 +133,7 @@
|
||||
3. **设计用意** — 为什么这样设计,解决什么问题,在系统中的定位
|
||||
4. **职责范围** — 自然语言描述该单位承担的工作范围
|
||||
5. **项目内依赖** — 文件级依赖表格
|
||||
6. **对外接口** — 从外部调用者视角描述的接口说明
|
||||
6. **外部视角** — 从外部调用者视角描述的接口说明
|
||||
7. **使用方法** — 引用项目真实代码位置说明典型用法
|
||||
8. **用例** — 项目中实际使用本单位的文件和上下文
|
||||
|
||||
@@ -116,6 +143,6 @@
|
||||
|
||||
## 统计
|
||||
|
||||
- **总单位数**: 56(4 + 14 + 10 + 13 + 15)
|
||||
- **总文档文件**: 62(含 5 个 `_relationships.md` + 1 个 `README.md`)
|
||||
- **覆盖模块**: 5(Source/lonese + 3 插件 + Content/Blueprints)
|
||||
- **总单位数**: 78(4 + 14 + 10 + 13 + 32 + 5)
|
||||
- **总文档文件**: 85(含 6 个 `_relationships.md` + 1 个 `README.md`)
|
||||
- **覆盖模块**: 6(Source/lonese + 3 插件 + Content/Blueprints + Content/Data)
|
||||
|
||||
Reference in New Issue
Block a user