eclipse工程目录结构_UE4C++基础教程工程目录结构

简介

介绍UE4工程目录结构^[1]以及常用的目录操作接口^[2]。UE4将目录分为&＃xff1a;

• 引擎目录
• 项目目录

其中一些子目录是两个都有的&＃xff0c;称之为通用目录&＃xff0c;有一些目录是引擎特有的。当我们从github

上检出工程到本地时&＃xff0c;起始目录叫做根目录。此外&＃xff0c;开发过程中&＃xff0c;为了方便起见&＃xff0c;资源之间的引用是通过沙盒路径&＃xff08;虚拟路径&＃xff09;来进行标识的。

根目录

根目录说明如下&＃xff1a;

• Engine 引擎目录&＃xff0c;包含构成引擎的所有源代码、内容等。
• Samples 样例资源。
• Templates 样例工程模块&＃xff0c;创建新项目时可用的项目模板集合。
• Setup.bat 只需运行一次。
  • 拉取引擎的三方依赖
  • 安装引擎运行环境 - 执行EngineExtrasRedisten-usUE4PrereqSetup_x64.exe
  • 引擎注册 - 执行UnrealVersionSelector.exe&＃xff0c;让uproject可以被windows识别。
• GenerateProjectFiles.bat 用于生成引擎vs工程文件。

Setup 和 GenerateProjectFiles还有对应的 .sh 文件&＃xff0c;作用与.bat相同&＃xff0c;用于在Mac平台下是生成从xcode工程文件。.command是Mac平台下的一种快捷方式&＃xff0c;可以支持双击打开&＃xff0c;而不在命令行模式执行。

通用目录

一些子目录是在引擎和游戏项目目录之间通用的&＃xff1a;

• Binaries - 包含可执行文件或编译期间创建的其他文件。
• Build - 包含构建引擎或游戏所需的文件&＃xff0c;包括创建特定于平台的构建版所需的文件。
• Config - 配置文件&＃xff0c;用于设置用来控制引擎行为的值。项目Config文件中设置的值会覆盖 EngineConfig 目录中设置的值。
• Content - 保存引擎或游戏的内容&＃xff0c;包括资源包和贴图。
• DerivedDataCache - 包含加载时针对引用内容生成的派生数据文件。引用内容没有相应的缓存文件会导致加载时间显著延长。
• Intermediate - 包含构建引擎或游戏时生成的临时文件。在游戏目录中&＃xff0c;着色器存储在Intermediate目录中。
• Saved - 包含自动保存、配置&＃xff08;.ini&＃xff09;文件和日志文件。此外&＃xff0c;EngineSaved目录还包含崩溃日志、硬件信息和Swarm选项与数据。
• Source - 包含引擎或游戏的所有源文件&＃xff0c;包括引擎源代码、工具和游戏类等。
  • Engine - Engine目录中的源文件组织结构如下&＃xff1a;
    • Developer - 编辑器和引擎共同使用的文件。
    • Editor - 仅供编辑器使用的文件。
    • Programs - 引擎或编辑器使用的外部工具。
    • Runtime - 仅供引擎使用的文件。
  • Game - 游戏项目源码&＃xff0c;建议按模块的方式进行组织。

源码模块组织方式

游戏项目目录中的源文件按模块分组&＃xff0c;一个模块一个目录。每个模块包含以下内容&＃xff1a;

• Classes - 包含所有项目头&＃xff08;.h&＃xff09;文件。
• Private - 包含所有 .cpp 文件&＃xff0c;包括游戏类实现文件和模块实现文件。
• Public - 包含模块标头文件。

引擎Source模块

引擎Source目录下分为以下目录&＃xff1a;

• Developer - Editor&Programs会使用&＃xff0c;但不能是Games
• Editor - 只被Editor使用
• Programs - 独立的Applitcations或者工具类
• Runtime - Editor,Games,Programs都会使用
• ThirdParty - 第三方库

模块依赖原则

• Runtime 模块不能依赖 Editor或者Developer中的模块
• Plug-in 模块不能依赖其他Plug-ins

基础模块&＃xff08;新手&＃xff09;

