共用方式為


快速入門:Visual Studio Tools for Unreal Engine

在本文中,下載 Unreal Engine (UE) 遊戲範例,並使用 Visual Studio Tools for Unreal Engine 執行以下操作:

必要條件

必須安裝下列項目:

  • Visual Studio 17.7 或以上版本
  • Unreal Engine 第 5 版或更新版本,因為本快速入門中使用的範例需要 UE5 或更新版本。
  • Visual Studio Tools for Unreal Engine。 如需安裝指示,請參閱安裝 Visual Studio Tools for Unreal Engine

在 Visual Studio 中下載並建置 Lyra 遊戲範例

Lyra 是一個範例 3D 遊戲專案,可用來了解 Unreal Engine 中的架構。 如需下載指示,請參閱 Lyra 範例遊戲下載 Lyra 入門遊戲一節。

設定 Lyra 遊戲範例以使用 Visual Studio Tools for Unreal Engine

下載遊戲範例之後,請更新 LyraStarterGame.uproject,以使用 Visual Studio Tools 外掛程式。 您也可以在 [編輯]>[外掛程式] 下主功能表的 Unreal 編輯器中,執行此動作,然後尋找 Visual Studio 整合外掛程式,並勾選旁邊的方塊。 但我們會遵循下列步驟以執行此操作:

  1. 在文字編輯器中開啟 LyraStarterGame.uproject 檔案。 其位於您安裝遊戲範例的目錄中。

  2. Plugins 區段的結尾新增下列程式碼:

     ,{
     	"Name": "VisualStudioTools",
     	"Enabled": true
     }
    
  3. 在 Unreal Engine 中開啟 Lyra 專案。

  4. 從 Unreal Engine 編輯器主功能表中,選擇 [工具]>[重新整理 Visual Studio 專案]。 這會建立/重新整理 Visual Studio 的解決方案檔案。

  5. 從 Unreal Engine 編輯器主功能表中,選擇 [工具]>[重新整理 Visual Studio 專案]。 這會在 Visual Studio 中開啟遊戲。 如果您的電腦上有多個版本的 Visual Studio,請確定開啟正確的版本:從 Visual Studio 主功能表中,選擇 [說明]>[關於 Microsoft Visual Studio]。 Visual Studio 2022 17.7 版或更高版本。 如果正確的版本未開啟,請以正確的 Visual Studio 版本手動開啟 LyraStarterGame.sln

  6. 從 Visual Studio 主功能表中,選擇 [建置]>[建置方案] 來建置遊戲。

  7. 將 [解決方案設定] 下拉式清單變更為 [開發編輯器]。 這可啟用 Blueprints Visual Studio Tools for Unreal Engine:Screenshot of Visual Studio with the Solutions Configurations dropdown expanded and Development Editor selected.

在 Visual Studio 中檢視 UE 藍圖

您可以從 Visual Studio 中檢視 UE 藍圖,但無法編輯。 這非常有用,因為您不需要在 Unreal 編輯器和 Visual Studio 之間切換,即可看到 UE 藍圖。 若要啟用它,請依照以下步驟進行:

  1. 在 Visual Studio 中,開啟 LyraCharacter.h。 在 [方案總管] 的 [搜尋] 窗格中,或在 [遊戲]> [LyraStarterGame]> [來源]> [LyraGame]> [Character]> [LyraCharacter.h] 下,搜尋該檔案
  2. LyraCharacter.h 中,移至第 96 行。 您應該會看到下列類別:class LYRAGAME_API ALyraCharacter : public AModularCharacter ...
  3. 有四個藍圖類別可擴充此類別。 您應該會看到 ALyraCharacter 類別定義上方的連結,指出:4 derived Blueprint classes。 按一下該連結可檢視擴充此類別的四個藍圖類別:Screenshot of the blueprints link above the Alyra Character class. It lists related blueprints.
  4. 若要檢視 Character_Default_C 藍圖的屬性,請按兩下該藍圖,以開啟藍圖資產檢視器。 您可以檢視藍圖的各種屬性,但無法進行變更:Screenshot of the Character_Default_C Blueprint asset viewer. It shows properties such as Actor, Camera, Character, Collision, and so on.

在 Visual Studio 中檢視 UE 記錄

