快速入门:Visual Studio Tools for Unreal Engine

在本文中,下载 Unreal Engine (UE) 游戏示例并配置 Visual Studio Tools for Unreal Engine。 Visual Studio Tools for Unreal Engine 是一个免费扩展,可帮助你使用 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 初学者游戏”部分,了解下载说明。 如果通过 Unreal Engine 的源代码安装获取了该版本,该版本不包含生成和运行游戏所需的资产。 使用下载说明通过 Epic 安装程序获取所需的一切。

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

自 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 Tools 插件。 执行此操作的一种方法是在 Unreal 编辑器中。 加载 Lyra 项目,然后从主菜单中选择 编辑>插件。 找到 Visual Studio Integration Tools 插件,并选中其旁边的框。

执行此操作的另一种方法是手动编辑 LyraStarterGame.uproject 文件。 操作方法如下:

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

  2. 将以下内容添加到 Plugins 节的末尾:

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

在 Unreal Engine 中

  1. 在 Unreal Engine 中打开 Lyra 项目。
  2. 在 Unreal Engine 编辑器主菜单中,选择“工具”>生成 Visual Studio Project。 这会为 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 引擎编辑器。 你还可以使用它来附加到任何进程。
  • 用于启动和停止 Unreal Engine 集成服务器的按钮。 集成服务器提高了 Unreal Engine 与 Visual Studio 的集成性能。 它作为后台进程运行,并在处理项目时自动更新测试信息。 可以将其关闭以回收计算机资源,并在需要集成改进时启动它。 在 Visual Studio 中打开 UE 项目时,会自动启动服务器。
  • 用于重新扫描 Unreal Engine Blueprint 资产的按钮。 这会使用 Unreal Engine 项目中的最新蓝图资产更新 Visual Studio 解决方案。
  • 打开 Unreal Engine 日志窗口的按钮。
  • 用于打开 Unreal Engine 集成配置 窗口的按钮,可在其中刷新和查看总体配置状态和 Visual Studio 集成工具状态、检查蓝图支持、查看是否获取 Unreal Engine 命名约定检查器状态等。

命令行参数下拉列表

在内部循环的编辑和调试过程中,可能会经常使用命令行参数的不同组合来启动游戏。 现在,使用命令行参数下拉列表可以更轻松地执行此操作:

命令行参数下拉列表的屏幕截图。

命令行参数下拉列表显示在“标准”工具栏上的“解决方案平台”下拉列表后面。 C:\UE\LyraStarterGame\LyraStarterGame.uproject -fullscreen 和 C:\UE\LyraStarterGame\LyraStarterGame.uproject -JsonDebugOutput 各有一个条目。

若要添加命令行参数,请在下拉列表中键入它们,然后按 Enter。 参数将按输入它们的顺序保存,并显示在下拉列表中以供将来使用。

在删除最早的命令行以腾出新命令行之前,可以添加五个命令行。

调试在 Unreal Engine 编辑器中运行的 Unreal Engine 项目时的第一个参数必须是项目的路径。 例如:C:\UE\LyraStarterGame\LyraStarterGame.uproject

有关使用命令行参数下拉列表的详细信息,请参阅 调试时传递命令行参数(C++)

后续步骤

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