快速入门:Visual Studio Tools for Unreal Engine

在本文中,下载 Unreal Engine (UE) 游戏示例并配置 Visual Studio Tools for Unreal Engine。 Visual Studio Tools for Unreal Engine 是一个免费的 Visual Studio 扩展,它可帮助你使用 Unreal Engine 来开发游戏。 它提供了一组功能来改善 Visual Studio 中的 Unreal Engine 开发体验。

先决条件

必须安装以下组件:

  • Visual Studio 17.10 或更高版本。
  • Unreal Engine 5 或更高版本,因为本文中使用的示例需要 Unreal Engine 5 或更高版本。
  • Visual Studio Tools for Unreal Engine。 请参阅安装 Visual Studio Tools for Unreal Engine 的工具,了解安装说明。

在 Visual Studio 中下载和编译 Lyra 游戏示例

Lyra 是一个用于了解 Unreal Engine 的示例游戏项目。 请参阅 Lyra 示例游戏下载 Lyra 初学者游戏部分,了解下载说明。

配置 Lyra 游戏示例以使用 Visual Studio Tools for Unreal Enigine

自 Visual Studio 2022 17.7 版本起,Visual Studio Tools for Unreal Engine 插件已包含在 Unreal Engine 安装中。 不再需要查看 Unreal Engine 蓝图。 如果你有早期版本的 Visual Studio,请参阅安装 Visual Studio Tools for Unreal Engine 来手动安装插件。

下载此游戏示例后,请更新 LyraStarterGame.uproject 以使用 Visual Studio 工具插件。 一种方法是在 Unreal 编辑器中进行编辑。 加载 Lyra 项目,然后从主菜单中选择编辑>插件。 找到 Visual Studio 集成工具插件并选中其旁边的复选框。

另一种方法是手动编辑 LyraStarterGame.uproject 文件。 操作步骤如下:

  1. 在文本编辑器中打开 LyraStarterGame.uproject 文件。 它位于安装游戏示例的目录。

  2. 将以下代码添加到 Plugins 部分的末尾:

    ,{
        "Name": "VisualStudioTools",
        "Enabled": true
    }
    

在 Unreal Engine 中

  1. 在 Unreal Engine 中打开 Lyra 项目。
  2. 从 Unreal Engine 编辑器主菜单选择工具>生成 Visual Studio 项目。 随即将为 Visual Studio 创建解决方案文件。
  3. 在 Unreal Engine 编辑器主菜单中,选择工具>打开 Visual Studio 以在 Visual Studio 中打开此游戏。 如果计算机上有多个版本的 Visual Studio,请确保打开正确的版本:在 Visual Studio 主菜单中,依次选择“帮助”>“关于 Microsoft Visual Studio”。 需要使用 Visual Studio 2022 版本 17.7 或更高版本。 如果正确的版本未打开,请在正确版本的 Visual Studio 中手动打开 LyraStarterGame.sln

在 Visual Studio 中

  1. 解决方案配置下拉列表更改为开发编辑器。 这样会启用蓝图 Visual Studio Tools for Unreal Engine:Visual Studio 的屏幕截图,其中已展开“解决方案配置”下拉列表并选择“开发编辑器”。
  2. 将启动项目设置为 LyraStarterGame 项目。 在“解决方案资源管理器”中,右键单击解决方案并选择“属性”。
  3. 在“解决方案属性页面”对话框中的“通用属性”下,选择“配置启动项目”。
  4. 确保选择单个启动项目,并在下拉菜单中选择 LyraStarterGame

    “解决方案属性”页面对话框的屏幕截图。

    在“通用属性”下,选择“配置启动项目”。 单个启动项目单选按钮已选定。 下拉菜单中的启动项目是 LyraStarterGame。

  5. 选择“确定”以关闭对话框。
  6. 在 Visual Studio 主菜单中,依次选择“生成”>“生成解决方案”以生成项目。

Visual Studio 生成输出窗口

Visual Studio 中的生成输出窗口会显示生成进度以及出现的任何错误或警告。 通过查看>输出,可以从 Visual Studio 主菜单打开生成输出窗口。

从 Visual Studio 2022 17.12 开始,可以双击输出窗口中文件的绝对路径,以在 Visual Studio 中打开该文件。 源代码必须是 Visual Studio 解决方案的一部分,并且输出窗口中的路径必须是绝对路径。 这适用于在 Visual Studio 或其他类型的项目中生成 Unreal Engine 项目。

以下屏幕截图显示 LyraStarterGame 示例的生成输出窗口。 用户双击了来自 LyraCharacter.generated.h 的警告。 由于提供了该文件的绝对路径,因此文件会在编辑器中打开。

Visual Studio 输出窗口的屏幕截图。突出显示 LyraCharacter.generated.h 文件,因为指定了绝对路径,并且用户双击该路径来打开了 LyrCharacter.generated.h 文件。

Unreal Engine 工具栏

Visual Studio 提供了一个工具栏来改进 Visual Studio 中的 Unreal Engine 开发集成体验。 此工具栏提供对常见 UE 任务的快速访问。

通过视图>工具栏>Unreal Engine,从主菜单激活 Visual Studio 中的 Unreal Engine 工具栏。 此工具栏如下所示:

Visual Studio 中 Unreal Engine 工具栏的屏幕截图。

工具栏按钮,从左到右依次为:

  • 播放图标是一个快速附加按钮,它会附加到右侧下拉列表中所列的进程中。 此下拉列表列出了 Unreal Engine 相关进程,从而可更容易地附加到 Unreal Engine 编辑器。 此外,还可使用它来附加到任意进程。
  • 用于启动和停止 Unreal Engine 集成服务器的按钮。 集成服务器提高了 Unreal Engine 与 Visual Studio 的集成性能。 它会作为后台进程运行,并在处理项目时自动更新测试信息。 可将其关闭以回收计算机资源,并在需要集成改进功能时启动它。 在 Visual Studio 中打开 UE 项目时,会自动启动服务器。
  • 用于重新扫描 Unreal Engine 蓝图资产的按钮。 它会使用 Unreal Engine 项目中的最新蓝图资产来更新 Visual Studio 解决方案。
  • 用于打开 Unreal Engine 日志窗口的按钮。
  • 用于打开 Unreal Engine 集成配置 窗口的按钮,你可在此窗口中刷新并查看总体配置状态和 Visual Studio 集成工具状态、检查是否存在蓝图支持、查看是否会获取 Unreal Engine 命名约定检查器状态等。

后续步骤

在 Visual Studio 中添加 Unreal Engine 类、模块和插件
在 Visual Studio 中查看 Unreal Engine 蓝图
在 Visual Studio 中查看 Unreal Engine 日志记录
在 Visual Studio 中查看 Unreal Engine 宏