您可以使用 Visual Studio Tools for Unreal Engine 來檢視 Visual Studio 內的 UE 記錄。 這非常有用,因為您不需要在 Unreal 編輯器和 Visual Studio 之間切換,即可看到 UE 記錄。 若要啟用它,請依照以下步驟進行:

  1. 在 Visual Studio 中,開啟 LyraGameplayAbility_RangedWeapon.cpp。 在 [方案總管] 的 [搜尋] 窗格中,或在 [遊戲]>[LyraStarterGame]>[來源]>[LyraGame]>[Weapons]>[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 記錄] 視窗。

  6. 在 Unreal 編輯器中,選擇工具列上的 [播放] 按鈕 (或 Alt+p),以啟動遊戲。

  7. 在 Lyra 遊戲中,使用 wasd 鍵,將玩家導覽至 [淘汰] 入口網站。 將玩家置於進入的入口網站以載入遊戲。

  8. 遊戲執行之後,按一下滑鼠按鍵以觸發。 這會在 LogLyra 類別中建立一些記錄項目。 現在 LogLyra 會出現在下一個步驟的 [類別] 篩選中。

  9. 篩選 UE 記錄視窗中 LogLyra 類別事件以外的所有類別事件,以減少記錄雜訊,如下所示:選擇 [類別] 下拉式清單。 選擇清單頂端的 [(全選)],以清除所有記錄來源。 然後選取 [LogLyra]。 在 [UE 記錄] 視窗中,您應該會看到記錄訊息:shot fired

    A screenshot of the Unreal Engine Log window showing 'shot fired' events and the Categories dropdown with LogLyra selected.

    事件會位於記錄底部,因此您可能必須向下捲動才能看到它們。 您也可以選擇 [清除] 按鈕來清除記錄,然後再次觸發以查看記錄訊息。

如果您發現字型色彩難以閱讀,您可以在 [工具]>[選項]>[環境]>[字型和色彩] 下調整。 變更下列的下拉式清單 [顯示] 設定: 變更為 Unreal Engine Log。 在 [顯示項目] 中,選取 [記錄],並將 [項目前景色彩] 變更為更容易看到的色彩。

當您偵錯時開啟 UE 記錄視窗很方便,因為您不需要切換至 Unreal 編輯器,即可看到它們。

在 Visual Studio 中檢視 UE 巨集

長 UE 巨集可能難以讀取。 Visual Studio Tools for Unreal Engine 會展開 UE 巨集,以便您更輕鬆地閱讀它們。 如有需要,可以複製展開的巨集。 您也可以線上搜尋巨集,或將其與另一個巨集進行比較。 若要試驗這些功能,請遵循下列步驟:

  1. 在 Visual Studio 中,開啟 LyraGameplayAbility_RangedWeapon.cpp。 在 [方案總管] 的 [搜尋] 窗格中,或在 [遊戲]>[LyraStarterGame]>[來源]>[LyraGame]>[Weapons]>[LyraGameplayAbility_RangedWeapon.cpp] 下,搜尋該檔案

  2. LyraGameplayAbility_RangedWeapon.cpp 中,移至第 41 行。 您應該會看到下列巨集:UE_DEFINE_GAMEPLAY_TAG_STATIC(TAG_WeaponFireBlocked, "Ability.Weapon.NoFiring");

  3. 將滑鼠指標暫留在 UE_DEFINE_GAMEPLAY_TAG_STATIC 上方,以查看巨集定義視窗:A screenshot in Visual Studio of the UE macro tooltip. There are options at the bottom to copy, expand inline, visualize expansion, and search online. 底部的選項會將巨集複製到剪貼簿、展開巨集內嵌、將巨集的展開視覺化,然後線上搜尋巨集。

  4. 選擇 [展開內嵌],以在程式碼視窗中展開巨集和所有巢狀巨集。 A screenshot of the expanded contents of the UE_DEFINE_GAMEPLAY_TAG_STATIC macro. 您可以按 Ctrl+z 來復原展開。

  5. 選擇 [線上搜尋] 以開啟您的瀏覽器。 它會開啟並填入搜尋以搜尋巨集。 在上一個範例中,這會開啟瀏覽器來搜尋 C++ #define UE_DEFINE_GAMEPLAY_TAG_STATIC(TagName, Tag) static FNativeGameplayTag TagName(UE_PLUGIN_NAME, UE_MODULE_NAME, …

  6. 選擇 [視覺化展開],以開啟 [巨集展開] 視窗。 您可以展開巢狀巨集,這是較大巨集的一部分,一次一個步驟。 捲動至展開的結尾,以查看視窗右上角的巨集展開箭號。 選擇向右箭號展開下一個巢狀巨集。 選擇向左箭號,以摺疊展開的最後一個巢狀巨集:

    A screenshot of the macro expansion window showing the expanded contents of the UE_DEFINE_GAMEPLAY_TAG_STATIC macro.

有關在 Visual Studio 中擴充巨集的詳細資訊,請參閱視覺化 C/C++ 巨集擴充

本快速入門示範 Visual Studio Tools for Unreal Engine 如何更輕鬆地了解 UE 巨集、檢視 UE 記錄,以及檢視 UE 藍圖。 願您的 UE 開發工作更具生產力且愉快!

下一步

如需 Visual Studio Tools for Unreal Engine 功能的概觀,請參閱 Visual Studio Tools for Unreal Engine