Unreal Engine 4哲學與實務

前面幾個章節談了許多引擎在設計上的「為什麼」，但實際上我們到底該怎麼為專案加入C++類別？ 基本上你可以純手動在${PROJECT_NAME}\Source\${PROJECT_NAME}下面新增.h跟.cpp檔，只不過會比較費力；但若所繼承的類別是屬於引擎預設支援的類別，你也可以選擇使用Editor中的工具。由於用Editor建立出來的程式碼會自動的套用所選擇繼承類別的模版，因此可以省下不少功夫。 UObject是整個UE4引擎中的核心類別，大部份引擎中的功能都是繼承這個類別後再開始發展各別的系統。 首先，讓我們先來看看該怎麼繼承這個類別。 點選左上角的File->New C++ Class後就會跳出視窗選擇欲繼承的類別，然後照著Figure 1.10.1、Figure 1.10.2、Figure 1.10.3的指示將類別建立出來。 Figure 1.10.1 在Editor中選擇File->New C++ Class後彈出的畫面，這裡只會出現常用類別，請接著選取右上方的Show All Classes。 Figure 1.10.2 選取右上角的Show All Classes之後，就會顯示所有引擎支援的模版類別，接著選取Object，按下Next。 Figure 1.10.3 選取成Public後，.h檔跟.cpp檔就會自動被放到Public跟Private中對應的資料夾。這裡我們在Public下建了一個叫Basic的資料夾，因此建出的MyBasicObject.h會被放到Public\Basic，而MyBasicObject.cpp則會被放到Private\Basic下面。 按下Create Class按鈕後，引擎就會根據內部設定好的Template幫我們將新的類別置放到所選擇的資料夾下面。對於引擎類別的Template有興趣的讀者可以查看${EngineVersion}\Engine\Content\Editor\Templates\這個資料夾下面的檔案，基本上就是根據這些檔案做字串置換的動作而已。 接著我們就可以在Source資料夾下找到建立出來的檔案，見Code 1.10.1。 UObject類別宣告 1. #pragma once 2. #include “UObject/NoExportTypes.h” 3. #include “MyBasicObject.generated.h” 4. … Continued

打開Visual Studio後，我們在專案的組態中可以發現有好幾種編譯組態可以選擇，見Figure 1.12.1、Figure 1.12.1。 Figure 1.12.1 從Epic Games Launcher下載的版本，預設有5種編譯組態可以選擇。 Figure 1.12.2 從Github上下載引擎版本自己編譯的話，則會發現多了非常多的編譯選項。 每一個編譯選項主要是由二個關鍵字所組成，第一部份是用來描述引擎跟我們遊戲專案要用什麼狀態來編譯，例如DebugGame、Development跟Shipping。第二部份則是要編譯目標，主要是對應到Source資料夾下的Target.cs。讓我們先看看以下幾個例子： DebugGame：會使用${ProjectName}.Target.cs(TargetType.Game)中的相關設定資訊進行編譯，產生標準的standalone執行檔，在unreal的架構中預設是listen server，意即這個執行程序既是server也是client，別人若知道該listen server的ip，就可以使用open指令加入遊戲，例如：open 192.168.xx.xx:7777。 DebugGame Editor：會使用${ProjectName}Editor.Target.cs(TargetType.Editor)中的相關設定資訊進行編譯，產生帶有Unreal Editor的執行檔。 選擇DebugGame Server：這個組態預設並不存在，當我們在Source下建立完${ProjectName}Server.Target.cs後就會出現，選擇後會使用${ProjectName}Server.Target.cs(TargetType.Server)中的相關設定資訊進行編譯，產生Dedicated Server執行檔。 DebugGame Client：這個組態預設並不存在，當我們在Source下建立完${ProjectName}Client.Target.cs(TargetType.Client)後就會出現，選擇後會使用${ProjectName}Client.Target.cs中的相關設定資訊進行編譯，移除所有server端的能力，產生純粹的客戶端執行檔。 藉由編譯方式跟編譯目標的組合，我們可以得到各種不同的建置組合以符合不同的使用情境。其中若是我們使用的是Github上引擎版本的話，還會多種Debug跟Test這二種建置方式，到底它們的用途是什麼？表格 1表格 2跟整理了所有的建置狀態跟建置目標： 表格 1 建置狀態，主要是用來決定產生的執行檔是不是要進行最佳化。 建置組態 – 狀態  描述 Debug 這個建置組態，會將整個「引擎」跟「Game Code」用最方便除錯的方式進行編譯，其中會包含所有的Debug Symbol，程式碼不會進行任何的最佳化，因此非常適合進行完整的斷點除錯。只是，由於我們必須將整個UE4的原始碼從Github上拉下來自己編譯，因此非常的耗時。從Epic Games … Continued

