AsyncLoadingScreen 开源项目教程
1. 项目的目录结构及介绍
AsyncLoadingScreen 项目的目录结构如下:
AsyncLoadingScreen/
├── Config/
│ └── DefaultAsyncLoadingScreen.ini
├── Content/
│ └── DefaultContent/
│ └── ...
├── Resources/
│ └── ...
├── Source/
│ └── AsyncLoadingScreen/
│ ├── AsyncLoadingScreen.Build.cs
│ ├── AsyncLoadingScreen.cpp
│ ├── AsyncLoadingScreen.h
│ └── ...
├── .gitignore
├── AsyncLoadingScreen.uplugin
├── LICENSE
├── README.md
目录结构介绍
- Config/: 包含项目的配置文件,如
DefaultAsyncLoadingScreen.ini
。 - Content/: 包含默认内容文件,如图片、视频等。
- Resources/: 包含项目所需的其他资源文件。
- Source/AsyncLoadingScreen/: 包含项目的源代码文件,如
.cpp
、.h
和构建脚本.Build.cs
。 - .gitignore: Git 忽略文件配置。
- AsyncLoadingScreen.uplugin: 项目的插件描述文件。
- LICENSE: 项目的许可证文件。
- README.md: 项目的说明文档。
2. 项目的启动文件介绍
AsyncLoadingScreen 项目的启动文件主要是 AsyncLoadingScreen.uplugin
。
AsyncLoadingScreen.uplugin
这是一个 JSON 格式的文件,用于描述插件的基本信息和依赖关系。以下是该文件的部分内容:
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.0",
"FriendlyName": "Async Loading Screen",
"Description": "Allows you to easily configure a Loading Screen System in the project settings and automatically add a Loading Screen whenever you open a new level without Level Streaming.",
"Category": "Other",
"CreatedBy": "Truong Bui",
"CreatedByURL": "https://github.com/truong-bui",
"DocsURL": "",
"MarketplaceURL": "https://www.unrealengine.com/marketplace/en-US/product/async-loading-screen",
"SupportURL": "https://github.com/truong-bui/AsyncLoadingScreen/issues",
"EnabledByDefault": false,
"CanContainContent": true,
"IsBetaVersion": false,
"Installed": false,
"Modules": [
{
"Name": "AsyncLoadingScreen",
"Type": "Runtime",
"LoadingPhase": "Default",
"WhitelistPlatforms": [
"Win64",
"Mac",
"Linux"
]
}
]
}
启动文件介绍
- FileVersion: 文件版本号。
- Version: 插件版本号。
- VersionName: 版本名称。
- FriendlyName: 插件的友好名称。
- Description: 插件的描述信息。
- Category: 插件分类。
- CreatedBy: 插件作者。
- CreatedByURL: 作者的 URL。
- MarketplaceURL: 插件在 Unreal Engine 市场的 URL。
- SupportURL: 支持页面 URL。
- Modules: 插件包含的模块信息。
3. 项目的配置文件介绍
AsyncLoadingScreen 项目的配置文件主要是 Config/DefaultAsyncLoadingScreen.ini
。
DefaultAsyncLoadingScreen.ini
这是一个 INI 格式的文件,用于配置加载屏幕的各种设置。以下是该文件的部分内容:
[AsyncLoadingScreen]
; 背景设置
BackgroundImages=(FilePath="Content/DefaultContent/Backgrounds/Background1.png")
BackgroundImages=(FilePath="Content/DefaultContent/Backgrounds/Background2.png")
; 提示文本设置
TipTexts=(Text="Tip 1")
TipTexts=(Text="Tip 2")
; 加载屏幕布局设置
Layout=(Name="Default", WidgetClass="AsyncLoadingScreen.DefaultLoadingScreenWidget")
配置文件介绍
- BackgroundImages: 配置背景图片的路径。
- TipTexts: 配置提示文本的内容。
- Layout: 配置加载屏幕的