UE4 C++代理（委托）

Posted 2021-10-10 TanZq_

这里写目录标题

• 单播代理
• • 声明代理
  • 常用绑定函数的使用
  • • 绑定UObject类型对象的成员函数的代理
    • 绑定基于共享引用的成员函数的代理
    • 绑定原始自定义对象成员函数的代理（执行需要检查IsBound）
    • 绑定全局函数成为代理
    • 解除绑定代理关系
• 多播代理
• • 常用绑定函数的使用
• 动态代理
• • 声明动态委托
  • 动态委托绑定
  • 执行动态委托
• 动态代理用于蓝图

单播代理

声明代理

声明宏	描述
DECLARE_DELEGATE(DelegateTypeName);	声明无函数参数类型，无函数返回值的单播代理DelegateTypeName
DECLARE_DELEGATE_OneParam(DelegateTypeName, Param1Type);	声明包含一个函数参数类型，无函数返回值的单播代理DelegateTypeName
DECLARE_DELEGATE_$Num$Params(DelegateTypeName, Param1Type, Param2Type, …);	声明包含$Num$个函数参数类型，无函数返回值的单播代理DelegateTypeName $(Two<=Num<=Nine)$
DECLARE_DELEGATE_RetVal(RetValType, DelegateTypeName);	声明无函数参数类型，有函数返回值的单播代理DelegateTypeName
DECLARE_DELEGATE_RetVal_OneParam(ReturnValueType, DelegateName, Param1Type);	声明包含一个函数参数类型，有函数返回值的单播代理DelegateTypeName
DECLARE_DELEGATE_RetVal_$Num$Param(RetValType, DelegateTypeName, Param1Type, Param2Type, …);	声明包含$Num$个函数参数类型，有函数返回值的单播代理DelegateTypeName $(Two<=Num<=Nine)$

static DelegateTypeName DelegateName; // 声明代理

常用绑定函数的使用

• 绑定UObject类型对象的成员函数的代理

BindUObject(const UserClass* InUserObject, typename TMemFunPtrType<true, UserClass, RetValType (ParamTypes..., VarTypes...)>::Type InFunc, VarTypes... Vars)

使用一个有一个函数参数并且有返回值的代理作为例子：

首先先要到一个类文件中声明代理，创建代理的一些逻辑：

DECLARE_DELEGATE_RetVal_OneParam(int32, DelegateTypeName, FString);

protected:
	DelegateTypeName DelegateName;

我这里是测试，所以就将逻辑实现放在了BeginPlay函数中：

DelegateName.BindUObject(TestActor, &ATestActor::DelegateTestFunction);

if (DelegateName.IsBound())
{
    // ReSharper disable once CppExpressionWithoutSideEffects
    int32 Result = DelegateName.Execute(TEXT("123!"));

    UE_LOG(LogTemp, Warning, TEXT("返回值为： %d"), Result);
}

使用BindUObject绑定一个函数，这个函数类型的返回值以及参数类型一定要和代理的函数类型及返回值一模一样。
使用Execute执行这个函数，并用Result储存返回回来的值。
将Result进行打印测试结果是否成功。

结果：

后面几个函数现在不太懂怎么去用，就整理一下有什么作用分享给大家~
（后面懂了就来补，一定会补的，因为这是我的学习笔记，当用到这个知识点的时候我就会来看这篇文章，然后对他进行一个修改和整理。）

• 绑定基于共享引用的成员函数的代理

if(!RawObjectPtr.IsValid())
{
	RawObjectPtr = MakeShareable(new RawObject);
	DelegateName.BindSP(RawObjectPtr.ToSharedRef(), &RawObject::DelegateTest); //将智能指针转为智能引用
}

• 绑定原始自定义对象成员函数的代理（执行需要检查IsBound）

  只能绑定到C++原生指针指向的方法（原生指针需要自己管理其内存的分配和释放，而智能指针则会由系统自行管理其生命周期和垃圾回收）；一般只要在类中继承了Unreal的UObject或其子类（Actor等），这个类就会是Unreal的类，其方法就不再是C++原生类的方法，就不能使用BindRaw()；

if (!RawObjectPtr.IsValid())
{
	RawObjectPtr = MakeShareable(new RawObject);  //使用指针封装，防止不能释放
	DelegateName.BindRaw(RawObjectPtr.Get(), &RawObject::DelegateTest); //RawObject是自定义的原生类
}

• 绑定全局函数成为代理

