深入Unreal蓝图开发：实现蓝图模板函数

最新推荐文章于 2024-07-25 00:41:12 发布

房燕良

最新推荐文章于 2024-07-25 00:41:12 发布

阅读量7.5k

点赞数 13

分类专栏：虚幻引擎文章标签： Unreal 蓝图 Blueprint

本文链接：https://blog.csdn.net/Neil3D/article/details/89598979

版权

本文探讨如何在Unreal中通过自定义的UFUNCTION和CustomThunk函数实现蓝图节点的参数“通配符”功能，允许蓝图节点接受任意UStruct类型参数和处理任意类型数组。通过示例代码，展示了如何创建接受任意UStruct和计算数值型数组平均值的蓝图节点。

摘要由CSDN通过智能技术生成

Unreal的蓝图和C++一样，也是一种静态类型的编程语言，它又不像其他静态类型语言那样支持模板，有些时候就觉得很不方便。思考了一下这个问题。想要蓝图节点支持任意类型的参数，主要分为两种情况：

UObject派生类对象：那很简单了，使用基类指针作为参数就好，在C++里面可以Cast，或者取得对象的UClass，就可以根据反射信息做很多事了；
Struct类型，或者TArray<MyStruct>类型：这个是本文的重点。

其实说蓝图完全不支持“模板”也是不对的，引擎中其实已经有很多能够处理任意Struct或者TArray<MyStruct>类型的节点了！官方文档中把这种情况叫做参数“Wildcard”（通配符）。感谢Unreal开源，通过阅读源代码，加上一点实验，就能够搞清楚具体实现方法和背后的细节。

下面主要探讨使用UFUNCTION的CustomThunk描述符，实现自定义的Thunk函数；然后通过指定meta的CustomStructureParam和ArrayParm参数，来实现参数类型“通配符”！这中间的难点是：需要明确蓝图Stack的处理方式。Demo如下图所示：
在这里插入图片描述

在上图的Demo中：

自定义了一个蓝图Struct：MyStruct
使用C++实现了一个蓝图节点“Show Struct Fields”：可以接受任意UStruct的引用，具体类型可以由C++或者蓝图定义；
蓝图节点“Array Numeric Field Average”：可以接受任意类型的TArray<MyStruct>，并对数组中指定的数值型字段求平均；

完整的Demo工程可以从我的GitHub下载：https://github.com/neil3d/UnrealCookBook/tree/master/MyBlueprintNode

实现蓝图功能节点的几种方式

在Unreal开发中可以使用C++对蓝图进行扩展，生成Unreal蓝图节点最方便的方法就是写一个UFUNCTION，无论是定义在UBlueprintFunctionLibrary派生类里面的static函数，还是定义在UObject、AActor派生类里面的类成员函数，只要加上UFUNCTION宏修饰，并在宏里面添加BlueprintCallable标识符，就可以自动完成蓝图编辑节点、蓝图节点执行调用的整个过程。不过，由于C++和蓝图都属于“静态类型”编程语言，这种形式编写的蓝图节点，所有的输入、输出参数的类型都必须是固定的，这样引擎才能自动处理蓝图虚拟机的栈。

先来总结一下C++实现蓝图节点的几种方式：

UFUNCTION，上面已经说过了；
实现class UK2Node的派生类，这是最强大的方式，是对蓝图节点最深入的定制开发，如果你需要动态的添加、删除蓝图节点的针脚，就只能用这种方式了。例如我们常用的“Format Text”节点，可以根据输入字符串中的“{index}”来动态增加输入节点，输入节点的类型也是动态的，这个就是通过class UK2Node_FormatText这个类来实现的；
还有介于上面两者之间的一种方式，就是在UFUNCTION中使用“CustomThunk”标识，告诉UHT（Unreal Header Tool）不要生成默认的蓝图包装函数，而是由我们手工实现。这种方式，需要手工控制蓝图虚拟机的“栈”，但是不用处理蓝图编辑器UI部分，相对第2种来说代码量要少很多，相对第1种来说，又多了很多控制力；
另外，蓝图的“宏”–Macros，也可以实现自己的节点。

