一、 TargetRule , ModuleRule

UE4是以Module(模块)来组织代码,但是目前创建custom module不是一件很方便的事情。具体方法可参考:
http://orfeasel.com/creating-custom-modules/
Plugin与module都能起到组织代码的作用。创建plugin(插件)就方便许多了,Editor里有plugins管理器。

Plugins


1. ActionRPG.Target.cs & ActionPRGEditot.Target.cs

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

using UnrealBuildTool;
using System.Collections.Generic;

public class ActionRPGTarget : TargetRules
{
    public ActionRPGTarget(TargetInfo Target)
        : base(Target)
    {
        Type = TargetType.Game;
        ExtraModuleNames.AddRange(new string[] { "ActionRPG" });
    }
}
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

using UnrealBuildTool;
using System.Collections.Generic;

public class ActionRPGEditorTarget : TargetRules
{
    public ActionRPGEditorTarget(TargetInfo Target)
        : base(Target)
    {
        Type = TargetType.Editor;
        ExtraModuleNames.AddRange(new string[] { "ActionRPG" });
    }
}

每个ue项目都会自动生成该文件,主要是定义了Type和ExtraModule。ActionRPG项目没有对这里做出修改。
更多的信息可以查看文件:
/UE_4.22/Engine/Source/Programs/UnrealBuildTool/Configuration/TargetRule.cs


2. ActionRPG.Build.cs & ActionRPGLoadingScreen.Build.cs

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

using UnrealBuildTool;

public class ActionRPG : ModuleRules
{
    public ActionRPG(ReadOnlyTargetRules Target)
        : base(Target)
    {
        PrivatePCHHeaderFile = "Public/ActionRPG.h";

        PublicDependencyModuleNames.AddRange(
            new string[] {
                "Core",
                "CoreUObject",
                "Engine"
            }
        );

        PrivateDependencyModuleNames.AddRange(
            new string[] {
                "ActionRPGLoadingScreen",
                "Slate",
                "SlateCore",
                "InputCore",
                "MoviePlayer",
                "GameplayAbilities",
                "GameplayTags",
                "GameplayTasks"
            }
        );

        if (Target.Platform == UnrealTargetPlatform.IOS)
        {
            PrivateDependencyModuleNames.AddRange(new string[] { "OnlineSubsystem", "OnlineSubsystemUtils" });
            DynamicallyLoadedModuleNames.Add("OnlineSubsystemFacebook");
            DynamicallyLoadedModuleNames.Add("OnlineSubsystemIOS");
            DynamicallyLoadedModuleNames.Add("IOSAdvertising");
        }
        else if (Target.Platform == UnrealTargetPlatform.Android)
        {
            PrivateDependencyModuleNames.AddRange(new string[] { "OnlineSubsystem", "OnlineSubsystemUtils" });
            DynamicallyLoadedModuleNames.Add("AndroidAdvertising");
            DynamicallyLoadedModuleNames.Add("OnlineSubsystemGooglePlay");
            // Add UPL to add configrules.txt to our APK
            string PluginPath = Utils.MakePathRelativeTo(ModuleDirectory, Target.RelativeEnginePath);
            AdditionalPropertiesForReceipt.Add("AndroidPlugin", System.IO.Path.Combine(PluginPath, "AddRoundIcon_UPL.xml"));

        }
    }
}
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

using UnrealBuildTool;

// This module must be loaded "PreLoadingScreen" in the .uproject file, otherwise it will not hook in time!

public class ActionRPGLoadingScreen : ModuleRules
{
    public ActionRPGLoadingScreen(ReadOnlyTargetRules Target)
        : base(Target)
    {
        PrivatePCHHeaderFile = "Public/ActionRPGLoadingScreen.h";

        PCHUsage = PCHUsageMode.UseSharedPCHs;

        PrivateIncludePaths.Add("ActionRPGLoadingScreen/Private");

        PublicDependencyModuleNames.AddRange(
            new string[] {
                "Core",
                "CoreUObject",
                "Engine"
            }
        );

        PrivateDependencyModuleNames.AddRange(
            new string[] {
                "MoviePlayer",
                "Slate",
                "SlateCore",
                "InputCore"
            }
        );
    }
}

ActionRPG中除了默认生成的ActionRPG module之外,还创建了ActionRPGLoadingScreen module。.Build.cs文件就是对模块间的依赖关系、文件路径、PCH的使用、平台差异等进行配置。

PCH

Pre-compile header(PCH)指预编译头文件,该头文件只编译一次,通常包含对工程中大量使用、且不会被修改的头文件的引用。如这里的ActionRPG.h

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

#pragma once