这个相对来说比较简单，就小标题名字意思。
DelegateName.BindStatic(&MyClass::StaticMethod);

• 解除绑定代理关系

DelegateName.Unbind();

多播代理

声明宏	描述
DECLARE_MULTICAST_DELEGATE( DelegateTypeName );	声明无函数参数类型，无函数返回值的多播代理DelegateTypeName
DECLARE_MULTICAST_DELEGATE_OneParam( DelegateTypeName, Param1Type );	声明包含一个函数参数类型，无函数返回值的多播代理DelegateTypeName
DECLARE_MULTICAST_DELEGATE_$Num$Params(DelegateTypeName, Param1Type, Param2Type, …);	声明包含$Num$个函数参数类型，无函数返回值的多播代理DelegateTypeName $(Two<=Num<=Nine)$

注意：多播委托中函数签名不能使用返回值。

常用绑定函数的使用

函数	描述
Add()	将函数委托添加到多播委托的调用列表中；
AddStatic()	添加原始C++指针全局函数委托；
AddRaw()	添加原始C++指针委托；
AddSP()	添加基于共享指针的成员函数委托，共享指针委托保留对对象的弱引用；
AddUObject()	添加基于UObject的成员函数委托，UObject委托保留对对象的弱引用；
Remove()	从该多播委托的调用列表中删除函数（委托的顺序可能不会被保留）；
RemoveAll()	从该多播委托的调用列表中删除绑定到直到UserObject的所有函数（委托的顺序可能不会被保留）。

广播：
调用Broadcast，但是调用不保证执行顺序的正确性。

动态代理

声明动态委托

代码形式上是和普通代理差不多的，就是多了一个_DYNAMIC。

DECLARE_DYNAMIC_DELEGATE[_RetVal, …]( FDelegateTypeName )  // 创建一个动态委托

DECLARE_DYNAMIC_MULTICAST_DELEGATE[_RetVal, …]( FDelegateTypeName ) //创建一个动态组播委托

太多了，而且写到这上面也意义不大，讲一下他的注意点吧。

注意：

1. 代理名前需要添加一个$F$)。
2. 动态代理在类型后面必须加参数名称。 DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam(int32, FDelegateTypeName, FString, Name);
3. 动态代理绑定的函数，一定要声明UFUNCTION()，因为需要跟随代理被序列化（其他代理均不能使用）。

单播无法在蓝图中绑定，无法使用宏BlueprintAssignable（UPROPERTY中的修饰符，仅能用于Multicast代理。应显示该属性，以供在蓝图中分配）修饰。

动态委托绑定

辅助宏	说明
BindDynamic( UserObject, FuncName )	用于在动态委托上调用BindDynamic()的辅助宏。自动生成函数命名字符串。
AddDynamic( UserObject, FuncName )	用于在动态组播委托上调用AddDynamic()的辅助宏。自动生成函数命名字符串。
RemoveDynamic( UserObject, FuncName )	用于在动态组播委托上调用RemoveDynamic()的辅助宏。自动生成函数命名字符串。

和之前差不多的用法。

执行动态委托

执行函数	描述
Execute	不检查其绑定情况即执行一个委托
ExecuteIfBound	检查一个委托是否已绑定，如是，则调用Execute
IsBound	检查一个委托是否已绑定，经常出现在包含 Execute 调用的代码前

还有其他的函数就是单播和多播各自使用的那些函数了。

动态代理用于蓝图

例：

这个和之前一样现在一个类中声明动态委托：

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FDynDelMul, FString, Name);
UPROPERTY(BlueprintAssignable, BlueprintReadWrite)
FDynDelMul DynDel;

UFUNCTION(BlueprintCallable) // 触发结束开关，输出结束内容
void EndTrigger();

在BeginPlay中绑定和广播。

DynDel.AddDynamic(TestActor, &ATestActor::Function);

if (DynDel.IsBound())
{
	DynDel.Broadcast("DynDel");
}

EndTrigger内容：

if (DynDel.IsBound())
{
	DynDel.Broadcast("DynDel");
}

TestActor类的函数声明：

UFUNCTION()
	void Function(FString Name);

函数定义：

void ATestActor::Function(FString Name)
{
	UE_LOG(LogTemp, Warning, TEXT("输入字符串为： %s"), *Name);
}

创建有动态委托类的蓝图子类
在蓝图中可以使用：

现在我们可以在蓝图上面进行我们的操作：
创建一个继承ATestActor的蓝图类。

运行查看输出日志：