使用第3种方式，结合UFUNCTION的其它meta标识符，可以实现参数类型的“通配符”，就可以实现模板函数，也就是输入、输出参数可以处理多种数据类型，类似C++的泛型。这些meta标识符主要有：

ArrayParm="Parameter1, Parameter2, .."：说明 BlueprintCallable 函数应使用一个Call Array Function节点，且列出的参数应被视为通配符数组属性；
ArrayTypeDependentParams="Parameter"：使用 ArrayParm 时，此说明符将指定一个参数，其将确定 ArrayParm 列表中所有参数的类型；
CustomStructureParam="Parameter1, Parameter2, .."：列出的参数都会被视为通配符。

引擎源代码中，这种编程方式的典型的例子有：

蓝图编辑器中的“Utilities”->“Array”菜单中的所有节点，他们可以处理任意的UStruct类型的数组。这些节点对应的源代码是：class UKismetArrayLibrary
class UDataTableFunctionLibrary::GetDataTableRowFromName(UDataTable* Table, FName RowName, FTableRowBase& OutRow)

详见官方文档：UFunctions

CustomThunk函数

如果在UFUNCTION宏里面指定了CustomThunk，那么UHT就不会自动生成这个函数的“thunk”，而需要开发者自己实现。这里的“thunk”是什么呢？我们看个例子。

我们来做个最简单的小试验，在工程中建立一个Blueprint Function Library，添加一个简单的UFUNCTION：

#pragma once

#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "MyBlueprintFunctionLibrary.generated.h"

UCLASS()
class MYBLUEPRINTNODES_API UMyBlueprintFunctionLibrary : public UBlueprintFunctionLibrary
{
   
	GENERATED_BODY()
public:
	UFUNCTION(BlueprintCallable)
	static int Sum(int a, int b);
};

然后在对应的cpp文件中，使用C++实现这个函数：

#include "MyBlueprintFunctionLibrary.h"

int UMyBlueprintFunctionLibrary::Sum(int a, int b) {
   
	return a + b;
}

项目build一下，然后你就可以在“Intermediate”目录找到这个"MyBlueprintFunctionLibrary.generated.h"文件。在这个文件里面，你可以找到这样一段代码：

    DECLARE_FUNCTION(execSum) \
	{
    \
		P_GET_PROPERTY(UIntProperty,Z_Param_a); \
		P_GET_PROPERTY(UIntProperty,Z_Param_b); \
		P_FINISH; \
		P_NATIVE_BEGIN; \
		*(int32*)Z_Param__Result=UMyBlueprintFunctionLibrary::Sum(Z_Param_a,Z_Param_b); \
		P_NATIVE_END; \
	}

这段代码就是蓝图函数节点的thunk了！这段代码做了这样几件事：

声明了一个名为“execSum”的函数，函数的签名为：void func( UObject* Context, FFrame& Stack, RESULT_DECL )
使用P_GET_PROPERTY宏，从“FFrame& Stack”（也就是蓝图虚拟机的栈）中取出函数参数；
调用P_FINISH宏；
使用取出的这些参数调用我们实现的UMyBlueprintFunctionLibrary::Sum()函数；

“thunk”函数是一个包装，它完成的核心任务就是处理蓝图虚拟机的Stack，然后调用我们使用C++实现的函数。

我们还可以看一下UHT帮我们生成的另外一个文件：MyBlueprintFunctionLibrary.gen.cpp，在其中有这样一段代码：

void UMyBlueprintFunctionLibrary::StaticRegisterNativesUMyBlueprintFunctionLibrary()
	{
   
		UClass* Class = UMyBlueprintFunctionLibrary::StaticClass();
		static cons