ed/UE5_Study
1
0
Fork 0
mirror of https://github.com/Ed94/UE5_Study.git synced 2024-12-22 06:24:44 -08:00
Code Issues Packages Projects Releases Wiki Activity

Small progress on ubt doc

Browse Source 
There was some additional info on ubtignore that I haven't written about yet as well.
This commit is contained in:
Edward R. Gonzalez 2023-08-31 15:45:22 -04:00
parent c074c0a119
commit 82c6836078
2 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/Build & Automation System/UBT.md
View File

@ -62,3 +62,29 @@ Derived from ToolMode, used to build a *target*.
- Handle local builds - Handle local builds
- Get all project directories & build options - Get all project directories & build options
- For each project: create a `SourceFileWorkingSet` object and `Build`. - For each project: create a `SourceFileWorkingSet` object and `Build`.
7. Process the dumps to see if anything failed.
8. Save Caches
`BuildConfiguration` Contains target agonstic settings.
## QueueProjectDirectory
Used when retreving all project directories.
Will Enqueue a `FileMetadataPrefetch.ScanProjectDirectory` call for the directory with the prefecter.
### ScanProjectDirectory
1. Get all extension directoires for the target project directory
2. For each directory
- Enqueue a scan of the plugin directory (`ScanPluginFolder`, the `Plugins` folder)
- Enqueue a scan of the project directory (`ScanDirectoryTree`, the `Source` folder)
`Unreal.GetExtensionDirs` will do an initial scan for Platform, Restricted, and BaseDirectories, and remove them from CachedDirectories based if any of options for doing so are set.
#### ScanPluginFolder

5
docs/Readme.md
View File

@ -3,8 +3,9 @@
## Conventions ## Conventions
These docs will be written in a free-flow fasion. The main purpose of this repo is to remove the knowledge barrier to the engine. There are plenty of content written for this engine, but its not provided in a way that is easy to digest. These docs will be written in a free-flow fasion. The main purpose of this repo is to remove the knowledge barrier to the engine. There are plenty of content written for this engine, but its not provided in a way that is easy to digest.
The order the engine is studied will be covered within in [journey](journey.md). The order the engine is studied will be covered within in [Journey](journey.md).
The perspective of the reader is for someone who's become accostomed to using the engine and is vaugely familiar with the code base, however they never really looked through the engine because there is no actual docs.
The perspective of the writting is from someone who's become accostomed to using the engine and is vaugely familiar with the code base, however they never really looked through the engine because there is no actual docs.
Hopefully if the reader is interested in learning the engine, this approach will at least give an idea of how they could approach going about it. Hopefully if the reader is interested in learning the engine, this approach will at least give an idea of how they could approach going about it.