meishibiezb/loneseDocument
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
29a3f779084590e498d1a88e13669ee95e5b5219
loneseDocument/README.md
meishibiezb 29a3f77908 init
2026-06-04 21:44:13 +08:00

122 lines
8.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# lonese 项目文档
> **维护者必读**：[HOWTO_REGENERATE_DOCS.md](HOWTO_REGENERATE_DOCS.md) — 文档是怎么生成的、踩过什么坑、如何复现。修改本文档之前请先看这篇。
## 文档索引
### 一、Source/lonese/（4 单位）
| 单位 | 文件 | 类型 | 父类 |
|------|------|------|------|
| AMyActor | [AMyActor.md](Source/lonese/AMyActor.md) | UCLASS | AActor |
| AMyCharacter | [AMyCharacter.md](Source/lonese/AMyCharacter.md) | UCLASS | ACharacter |
| ACameraPawn | [ACameraPawn.md](Source/lonese/ACameraPawn.md) | UCLASS | APawn |
| AMyPlayerController | [AMyPlayerController.md](Source/lonese/AMyPlayerController.md) | UCLASS | APlayerController |
依赖关系：[Source/lonese/_relationships.md](Source/lonese/_relationships.md)
### 二、Plugins/Item/（14 单位）
| 单位 | 文件 | 类型 | 父类 |
|------|------|------|------|
| FItemView | [FItemView.md](Plugins/Item/FItemView.md) | USTRUCT | — |
| IItemContainer | [IItemContainer.md](Plugins/Item/IItemContainer.md) | UINTERFACE | UInterface |
| IInventory | [IInventory.md](Plugins/Item/IInventory.md) | UINTERFACE | UInterface |
| FItemInstance | [FItemInstance.md](Plugins/Item/FItemInstance.md) | USTRUCT | — |
| FItemPropertyEntry | [FItemPropertyEntry.md](Plugins/Item/FItemPropertyEntry.md) | USTRUCT | — |
| FItemDef | [FItemDef.md](Plugins/Item/FItemDef.md) | USTRUCT | FTableRowBase |
| UItemTracer | [UItemTracer.md](Plugins/Item/UItemTracer.md) | UCLASS | UObject |
| UInternalItemProperty | [UInternalItemProperty.md](Plugins/Item/UInternalItemProperty.md) | UCLASS | UBlueprintFunctionLibrary |
| ItemFactory | [ItemFactory.md](Plugins/Item/ItemFactory.md) | C++ 静态类 | — |
| IItemViewStrategy | [IItemViewStrategy.md](Plugins/Item/IItemViewStrategy.md) | UINTERFACE | UInterface |
| FItemViewFactory | [FItemViewFactory.md](Plugins/Item/FItemViewFactory.md) | C++ 静态类 | — |
| UDefaultContainer | [UDefaultContainer.md](Plugins/Item/UDefaultContainer.md) | UCLASS | UObject |
| UItemRegistrySubsystem | [UItemRegistrySubsystem.md](Plugins/Item/UItemRegistrySubsystem.md) | UCLASS | UGameInstanceSubsystem |
| UItemRegistrySettings | [UItemRegistrySettings.md](Plugins/Item/UItemRegistrySettings.md) | UCLASS | UDeveloperSettings |
依赖关系：[Plugins/Item/_relationships.md](Plugins/Item/_relationships.md)
### 三、Plugins/Dialog/（10 单位）
| 单位 | 文件 | 类型 | 父类 |
|------|------|------|------|
| FDialogPresentationScriptData | [FDialogPresentationScriptData.md](Plugins/Dialog/FDialogPresentationScriptData.md) | USTRUCT | FTableRowBase |
| FDialogTextData | [FDialogTextData.md](Plugins/Dialog/FDialogTextData.md) | USTRUCT | FTableRowBase |
| EDialogPresentationScriptCommandParamType | [EDialogPresentationScriptCommandParamType.md](Plugins/Dialog/EDialogPresentationScriptCommandParamType.md) | UENUM | uint8 |
| FDialogPresentationScriptParam | [FDialogPresentationScriptParam.md](Plugins/Dialog/FDialogPresentationScriptParam.md) | USTRUCT | — |
| FDialogPresentationScriptCommand | [FDialogPresentationScriptCommand.md](Plugins/Dialog/FDialogPresentationScriptCommand.md) | USTRUCT | — |
| UPresentationJsonLibrary | [UPresentationJsonLibrary.md](Plugins/Dialog/UPresentationJsonLibrary.md) | UCLASS | UBlueprintFunctionLibrary |
| IPresentationStrategyPlugin | [IPresentationStrategyPlugin.md](Plugins/Dialog/IPresentationStrategyPlugin.md) | UINTERFACE | UInterface |
| IPresentationScriptExecutor | [IPresentationScriptExecutor.md](Plugins/Dialog/IPresentationScriptExecutor.md) | UINTERFACE | UInterface |
| FHelperArray | [FHelperArray.md](Plugins/Dialog/FHelperArray.md) | USTRUCT | — |
| UDialogPresentationSubsystem | [UDialogPresentationSubsystem.md](Plugins/Dialog/UDialogPresentationSubsystem.md) | UCLASS | UGameInstanceSubsystem |
依赖关系：[Plugins/Dialog/_relationships.md](Plugins/Dialog/_relationships.md)
### 四、Plugins/CharacterControl/（13 单位）
| 单位 | 文件 | 类型 | 父类 |
|------|------|------|------|
| FCommandMeta | [FCommandMeta.md](Plugins/CharacterControl/FCommandMeta.md) | USTRUCT | — |
| FContinuousPayload | [FContinuousPayload.md](Plugins/CharacterControl/FContinuousPayload.md) | USTRUCT | — |
| FCommandPacket | [FCommandPacket.md](Plugins/CharacterControl/FCommandPacket.md) | USTRUCT | — |
| FDiscreteMeta | [FDiscreteMeta.md](Plugins/CharacterControl/FDiscreteMeta.md) | USTRUCT | — |
| FEndpointState | [FEndpointState.md](Plugins/CharacterControl/FEndpointState.md) | USTRUCT | — |
| UEndpointDispatcher | [UEndpointDispatcher.md](Plugins/CharacterControl/UEndpointDispatcher.md) | UCLASS | UObject |
| ICommandEndpoint | [ICommandEndpoint.md](Plugins/CharacterControl/ICommandEndpoint.md) | UINTERFACE | UInterface |
| UCommandRouter | [UCommandRouter.md](Plugins/CharacterControl/UCommandRouter.md) | UCLASS | UObject |
| UCommandRouterComponent | [UCommandRouterComponent.md](Plugins/CharacterControl/UCommandRouterComponent.md) | UCLASS | UActorComponent |
| UEndpointComponent | [UEndpointComponent.md](Plugins/CharacterControl/UEndpointComponent.md) | UCLASS | UActorComponent |
| UCommandInputComponent | [UCommandInputComponent.md](Plugins/CharacterControl/UCommandInputComponent.md) | UCLASS | UEndpointComponent |
| FInputCommand | [FInputCommand.md](Plugins/CharacterControl/FInputCommand.md) | USTRUCT | — |
| UInputCommandData | [UInputCommandData.md](Plugins/CharacterControl/UInputCommandData.md) | UCLASS | UDataAsset |
依赖关系：[Plugins/CharacterControl/_relationships.md](Plugins/CharacterControl/_relationships.md)
### 五、Content/Blueprints/（15 单位）
| 单位 | 文件 | 类型 | 父类 |
|------|------|------|------|
| 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_TestMode | [BP_TestMode.md](Content/Blueprints/BP_TestMode.md) | Blueprint | GameModeBase |
| BP_Hud | [BP_Hud.md](Content/Blueprints/BP_Hud.md) | Blueprint | HUD |
| 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 |
依赖关系：[Content/Blueprints/_relationships.md](Content/Blueprints/_relationships.md)
---
## 文档模板说明
每个单位的文档包含以下章节：
1. **基本信息** — 类型、父类、源文件、模块
2. **功能概述** — 一句话概括单位的用途和使用场景
3. **设计用意** — 为什么这样设计，解决什么问题，在系统中的定位
4. **职责范围** — 自然语言描述该单位承担的工作范围
5. **项目内依赖** — 文件级依赖表格
6. **对外接口** — 从外部调用者视角描述的接口说明
7. **使用方法** — 引用项目真实代码位置说明典型用法
8. **用例** — 项目中实际使用本单位的文件和上下文
每个模块目录下还有一个 `_relationships.md` 文件，描述该模块内文件间的引用关系和关键数据/控制流依赖链。
---
## 统计
- **总单位数**: 56（4 + 14 + 10 + 13 + 15）
- **总文档文件**: 62（含 5 个 `_relationships.md` + 1 个 `README.md`）
- **覆盖模块**: 5（Source/lonese + 3 插件 + Content/Blueprints）
Reference in New Issue View Git Blame Copy Permalink