Unreal插件开发的一些技巧

阅读此文章之前,建议先看下入门版://www.greatytc.com/p/ec0ae889f417
首先,UE本身提供了很多拓展接口,基本可以满足日常插件开发的需要,我举些例子:

  1. LevelEditorModule.GetToolBarExtensibilityManager()可以拓展关卡编辑器的工具栏,GetMenuExtensibilityManager()可以拓展菜单栏
  2. GEditor->GetEditorSubsystem<UAssetEditorSubsystem>()->OnAssetOpenedInEditor(),可以监听UE中,任意编辑器打开的事件。
  3. FCoreUObjectDelegates::OnObjectPropertyChanged可以监听任意Object,任意属性的变化事件。
    UE中类似上述三个示例的接口还有茫茫多,欢迎大家继续自行探索,不再赘述。

但是,上述这些正道接口,也只能覆盖90%的开发需求。那么剩下10%如何处理呢?

技巧一: 插件中include UE的Private头文件

public目录中头文件引用方法太入门,本文不再赘述。

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"

使用private头文件后,virtual或inline函数,你都可以直接调用了。

其他函数可能会报链接错误。咋办呢?
很简单,把这个函数的实现copy到你的cpp里即可。

技巧二:访问private或protected变量的官方办法。

UE官方其实提供了一种访问private变量的方法:所有标记了UPROPERTY的变量都是可以通过正道访问的。
例如, FAnimLinkableElement的SlotIndex变量:

USTRUCT()
struct FAnimLinkableElement
{
    GENERATED_USTRUCT_BODY()
    protected:

    /** The slot index we are currently using within LinkedMontage */
    UPROPERTY(EditAnywhere, Category=AnimLink)
    int32 SlotIndex;
};

访问SlotIndex的方法如下:

int32* GetSlotIndex(void *pAnimLinkableElement) {
    static UScriptStruct* Struct = FindObjectSafe<UScriptStruct>(ANY_PACKAGE, TEXT("AnimLinkableElement"));
    auto Prop = Struct->FindPropertyByName(TEXT("SlotIndex"));
    check(Prop);
    return Prop->ContainerPtrToValuePtr<int32>(pAnimLinkableElement);
}

另外,不标记UPROPERTY的私有变量,其实也可以访问的,前提是变量的offset计算正确,这个太黑,就不提了。

技巧三: 实时替换虚函数

我业余时间,写了个运行时,替换virtual函数的程序,链接在此:https://github.com/xiaoyaoliu/vimrc/tree/master/documents/cpp_samples/ReplaceVirtualFunction

例如,在动画蓝图中的Slot动画节点的右键菜单中添加新的UI入口。

    #include <ReplaceVirtualFunction/ReplaceVirtualFunction.h>
    // 开始替换
    {
    // Register command list
        auto obj = UAnimGraphNode_Slot::StaticClass()->GetDefaultObject();
        // Add context menu for UAnimGraphNode_Slot. 用插件中的GetNodeContextMenuActions_AnimNodeSlot方法,替换unreal的UAnimGraphNode_Slot::GetNodeContextMenuActions
        ReplaceVirtualWithNonVirtualMember(obj, UAnimGraphNode_Slot::GetNodeContextMenuActions, FHookAnimBlueprintEditor::GetNodeContextMenuActions_AnimNodeSlot);
    }
    
    // 取消替换
    {
        RecoverReplace(FHookAnimBlueprintEditor::GetNodeContextMenuActions_AnimNodeSlot);
    }

// 函数声明: HookAnimBlueprintEditor.h
struct FHookAnimBlueprintEditor
{
void GetNodeContextMenuActions_AnimNodeSlot(class UToolMenu* Menu, class UGraphNodeContextMenuContext* Context);
};
    
// 函数实现: HookAnimBlueprintEditor.cpp
void FHookAnimBlueprintEditor::GetNodeContextMenuActions_AnimNodeSlot(class UToolMenu* Menu, class UGraphNodeContextMenuContext* Context)
{
    UAnimGraphNode_Slot* slot = (UAnimGraphNode_Slot*)(this);
    // 调用下被替换掉的函数。从而保证只增加,不删除原有逻辑。
    SuperVirtualCall(slot->GetNodeContextMenuActions(Menu, Context));
    if (!Context->bIsDebugging)
    {
        // add an option to Play Animation Asset In Slot 
        {
            FToolMenuSection& Section = Menu->AddSection("AnimGraphNodeSlot", LOCTEXT("SlotHeading", "Slot"));
        
        }
    }

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

推荐阅读更多精彩内容

  • UE中的插件,重点在.Build.cs文件和.uplugin文件,如果在这两者中,再分主次的话,那我选.Build...
    Mr_约科阅读 5,261评论 0 2
  • 本文章转载自 智伤帝的个人博客 - 原文链接 前言   上个月的这个时候我写了一篇文章关于如何嵌入 PySide ...
    智伤帝阅读 685评论 0 0
  • 前言 在前俩篇文章中,我与大家分享了 UE4 开发如何配置 Xcode 的调试环境以及如何实现 UE4 引擎的按钮...
    iOS发呆君阅读 1,786评论 0 0
  • 16宿命:用概率思维提高你的胜算 以前的我是风险厌恶者,不喜欢去冒险,但是人生放弃了冒险,也就放弃了无数的可能。 ...
    yichen大刀阅读 6,033评论 0 4
  • 公元:2019年11月28日19时42分农历:二零一九年 十一月 初三日 戌时干支:己亥乙亥己巳甲戌当月节气:立冬...
    石放阅读 6,870评论 0 2