在 Visual Studio 中查看 Unreal Engine 日志记录

使用 Visual Studio Tools for Unreal Engine (UE)查看 Visual Studio 中的 UE 日志记录。 这非常有用,因为可以看到 UE 日志记录,而无需在 Unreal 编辑器和 Visual Studio 之间切换。

先决条件

必须安装以下内容:

将 Unreal Engine 日志记录添加到示例,并在 Visual Studio 中查看结果

完成 快速入门:Visual Studio Tools for Unreal Engine 下载和生成 Lyra 游戏后,请按照以下步骤将 Unreal Engine 日志记录添加到 Lyra 游戏示例,并在 Visual Studio 中查看日志消息:

  1. 在 Visual Studio 中,打开 LyraGameplayAbility_RangedWeapon.cpp。 在 解决方案资源管理器的“搜索”窗格中搜索该文件,或在“游戏”>LyraStarterGame>>LyraGame>武器>LyraGameplayAbility_RangedWeapon.cpp下找到该文件。

  2. LyraGameplayAbility_RangedWeapon.cpp 中,转到第 477 行。 应会看到此函数:void ULyraGameplayAbility_RangedWeapon::OnTargetDataReadyCallback

  3. 在函数开头插入以下代码:UE_LOG(LogLyra, Log, TEXT("shot fired")); 这将创建一个与类别 LogLyra关联的日志条目,该条目在调用此函数时记录 shot fired

  4. 选择 “调试”>“开始调试”,在 Visual Studio 中运行示例游戏。 让 Unreal 编辑器片刻加载 Lyra 游戏。

  5. 在 Visual Studio 中,从 Visual Studio 主菜单中选择“视图”>“其他窗口”>“Unreal Engine 日志”,打开 UE 日志记录窗口。 或使用 UE 工具栏按钮显示日志。 有关工具栏的详细信息,请参阅 Unreal Engine 工具栏

  6. 在 Unreal 编辑器中,选择工具栏上的“播放”按钮(或 Alt+p)以启动游戏。

  7. 在 Lyra 游戏中,使用 wasd 键将玩家向左导航转到“消除”门户。 将玩家置于入口门户上以加载游戏。

  8. 游戏运行后,单击鼠标按钮以触发。 这会在 LogLyra 类别中创建一些日志条目。 现在,LogLyra 将出现在“类别”筛选器中,供下一步选择。

  9. 通过筛选 UE 日志记录窗口中除 LogLyra 类别事件之外的所有类别事件,从而减少日志干扰:选择“类别”下拉列表。 选择列表顶部的 (全选) 以清除所有日志源。 然后选择 LogLyra。 在 UE 日志记录窗口中,应会看到日志消息:shot fired

    Unreal Engine 日志窗口的屏幕截图,其中显示了“射击”事件和选择了 LogLyra 的“类别”下拉列表。

    事件位于日志底部,因此可能需要向下滚动才能查看它们。 还可以选择“清除”按钮清除日志,然后再次触发以查看日志消息。

如果发现字体颜色难以阅读,可以在 “工具>选项”>环境>字体和颜色下调整字体颜色。 更改“显示以下对象的设置:”下拉列表更改为“Unreal Engine 日志”。 在“显示项:”中,选择“日志”,并将“项前景”颜色更改为更易于查看的颜色。

调试时打开 UE 日志记录窗口很方便,因为不必切换到 Unreal 编辑器才能看到它们。

Unreal Engine 日志记录选项

从 Visual Studio 2022 17.12 开始,可以配置 Unreal Engine 日志记录窗口。 选择 工具>选项>Unreal Engine>日志工具窗口 以查看以下选项:

Unreal Engine 日志窗口选项的屏幕截图。

  • 记住筛选器:在关闭 Visual Studio 时记住在日志窗口中设置的筛选器。
  • 启动时清除:在启动游戏时清除日志窗口。
  • 请求 JSON 消息:请求 JSON 格式的日志条目。 JSON 提供易于以编程方式分析和处理的结构格式。 这样,从日志消息(例如错误详细信息、时间戳和其他元数据)中提取特定信息就更简单了。
  • 自动显示:在 Visual Studio 中启动游戏时自动显示日志窗口。

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