8.2 KiB
8.2 KiB
lonese 项目文档
维护者必读：HOWTO_REGENERATE_DOCS.md — 文档是怎么生成的、踩过什么坑、如何复现。修改本文档之前请先看这篇。
文档索引
一、Source/lonese/（4 单位）
| 单位 | 文件 | 类型 | 父类 |
|---|---|---|---|
| AMyActor | AMyActor.md | UCLASS | AActor |
| AMyCharacter | AMyCharacter.md | UCLASS | ACharacter |
| ACameraPawn | ACameraPawn.md | UCLASS | APawn |
| AMyPlayerController | AMyPlayerController.md | UCLASS | APlayerController |
依赖关系：Source/lonese/_relationships.md
二、Plugins/Item/（14 单位）
| 单位 | 文件 | 类型 | 父类 |
|---|---|---|---|
| FItemView | FItemView.md | USTRUCT | — |
| IItemContainer | IItemContainer.md | UINTERFACE | UInterface |
| IInventory | IInventory.md | UINTERFACE | UInterface |
| FItemInstance | FItemInstance.md | USTRUCT | — |
| FItemPropertyEntry | FItemPropertyEntry.md | USTRUCT | — |
| FItemDef | FItemDef.md | USTRUCT | FTableRowBase |
| UItemTracer | UItemTracer.md | UCLASS | UObject |
| UInternalItemProperty | UInternalItemProperty.md | UCLASS | UBlueprintFunctionLibrary |
| ItemFactory | ItemFactory.md | C++ 静态类 | — |
| IItemViewStrategy | IItemViewStrategy.md | UINTERFACE | UInterface |
| FItemViewFactory | FItemViewFactory.md | C++ 静态类 | — |
| UDefaultContainer | UDefaultContainer.md | UCLASS | UObject |
| UItemRegistrySubsystem | UItemRegistrySubsystem.md | UCLASS | UGameInstanceSubsystem |
| UItemRegistrySettings | UItemRegistrySettings.md | UCLASS | UDeveloperSettings |
依赖关系：Plugins/Item/_relationships.md
三、Plugins/Dialog/（10 单位）
| 单位 | 文件 | 类型 | 父类 |
|---|---|---|---|
| FDialogPresentationScriptData | FDialogPresentationScriptData.md | USTRUCT | FTableRowBase |
| FDialogTextData | FDialogTextData.md | USTRUCT | FTableRowBase |
| EDialogPresentationScriptCommandParamType | EDialogPresentationScriptCommandParamType.md | UENUM | uint8 |
| FDialogPresentationScriptParam | FDialogPresentationScriptParam.md | USTRUCT | — |
| FDialogPresentationScriptCommand | FDialogPresentationScriptCommand.md | USTRUCT | — |
| UPresentationJsonLibrary | UPresentationJsonLibrary.md | UCLASS | UBlueprintFunctionLibrary |
| IPresentationStrategyPlugin | IPresentationStrategyPlugin.md | UINTERFACE | UInterface |
| IPresentationScriptExecutor | IPresentationScriptExecutor.md | UINTERFACE | UInterface |
| FHelperArray | FHelperArray.md | USTRUCT | — |
| UDialogPresentationSubsystem | UDialogPresentationSubsystem.md | UCLASS | UGameInstanceSubsystem |
依赖关系：Plugins/Dialog/_relationships.md
四、Plugins/CharacterControl/（13 单位）
| 单位 | 文件 | 类型 | 父类 |
|---|---|---|---|
| FCommandMeta | FCommandMeta.md | USTRUCT | — |
| FContinuousPayload | FContinuousPayload.md | USTRUCT | — |
| FCommandPacket | FCommandPacket.md | USTRUCT | — |
| FDiscreteMeta | FDiscreteMeta.md | USTRUCT | — |
| FEndpointState | FEndpointState.md | USTRUCT | — |
| UEndpointDispatcher | UEndpointDispatcher.md | UCLASS | UObject |
| ICommandEndpoint | ICommandEndpoint.md | UINTERFACE | UInterface |
| UCommandRouter | UCommandRouter.md | UCLASS | UObject |
| UCommandRouterComponent | UCommandRouterComponent.md | UCLASS | UActorComponent |
| UEndpointComponent | UEndpointComponent.md | UCLASS | UActorComponent |
| UCommandInputComponent | UCommandInputComponent.md | UCLASS | UEndpointComponent |
| FInputCommand | FInputCommand.md | USTRUCT | — |
| UInputCommandData | UInputCommandData.md | UCLASS | UDataAsset |
依赖关系：Plugins/CharacterControl/_relationships.md
五、Content/Blueprints/（15 单位）
| 单位 | 文件 | 类型 | 父类 |
|---|---|---|---|
| BP_TestChar | BP_TestChar.md | Blueprint | AMyCharacter |
| BP_TestCtl | BP_TestCtl.md | Blueprint | AMyPlayerController |
| BP_CameraPawn | BP_CameraPawn.md | Blueprint | ACameraPawn |
| BP_TestMode | BP_TestMode.md | Blueprint | GameModeBase |
| BP_Hud | BP_Hud.md | Blueprint | HUD |
| BP_UniversalEndpointComp | BP_UniversalEndpointComp.md | Blueprint | UEndpointComponent |
| BP_MoveInput | BP_MoveInput.md | Blueprint | UEndpointComponent |
| BP_ControllerComp | BP_ControllerComp.md | Blueprint | UEndpointComponent |
| BP_SayHello | BP_SayHello.md | Blueprint | UEndpointComponent |
| BP_DefaultContainer | BP_DefaultContainer.md | Blueprint | UDefaultContainer |
| BP_InventoryComp | BP_InventoryComp.md | Blueprint | ActorComponent |
| BP_DropItemInvComp | BP_DropItemInvComp.md | Blueprint | BP_InventoryComp |
| BP_Bomb | BP_Bomb.md | Blueprint | Actor |
| WBP_TestUI | WBP_TestUI.md | Blueprint | UserWidget |
| WBP_InventoryView | WBP_InventoryView.md | Blueprint | UserWidget |
依赖关系：Content/Blueprints/_relationships.md
文档模板说明
每个单位的文档包含以下章节：
- 基本信息 — 类型、父类、源文件、模块
- 功能概述 — 一句话概括单位的用途和使用场景
- 设计用意 — 为什么这样设计，解决什么问题，在系统中的定位
- 职责范围 — 自然语言描述该单位承担的工作范围
- 项目内依赖 — 文件级依赖表格
- 对外接口 — 从外部调用者视角描述的接口说明
- 使用方法 — 引用项目真实代码位置说明典型用法
- 用例 — 项目中实际使用本单位的文件和上下文
每个模块目录下还有一个 _relationships.md 文件，描述该模块内文件间的引用关系和关键数据/控制流依赖链。
统计
- 总单位数: 56（4 + 14 + 10 + 13 + 15）
- 总文档文件: 62（含 5 个
_relationships.md+ 1 个README.md） - 覆盖模块: 5（Source/lonese + 3 插件 + Content/Blueprints）