Unreal插件开发入门

unreal公版引擎的插件开发环境的配置

unreal的理念是开发工作都是在工程目录进行，包括插件开发。所以要先创建一个带C++源码的工程

创建带C++源码的Unreal工程

用Epic Games应用启动Unreal，选择创建新项目，选择“游戏(Game)”, 点击“下一步”，再"下一步"
选择C++，不要用蓝图模式，工程名不要包含中文（路径最好也不要有空格），最后点击“创建项目”

创建好的工程目录下，必须至少包含如下几项: Content目录，Source目录，以uproject为后缀的文件

新插件的创建

Unreal菜单栏-> 编辑(Edit) -> 插件(Plugin) -> 右下角按钮：新插件(New Plugin)

插件中include UE的任意头文件

注意：unreal中所有头文件其实都是可以include的。只是ue建议只include public目录或Classes的头文件，不建议include private目录的。
public目录中头文件引用方法。

看下头文件的fullpath，找到public目录或Classes目录，public的父目录名就是module名。
将module名加入到当前插件的build.cs文件的PublicDependencyModuleNames容器中。
直接在你插件中某个源码文件，include这个头文件即可，从public开始算路径。

例如，头文件：Engine\Source\Runtime\Engine\Classes\Animation\AnimBlueprintGeneratedClass.h
首先，xxx.Build.cs文件中添加module名： Engine

// xxxx.build.cs
 PublicDependencyModuleNames.AddRange(
              new string[]
              {
                    ...,
                    "Engine",  
              }
 );

然后在某个源码文件，直接include

// xxxx.cpp
#include <Animation/AnimBlueprintGeneratedClass.h>
// 或 #include "Animation/AnimBlueprintGeneratedClass.h"

private目录中的头文件引用方法，例如：Unreal\Engine\Source\Editor\AnimationBlueprintEditor\Private\AnimationBlueprintEditor.h

首先，在当前插件模块的build.cs文件中添加Private目录:

var EngineDir = Path.GetFullPath(Target.RelativeEnginePath);

PrivateIncludePaths.AddRange(
    new string[] {
      Path.Combine(EngineDir, "Source/Editor/AnimationBlueprintEditor/Private/"),
   }
);

然后在某个源码文件，直接include:

// 用尖括号也可以
#include "AnimationBlueprintEditor.h"

unreal中链接错误的解决方法

常见的解决办法，看下此函数的实现属于哪个module，看module的方法也是根据文件所在目录，与找头文件的module的方法类似。module找到后，加入到PublicDependencyModuleNames容器中。
如果缺失的函数是你写的插件里的，找到你插件里的Module名，在函数前加入对应API宏，例如module名为SamplePlg，则API宏为：SAMPLEPLG_API
如果缺失的是你写的类，则在类的定义处加对应module的API宏。
万不得已的办法：把这个函数的实现源代码copy到你的插件里！

如何查找unreal中任意操作对应的函数

操作可以是个菜单项，也可以是工具栏按钮。
方法很简单，使用英文版unreal：菜单栏 -> 编辑 -> 编辑器偏好设置 -> 搜索: 语言 -> English
切换回英文后，在引擎中搜索你感兴趣操作相关的英文关键字即可。
搜索到关键字后，分析相关逻辑，加若干断点。
跑起来，得到堆栈后，主要在堆栈代码中注意寻找3个关键词：

Execute
Broadcast
Extend

插件中如何添加第三方依赖库

示例如下：

 private string ThirdPartyPath
 {
       get { return Path.GetFullPath(Path.Combine(ModuleDirectory, "../../ThirdParty/")); }
 }


public void AddThirdPartyDependencies(ReadOnlyTargetRules Target)
{
            //third party libraries
       // PublicSystemIncludePaths.Add(ThirdPartyPath + "include/");
       PublicIncludePaths.Add(Path.Combine(ThirdPartyPath, "include"));

       // ReplaceVirtualFunction
       PublicAdditionalLibraries.Add(Path.Combine(ThirdPartyPath, "bin/ReplaceVirtualFunction/ReplaceVirtualFunction.lib"));
}

public YourPluginConstuctor(ReadOnlyTargetRules Target) : base(Target)
{
       if (Directory.Exists(ThirdPartyPath))
       {
            AddThirdPartyDependencies(Target);
       }
}

公版引擎插件如何发布

前提条件：插件使用者的unreal版本必须和你编译插件用的unreal版本一致
uplugin文件中有个属性EnabledByDefault，插件开发期请设置为false，发布后可以改为true。
发布的内容主要就是插件目录中的所有Binaries目录。
将这些Binaries目录copy到使用者的unreal引擎的Plugins目录即可。
终极的做法：做个打包器，每次发布的时候，把这些Binaries目录打包好，放到更新服务器上。然后使用者连接服务器时，可以热更新插件。

UE插件开发，如何从覆盖90%的需求，提升到可以覆盖99%的需求的一些小技巧: https://www.jianshu.com/p/49684c1b6011

Unreal插件开发入门