// ----------------------------------------------------------------------------------------------------------------
// This header is included by all headers in the project so it's a good place to declare common includes
// We include EngineMinimal and the subset of engine headers used by most of our classes
// We don't want to include "Engine.h" as that pulls in too many classes we don't need and slows compile time
// ----------------------------------------------------------------------------------------------------------------

#include "EngineMinimal.h"
#include "Engine/Engine.h"
#include "Net/UnrealNetwork.h"
#include "RPGTypes.h"

//这是添加了自定义的log标签
ACTIONRPG_API DECLARE_LOG_CATEGORY_EXTERN(LogActionRPG, Log, All);

DependencyModuleName

在这里添加该module对其他module的依赖,public和private区别在于,当别人引用我们写的模块时,他的模块会继承我们的public依赖,不会继承private依赖。

关于.Build.cs中更多信息,可以查阅:
/UE_4.22/Engine/Source/Programs/UnrealBuildTool/Configuration/ModuleRules.cs


3. ActionRPG.urpoject

{
    "FileVersion": 3,
    "EngineAssociation": "4.22",
    "Category": "Samples",
    "Description": "",
    "Modules": [
        {
            "Name": "ActionRPG",
            "Type": "Runtime",
            "LoadingPhase": "Default"
        },
        {
            "Name": "ActionRPGLoadingScreen",
            "Type": "ClientOnly",
            "LoadingPhase": "PreLoadingScreen"
        }
    ],
    "Plugins": [
        {
            "Name": "AppleARKit",
            "Enabled": false
        },
        {
            "Name": "ArchVisCharacter",
            "Enabled": false
        },
        {
            "Name": "AudioCapture",
            "Enabled": false
        },
        {
            "Name": "CryptoKeys",
            "Enabled": false
        },
        {
            "Name": "CustomMeshComponent",
            "Enabled": false
        },
        {
            "Name": "DatasmithContent",
            "Enabled": false
        },
        {
            "Name": "HTML5Networking",
            "Enabled": false
        },
        {
            "Name": "FacialAnimation",
            "Enabled": false
        },
        {
            "Name": "GameplayAbilities",
            "Enabled": true
        },
        {
            "Name": "ImmediatePhysics",
            "Enabled": false
        },
        {
            "Name": "LinearTimecode",
            "Enabled": false
        },
        {
            "Name": "OculusVR",
            "Enabled": false
        },
        {
            "Name": "PhysXVehicles",
            "Enabled": false
        },
        {
            "Name": "ResonanceAudio",
            "Enabled": false
        },
        {
            "Name": "SteamVR",
            "Enabled": false
        },
        {
            "Name": "ProceduralMeshComponent",
            "Enabled": false
        },
        {
            "Name": "RuntimePhysXCooking",
            "Enabled": false
        },
        {
            "Name": "UObjectPlugin",
            "Enabled": false
        },
        {
            "Name": "WindowsMoviePlayer",
            "Enabled": false
        },
        {
            "Name": "WmfMedia",
            "Enabled": false
        },
        {
            "Name": "CableComponent",
            "Enabled": false
        },
        {
            "Name": "CharacterAI",
            "Enabled": false
        },
        {
            "Name": "LightPropagationVolume",
            "Enabled": false
        },
        {
            "Name": "MediaCompositing",
            "Enabled": false
        },
        {
            "Name": "LocationServicesBPLibrary",
            "Enabled": false
        },
        {
            "Name": "SlateRemote",
            "Enabled": true
        },
        {
            "Name": "MagicLeapEmulator",
            "Enabled": false,
            "SupportedTargetPlatforms": [
                "Lumin"
            ]
        },
        {
            "Name": "MagicLeapMedia",
            "Enabled": false,
            "SupportedTargetPlatforms": [
                "Lumin"
            ]
        },
        {
            "Name": "MagicLeap",
            "Enabled": false,
            "SupportedTargetPlatforms": [
                "Lumin"
            ]
        }
    ],
    "TargetPlatforms": [
        "Android",
        "IOS",
        "WindowsNoEditor",
        "MacNoEditor"
    ],
    "EpicSampleNameHash": "2961006109"
}

这里有关于ue版本的配置,还可以配置module的type和加载阶段,当你使用Editor中plugins管理器管理插件,实际上也会修改这里。通常来说,这个文件不需要你过多的关注,你知道有即可。


上面提及的文件其实都是与UnrealBuildTool相关的,在VS中发现编译错误跟UBT有关,那么就有可能需要对这些文件做修改。由于对UBT的了解不深,所以暂时就到此为止了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,585评论 4 365
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,923评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,314评论 0 248
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,346评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,718评论 3 291
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,828评论 1 223
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,020评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,758评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,486评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,722评论 2 251
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,196评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,546评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,211评论 3 240
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,132评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,916评论 0 200
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,904评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,758评论 2 274

推荐阅读更多精彩内容