• Core - Fundamental core types & functions 基础数据类型和函数
• CoreUObject - UObject实现
• Engine - Game类以及引擎核心框架
• OnlineSubsystem - Online & social networking features
• Slate - Widget library & high-level UI features

其他几个有趣模块&＃xff08;进阶&＃xff09;

• DesktopPlatform – Useful APIs for Windows, Mac & Linux
• DetailCustomizations – Editor’s Details panel customizations
• Launch – Main loop classes & functions
• Messaging – Message passing sub-system
• Sockets – Network socket implementations
• Settings – Editor & Project Settings API
• SlateCore – Fundamental UI functionality
• TargetPlatform – Platform abstraction layer
• UMG – Unreal Motion Graphics implementation
• UnrealEd – Unreal Editor main frame & features
• Analytics – Collects usage statistics from Editor & games
• AssetRegistry – Database for assets in Unreal Editor
• GameLiveStreaming – Twitch Streaming
• HeadMountedDisplay – HMD Support API (Oculus, etc.)
• JsonUtilities & XmlParser – Handle Json & XML files
• SourceControl – API for custom source control providers

特定于引擎的目录

部分子目录特定于Engine目录。

• Documentation - 包含引擎文档&＃xff0c;包括源文件和发布的文件。
  • HTML - 发布的HTML文档文件。
  • Source - 源markdown文档文件。
• Extras - 其他帮助和实用程序文件。
• Plugins - 包含引擎中使用的插件。
• Programs - 包含UE4根目录中存储的项目以及其他虚幻程序&＃xff08;如UnrealFrontend和UnrealHeaderTool&＃xff09;的配置文件和日志文件。
• Shaders - 保存引擎的着色器源文件&＃xff08;.usf&＃xff09;。

游戏项目目录

• Binaries - 包含可执行文件或编译期间创建的其他文件。
• Config - 游戏的默认项目设置。
• Content - 包含引擎或游戏的内容&＃xff0c;包括资源包和贴图。
• Plugins - 包含项目中使用的插件。
• Intermediate - 包含UnrealBuildTool生成的文件&＃xff0c;如Visual Studio项目文件。这些文件可以删除并重新构建。
• Saved - 包含引擎生成的文件&＃xff0c;如配置文件和日志。这些文件可以删除并重新构建。
• Source - 包含游戏模块对象类文件。
• EasyUE4.sln 项目vs工程文件。
• EasyUE4.uproject 项目文件。
• EasyUE4.vs.db vs分析源码后的数据缓存&＃xff0c;可以理解为ctags文件。

Plugin插件目录

• Binaries - 包含可执行文件或编译期间创建的其他文件。
• Content - 包含游戏内用到的插件资源目录。
• Intermediate - 包含UnrealBuildTool生成的文件&＃xff0c;如Visual Studio项目文件。这些文件可以删除并重新构建。
• Resources - 插件额外资源目录&＃xff0c;如插件图标。
• ThirdParty - 插件依赖的三方库目录。
• ScriptPlugin.uplugin 插件文件&＃xff0c;包含这个文件的目录会被UE4识别为一个插件目录。

沙盒路径

当我们在编辑器状态下浏览资源时&＃xff0c;显示的资源路径&＃xff0c;通常是沙盒路径

其中 /Game 是一个虚拟路径&＃xff0c;实际表示的是项目的 FPaths::ProjectContentDir() 。/Engine 也是一个虚拟路径&＃xff0c;实际路径是引擎的 FPaths::EngineContentDir()。更多虚拟路径可以查阅源码^[3]

类 FLongPackagePathsSingleton 的定义。

内容浏览器视图选项勾选显示引擎内容操作如下所示&＃xff1a;

路径获取和操作API

输出

参考

1. ^目录结构 https://docs.unrealengine.com/zh-CN/Engine/Basics/DirectoryStructure/index.html
2. ^FPaths https://docs.unrealengine.com/en-US/API/Runtime/Core/Misc/FPaths/index.html
3. ^FPackageName https://docs.unrealengine.com/en-US/API/Runtime/CoreUObject/Misc/FPackageName/index.html