在建完專案之後，在專案底下看到下面幾個Folder跟檔案，見Figure 1.4.1： · .vs：為visual studio產生的meta data。 Binaries：用來存放UE4專案建置出來的東西(build artifact)，如dll、exe跟debug用的pdb……等等。 Config：用來存放專案的各種設置資訊，一開始在裡面可以看到四個檔案： DefaultEditor.ini、DefaultEngine.ini、 DefaultGame.ini、DefaultInput.ini。從這裡我們可以看到UE4會根據配置的功能存放在不同的.ini標案中。基本上裡面大部份的配置我們都能夠在Unreal Editor進行變更，因此不太需要對這裡面的內容進行手動的編輯。 Content：存放著專案所使用的uasset跟umap，這二種副檔名為現階段引擎(4.15)內部處理素材所使用的格式。基本上引擎內部會有機制將你所匯入的檔案(如png、jpg)先轉換成uasset，然後在之後建置專案的時候再根據平台轉換成該平台的格式。例如：android的ETC1、ETC2、iOS的PVR。 Intermediate：存放著引擎編譯過程所產生的各種中間產物。 Saved：放log跟專案預設的寫出檔案路徑。 Source：跟我們專案相關的cpp code。 ${PROJECT_NAME}.sln：Visual Studio的專案檔。 ${PROJECT_NAME}.uproject：UE4專案的描述檔，裡面記錄著這個專案所使用的引擎版本，裡面分成了多少模組(Module)以及用了哪些Plugin。 ${PROJECT_NAME}.VC.db：為Visual Studio的IntelliSense database Figure 1.4.1 以下三項為構成UE4專案的基本核心：一、${PROJECT_NAME}.uproject：描述著我們的UE4專案相關資訊。二、Source資料夾：存放著我們的程式碼。三、Content資料夾：存放著專案所使用的asset。 在進到Source之後，首先會看到二個.Target.cs檔，見Figure 1.4.2，其主要的用途是用來描述我們所產出的執行檔是Editor、Game還是Dedicated Server與整個執行檔的編譯設定，大多時候我們都不需要對這個檔案進行編輯。 Figure 1.4.2 Source資料夾下面包含Target.cs描述檔，用來描述最後要產生的執行檔需要包含哪些Module以及相關環境資訊。 由於UE4是以「Module」的概念對程式碼的功能進行組織，在編譯過程中會去找到${PROJECT_NAME}.uproject底下所有的*.Build.cs當成該Module的根目錄，而每個找到的Module到最後都必須要產生或跟一個外部的library連接。(.dll或.lib) 在我們的初始專案資料夾下面，見Figure 1.4.3，我們可以看這個定義Module的檔案： ${PROJECT_NAME}.Build.cs：這個檔案主要用來描述這個Module跟其他Module的相依關係、其相依專案include檔所存放的相對路徑與其他各種編譯設定。預設做完建立初始專案的動作後在Binaries\Win64下面可以找到對應的UE4Editor-${PROJECT_NAME}.dll，見Figure 1.4.4。 Figure 1.4.3 Build.cs主要用來描述Module之間的相依性關係與相關的編譯設定，副檔名為.cs表示其所使用的語言是C#。 … Continued

本章節並不打算進行git的使用教學，對於不懂這套軟體運作機制的讀者可以很簡單的在其他地方找到更完整的教材。相對的，這個章節會專注於描述在使用git進行UE4專案開發時有哪些東西需要特別注意。 若是電腦沒有git，在Windows環境下請先下載並安裝下面二個網址中的檔案： Git for windows網址：https://git-scm.com/download/win TortoiseGit網址：https://tortoisegit.org/ Git for windows為git的主程式，必須要先安裝，而TortoiseGit則是給git主程式使用的GUI介面，若已有偏好的軟體則可略過這步。 安裝完成後，在程式集中尋找並打開Git Bash這隻程式，輸入Figure 1.6.1中的指令檢查是否有正確安裝： Figure 1.6.1 檢查git跟git lfs是否有正確安裝。 之後在Unreal Editor的Toolbar中選擇Connect to Source Control之後(見Figure 1.6.2)，就會開啟設定視窗，如Figure 1.6.3。 Figure 1.6.2 啟用Source Control   Figure 1.6.3 Source Control設定視窗，先確認Add a .gitignore file這個選項有選取後，按下Initialize Project with Git之後，再按Accept Settings就可完成基本設定 在完成設定之後，我們會在專案目錄底下看到一個.git的資料夾以及.gitignore檔就代表我們已經設定成功。在.gitignore裡面描述的，是UE4官方所提供不該commit進到版本控制裡面的檔案跟資料夾。由於在.gitignore裡面列出來的都是可以由引擎方產生出來的，因此我們可以利用這個官方提供的初始化機制，讓我們可以省去設定.gitignore的步驟。 … Continued

