UE4热更新：基于UnLua的Lua编程指南

https://zhuanlan.zhihu.com/p/117236078

另外，Lua文件打包成Pak可以用我之前开源的UE资源打包工具：hxhb/HotPatcher，而且我基于UnLua自己修改了一个版本，添加了一些额外的优化，源码集成了Luasocket/Luapanda/lpeg/Sproto/Luacrypt库，可以直接使用LuaPanda调试，Github地址为：hxhb/debugable-unlua. PS：我建了一个QQ群（958363331），可以交流一下UE4热更新的相关问题，或者对HotPatcher有什么反馈可以在群里提。

本片文章搬运自我自己的博客：原文链接: UE4热更新：基于UnLua的Lua编程指南　作者: ZhaLiPeng

UE使用的是C++这种编译型语言，在编译之后就成了二进制，只有通过玩家重新安装才能打到更新游戏的目的。但是对于游戏业务而言，对于需求调整和bug修复时间要求非常迫切，频繁地让玩家更新App是不能接受的，游戏项目一般使用Lua作为游戏业务的脚本语言，是为了把运行时不可变的C++代码变成运行时可更新的Lua代码。

UE官方没有提供Lua的支持，但是腾讯开源了UnLua，在我当前的项目使用了，这两天我梳理了一下UnLua的资料（主要是官方文档、issus、宣讲PPT），加上自己测试UnLua写了一个小Demo的感悟，形成了本篇UE结合UnLua的编程指南，主要是总结使用UnLua来写业务的一些基本方法和坑，方便查看，本篇文章会持续更新。

参考资料：

这些是UnLua官方仓库里我摘录出来的一些可能有坑的地方。

在UEC++中，当我们重写了一个父类的虚函数，可以通过调用Super::来指定调用父类实现，但是在Lua中不同。

在Lua使用self.Super来调用父类的函数。

对于基类的基类的Super调用：

当在Lua中重写了一个附属类的UFUNCTION函数时，可以通过下列方法调用,有点类似于Super但要写成Overridden：

注意一定要传self进去，不然Unlua调用的时候执行的参数检查会Crash，在UnLua中调用UE函数有点类似于拿到成员函数的原生指针，必须要手动传this进去。

UnLua在编译时可以开启是否启用UE的namespace（也就是UE的函数都需要加UE4前缀）。

调用方法为：

参数与C++调用的相匹配（具有默认参数的同样可以不写）：

覆写的lua代码：

因为C++的多返回值是通过传递引用参数进去实现的，所以在Lua中这个不太一样。

如下面的C++函数：

这个函数接收WorldContextObject的参数，并接收FString/int32/UObject*这三个类型的引用类型，并返回一个bool，那么这个函数该怎么在lua中接收这些参数值的？

这种local ret1,ret2=func()的这种写法是Lua里的规则，可以看Programming in Lua，4th的第六章。

而且，使用引用作为返回参数的的使用方式需要考虑到下面两种情况：

这种情况下返回值和传入值是没有任何关系的。在lua中可以这么使用：

在这种情况下，返回值和输入是有直接关系的，所以不能像情况1中那样使用：

在这种情况下，在lua里调用传入的参数和返回的参数是都必须要传递和接收的，这样才会有正常的行为，如果不接收返回值：

level,heath,name这些传进去的对象的值并不会像C++中传递的引用那样值会改变。

这个在UnLua的issus里有提到：issus/25

当我们在C++中获得一个接口时，获得的类型是TScriptInterface类型，本来以为还要自己导出TScriptInterface才可以拿到接口，但是发现并不是这样，UnLua里可以直接拿到TScriptInterface就像普通的UObject对象：

如下面这样一个函数：

在Lua里调用：

这个得到的类型在C++里是TScriptInterface但在Lua里得到的就是该接口的UObject对象。

上面讲了怎么得到TScriptInterface的接口（在lua里得到的其实就是该接口的UObject），那么怎么通过它来调用接口的函数呢？有三种方法。

lua中获取uclass可以用于创建对象，其方法为：

Load的路径是该类的PackagePath。

如，在lua中加载UMG的类然后创建并添加至视口：

把资源加载到内存：

比如加载某个材质球给模型：

注：LuaObject在UnLua里对应的是LoadObject:

UnLua中对NewObject处理的代码为Global_NewObject：

Lua中SpawnActor以及动态绑定：

lua中调用NewObject以及动态绑定：

UnLua中的NewObject可以接收四个参数，依次是：创建的UClass、Outer、Name，以及动态绑定的Lua脚本。

导出ActorComponent中OnComponentCreated和RegisterComponent等函数：

则使用时与C++的使用方法一致：

创建UMG首先需要获取到UI的UClass，然后使用UWidgetBlueprintLibrary::Create来创建，与C++一致：

在C++代码中写了一个动态多播代理：

在lua中绑定，可以绑定到lua的函数：

同样也可以对该代理进行调用、清理、移除：

C++中有如下动态代理声明：

在lua中绑定：

动态代理支持Bind/Unbind/Execute操作：

因为BindStatic/BindRaw/BindUFunction这些都是模板函数，UnLua的静态导出方案不支持将他们导出。

官方issus：如何正确静态导出继承自FScriptDelegate的普通委托

如果想要使用类似Delay的函数：

在lua中可以通过协程(coroutine)来实现：

就是通过coroutine.create绑定上一个函数，可以直接在coroutine.create里写，或者绑定上一个已有的函数：

但是要注意一点：在绑定已有的lua函数时，传递的参数需要多一个self，标识调用指定函数的调用者。

这里的第一个self，就是在通过self调用LoadingMap_C.DoDelay，后面的两个参数才作为传递给协程函数的参数。

调用代码为：

在C++里可以使用UAsyncActionLoadPrimaryAsset::AsyncLoadPrimaryAsset来异步加载资源：

想要在Lua中使用的话需要把FPrimaryAssetId这个结构导出：

然后就可以在Lua中使用了，如异步加载关卡资源，加载完成后打开：

发布于 03-26