RegisterHook
local id = RegisterHook(functionPath, pre, post)
在游戏函数上挂前置和后置回调。概念见钩子。
参数
| # | 类型 | 说明 |
|---|---|---|
| 1 | string | 函数路径:包路径.类名:函数名,如 "/Script/Engine.PlayerController:ClientRestart"。蓝图类的函数用类名加 _C,如 "WBP_Foo_C:OnClicked" |
| 2 | function | 函数执行前调用 |
| 3 | function | (可选)函数执行后调用 |
函数路径解析时只比较路径最后一段起的名字(类名和函数名)。
蓝图函数的所有调用(包括蓝图直接调蓝图)都会触发,见钩子。蓝图函数的参数可以在前置回调里修改,字符串参数会用引擎分配的副本替换。
回调参数
pre(self, params) / post(self, params):
回调返回一个值,就会替换函数的返回值(和 UE4SS 一样):前置回调里返回的值会被函数自己的返回值覆盖(对原生函数没有效果),所以要改结果请在后置回调里返回。返回 nil(什么都不返回)保持原值。蓝图函数的字节码已经执行完,后置回调里返回的值替换的是调用方收到的结果。不能通过返回值取消调用。
返回值
返回钩子 id(同一个 id 返回两次,兼容 UE4SS 的“两个 id“写法)。
错误
- 路径找不到对应的
UFunction时抛错:RegisterHook: function not found: ...。函数所在的类必须已经加载。 - 回调里的错误写进日志并计入模组的错误数,不影响游戏。
示例
RegisterHook("/Script/Engine.PlayerController:ClientRestart",
function(self, params)
Log.info("before: " .. self:GetName())
end,
function(self, params)
Log.info("after")
end)
Important
未验证
ClientRestart这个具体例子没有在手机上运行过。钩子机制本身(含蓝图函数的后置回调)在 Mods 页的实现里已经用到。