在建立完專案並打開Primary Game Module中的Build.cs後，可以看到裡面預設了幾個相依的Module。 HorizonTutorialGame.Build.cs using UnrealBuildTool; public class HorizonTutorialGame : ModuleRules { public HorizonTutorialGame(ReadOnlyTargetRules Target) : base(Target) { PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs; PublicDependencyModuleNames.AddRange(new string[] { “Core”, “CoreUObject”, “Engine”, “InputCore” }); PrivateDependencyModuleNames.AddRange(new string[] { }); } } Code 2.7.1 “Core”、”CoreUObject”、”Engine”、”InputCore”為引擎核心的幾個Module 其中： l … Continued

在UE4中，所有的Plugin主要存在於二個地方： l Engine Plugin：${UE4_ENGINE_ROOT}/Engine/Plugin/，我們在Marketplace上購買的Plugin會下載到其中的Marketplace資料夾。 l Game Plugin：${PROJECT_NAME}/Plugin/，通常我們自己製作的Plugin都是放在這個地方。 製作Plugin的方法非常簡單，我們只需要使用引擎Editor中所提供的工具，就可以快速的製作出各種不同用途的Plugin給專案使用。這個工具提供了各種不同的Plugin範本，在建立的同時會同時為我們的Plugin建立一個預設的Module。 首先，讓我們試著建立一個空白的Plugin吧。 在Editor中選擇Edit->Plugins後，就會跳出Figure 2.6.1畫面。 Figure 2.6.1 按下NewPlugin後，就會出現Plugin範本讓我們選擇。 Figure 2.6.2 選擇Blank，填入必須資訊按下Create Plugin之後，就會在${PROJECT_NAME}/Plugins下面建立出一個新的Plugin。 在建立完Plugin之後，我們會得到Figure 2.6.3中的目錄結構跟檔案。 Figure 2.6.3 使用Blank Plugin範本所建立出來的Plugin。 其中： l Resources/Icon128.png：為一個128×128大小的png，主要是用來顯示在Editor中。 l ${PLUGIN_NAME}.uplugin：存儲有關於這個Plugin的相關資訊，例如版本號碼、Plugin需載入的Module、作者名稱……等等。 l ${PLUGIN_NAME}.Build.cs：用來描述這個Module跟其他Module的相依關係、其相依專案include檔所存放的相對路徑與其他各種編譯設定。 l ${PLUGIN_NAME}.h跟${PLUGIN_NAME}.cpp：Module Interface的相關定義與實作。 在打開.uplugin後，會看到一個用json格式來描述Module的資訊，見Code 2.6.1。 HorizonGameLibrary.uplugin { “FileVersion”: 3, … Continued

上一節展示了Module相關的基本概念，本節就讓我們試著為專案加入一個Game Module吧。首先，我們可以把專案下面預設的Primary Game Module複制一份出來，並重新命名成希望的Module名稱，見Figure 2.5.1。   Figure 2.5.1 為HorizonTutorialGame專案增加一個HorizonTutorialGameEditor作為額外的Game Module以擴充遊戲內Editor相關功能。這個Editor Game Module我們可以在之後用來客製化UPROPERTY在editor中detail pnael的顯示方式，或者是追加新的編輯模式……等等。     然後必須更改新Module下面build.cs中的類別名稱，見Code 2.5.1。 HorizonTutorialGameEditor.Build.cs using UnrealBuildTool; public class HorizonTutorialGameEditor : ModuleRules { public HorizonTutorialGameEditor(ReadOnlyTargetRules Target) : base(Target) { PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs; PublicDependencyModuleNames.AddRange(new string[] { “Core”, “CoreUObject”, … Continued