Unity开发者联盟收藏本站
发帖教程新人必读切换到宽版

 找回密码
 立即注册
Unity开发者联盟»论坛 › 3D Dev Asset 开发资源大全 › 学术研究 Scholarly › UE4学习之路3：Puerts用ts调用C++
返回列表 发新帖
查看: 231|回复: 0

UE4学习之路3：Puerts用ts调用C++

[复制链接]
发表于 2023-8-15 15:45 | 显示全部楼层 |阅读模式
简介：

       ts怎么调用ue4中的类呢？
       首先，puerts已经辅佐我们生成了大部门的类：是指UCLASS，USTRUCT标识表记标帜UPPROPERTY，UFUNCTION的属性、方式，可以直接在ts中包含库ue，就能使用对应类提供的方式。其他类想使用怎么去措置呢。
       比如我们可能使用某些第三方库只有C++版本，那么关于第三方库怎么在ts脚本中调用呢？比如网络库，我们在ts脚本经常会调用发送网络动静函数，必需颠末c++调用第三方库来发出去。
       或者我们本身写了一个担任ue4的某个子类，但愿可以被ts访谒到。
1. 普通C++类：

       首先感激大佬的无私付出，才能使用Puerts，贴出大佬的文章：
https://github.com/Tencent/puerts/blob/master/doc/unreal/template_binding.md
       说下工程的具体法式：
       首先还是之前的项目，我们在Source/InstallPuerts的目录下，创建两个文件：Calc.h 和Calc.cpp文件。创建成功后，添加如下代码：
  1. // .h 文件
  2. #pragma once
  4. class CalA
  5. {
  6. public:
  8.         static int32_t Add(int32_t a, int32_t b)
  9.         {
  10.                 return a + b;
  11.         }
  13.         int32_t Get()
  14.         {
  15.                 return m_c;
  16.         }
  17.         int m_c;
  19. private:
  20.         int m_d;
  21. };
  24. class CalB
  25. {
  26. public:
  27.         static int32_t Add(int32_t a, int32_t b)
  28.         {
  29.                 return a + b;
  30.         }
  31. private:
  32. };
  33.       
  34. // .cpp文件
  35. #include ”Calc.h”
  36. #include ”Binding.hpp”
  38. UsingCppType(CalA);
  39. UsingCppType(CalB);
  41. struct AutoRegisterForCalAB
  42. {
  43.     AutoRegisterForCalAB()
  44.     {
  45.         puerts::DefineClass<CalA>().Function(”AddA”, MakeFunction(&CalA::Add)).Register();
  46.         puerts::DefineClass<CalB>().Function(”AddF”, MakeFunction(&CalB::Add)).Register();
  47.     }
  48. };
  50. AutoRegisterForCalAB _AutoRegisterForCalAB__;
复制代码
         这两个类的声明相信大师都看得懂，主要在cpp文件，首先要包含生成ts的代码的头文件，然后固定格式，使用UsingCppType是在声明要生成ts。然后主要代码是
        puerts::DefineClass<类名>（）.Functiong(”生成的ts的函数名”，使用的函数).Register();
        AutoRegisterForCalAB这个布局体可有可无，其实就是通过布局体的自动创建过程来达到调用函数的目的。这两个函数也可以放到其他启动的函数处所。
        加完之后，打开UE4项目工程，还是之前我们创建的工程。点击编译，完成后再点击ue.d.ts按钮，在目录Plugins/Puerts/Typing/cpp中，就生成了文件index.d.ts:
  1. declare module ”cpp” {
  2.     import * as UE from ”ue”
  3.     import {$Ref, $Nullable} from ”puerts”
  5.     class CalA {
  6.         static AddA(p0: number, p1: number) :number;
  7.     }
  9.     class CalB {
  10.         static AddF(p0: number, p1: number) :number;
  11.     }
  13. }      
复制代码
         但愿大师都按照流程生成了这个文件。
          如何使用呢，就正常引用cpp文件，调用就好了。
  1. import * as UE from &#39;ue&#39;
  3. import {$ref, $unref, $set, argv, on, toManualReleaseDelegate, releaseManualReleaseDelegate} from &#39;puerts&#39;;
  4. import * as cpp from &#39;cpp&#39;
  6. console.log(”Quick start ---------------aaaaaaaaaaaaa----------------”);
  8. let Cala = cpp.CalA;
  9. console.log(Cala.AddA(12, 34));
复制代码
       UE4中运行：查看控制台：


       成功输出成果46。
       有个处所需要注意：就是在执行ue.d.ts生成ts代码的时候，如果是新增类，或者改削类的名字等，可以生成正确的ts文件，如果是删掉某个方式，则会漏掉删除操作，且封锁ue4的时候会报出ue4崩溃的问题，解决方式是封锁ue4改削可以达到效果。这个我咨询了puerts的创建者车大佬，感激大佬的回答，应该是ue4的live reload的功能不完善，不是puerts的问题
重头戏：说下方式或者属性如何转化：以后使用法式员基础技能：复制粘贴模板。
  1. // Binging.hpp 文件内定义
  2. //
  3. // 撑持注册的方式
  4. ClassDefineBuilder<T>& Constructor(InitializeFuncType constructor, int length, const CFunctionInfo** infos);
  5. ClassDefineBuilder<T>& Function(const char* name, FunctionCallbackType func, const CFunctionInfo* info);
  6. ClassDefineBuilder<T>& Function(const char* name, FunctionCallbackType func, int length, const CFunctionInfo** infos)
  7. ClassDefineBuilder<T>& Method(const char* name, FunctionCallbackType func, const CFunctionInfo* info);
  8. ClassDefineBuilder<T>& Method(const char* name, FunctionCallbackType func, int length, const CFunctionInfo** infos)
  9. ClassDefineBuilder<T>& Property(const char* name, FunctionCallbackType getter, FunctionCallbackType setter = nullptr, const char* type = nullptr)
  11. // 生成特定参数的方式
  12. #define MakeConstructor(T, ...) ::puerts::template ConstructorWrapper<T, ##__VA_ARGS__>
  13. #define MakeGetter(M) &(::puerts::PropertyWrapper<decltype(M), M>::getter)
  14. #define MakeSetter(M) &(::puerts::PropertyWrapper<decltype(M), M>::setter)
  15. #define MakeProperty(M) &(::puerts::PropertyWrapper<decltype(M), M>::getter), &(::puerts::PropertyWrapper<decltype(M), M>::setter), ::puerts::PropertyWrapper<decltype(M), M>::info()
  16. #define MakeFunction(M) &(::puerts::FuncCallWrapper<decltype(M), M>::call), ::puerts::FuncCallWrapper<decltype(M), M>::info()
  17. #define SelectFunction(SIGNATURE, M) &(::puerts::FuncCallWrapper<SIGNATURE, M>::call), ::puerts::FuncCallWrapper<SIGNATURE, M>::info()
  18. #define MakeCheckFunction(M) &(::puerts::FuncCallWrapper<decltype(M), M>::checkedCall), ::puerts::FuncCallWrapper<decltype(M), M>::info()
  19. #define MakeOverload(SIGNATURE, M) puerts::FuncCallWrapper<SIGNATURE, M>
  20. #define CombineOverloads(...) &::puerts::OverloadsCombiner<__VA_ARGS__>::call, ::puerts::OverloadsCombiner<__VA_ARGS__>::length, ::puerts::OverloadsCombiner<__VA_ARGS__>::infos()
  21. #define CombineConstructors(...) &::puerts::ConstructorsCombiner<__VA_ARGS__>::call, ::puerts::ConstructorsCombiner<__VA_ARGS__>::length, ::puerts::ConstructorsCombiner<__VA_ARGS__>::infos()
  23. // 怎么使用：
  24. // 构造函数：  仅有一个int参数的构造函数
  25. puerts::DefineClass<CalA>()
  26.     .Constructor<int>()
  27.     .Register();
  28. // 构造函数：  多个构造函数
  29. puerts::DefineClass<CalA>()
  30.     .Constructor(CombineConstructors(
  31.         MakeConstructor(CalA, int32_t, int32_t),
  32.         MakeConstructor(CalA)
  33.         ))
  34.     .Register();
  36. // 静态函数：  单一函数
  37. puerts::DefineClass<CalA>()
  38.     .Function(”Add”, MakeFunction(&CalA::Add))
  39.     .Register();
  41. // 静态函数：  多个重载函数，假设CalA有4个构造函数，参数分袂是下面4种
  42. puerts::DefineClass<CalA>()
  43.     .Function(”Overload”, CombineOverloads(
  44.         MakeOverload(void(*)(), &CalA::Overload),
  45.         MakeOverload(void(*)(int32_t), &CalA::Overload),
  46.         MakeOverload(void(*)(int32_t, int32_t), &CalA::Overload),
  47.         MakeOverload(void(*)(std::string, int32_t), &CalA::Overload)
  48.     ))
  49.     .Register();
  51. // 成员函数：   无重载
  52. puerts::DefineClass<CalA>()
  53.     .Method(”Add”, MakeFunction(&CalA::Add))
  54.     .Register();
  56. // 成员函数：   多个重载，以及连着写法
  57. puerts::DefineClass<CalA>()
  58.     .Method(”OverloadMethod”, CombineOverloads(
  59.         MakeOverload(int32_t(CalA::*)(), &CalA::OverloadMethod),
  60.         MakeOverload(int32_t(CalA::*)(int32_t), &CalA::OverloadMethod),
  61.         MakeOverload(uint32_t(CalA::*)(uint32_t), &CalA::OverloadMethod),
  62.         MakeOverload(int64_t(CalA::*)(int64_t), &CalA::OverloadMethod)
  63.         ))
  64.     .Method(”GetSelf”, MakeFunction(&CalA::GetSelf))
  65.     .Register();
  67. // 成员变量：  
  68. puerts::DefineClass<TestClass>()
  69.     .Property(”X”, MakeProperty(&TestClass::X))
  70.     .Property(”Y”, MakeProperty(&TestClass::Y))
  71.     .Register();
复制代码
2. UE4的类：


         本身编写的担任UE4的类，也必需在文件Source/XXX项目路径下，否则是没法子生成ts的，不外有些东西没必要生成ts的类，也别放在这个目录下，否则会生成ts代码。
       担任的UE的类，声明为UFUNCTION和UPROPERTY的，不需要额外写注册的代码，只需ue4编译并点击ue.d.ts，就能生成ts代码，生成路径是：Plugins\Puerts\Typing\ue目录。
      比如我写的：
就能引用到了：
  1. // .h文件
  2. #pragma once
  4. #include ”ArrayBuffer.h”
  5. #include ”CoreMinimal.h”
  6. #include ”UObject/NoExportTypes.h”
  7. #include ”TestObject.generated.h”
  8. /**
  9. *
  10. */
  11. UCLASS()
  12. class INSTALLPUERTS_API UMyTestObject : public UObject
  13. {
  14.     GENERATED_BODY()
  16. public:
  17.     UMyTestObject();
  19.     UFUNCTION(BlueprintCallable, meta = (DisplayName = ”Add”, ScriptName = ”Add”, Keywords = ”test”), Category = ”Test”)
  20.         int32 Add(int32 a, int32 b) const;
  22.     ~UMyTestObject();
  23. };
  25. // .cpp文件
  26. #include ”TestObject.h”
  28. UMyTestObject::UMyTestObject()
  29. {
  31. }
  33. UMyTestObject::~UMyTestObject()
  34. {
  36. }
  38. int32 UMyTestObject::Add(int32 a, int32 b) const
  39. {
  40.         return a+b;
  41. }
复制代码
ts文件包含库ue就能访谒了。
下面说说非UFUNTION,和UPROPERTY怎么生成：
比如UObject的GetName,GetWorld不是UFUNCTION
  1. #include ”CoreMinimal.h”
  2. #include ”Binding.hpp”
  3. #include ”UEDataBinding.hpp”
  5. UsingUClass(UObject)
  6. UsingUClass(UWorld) // for return type
  8. puerts::DefineClass<UObject>()
  9.     .Method(”GetName”, SelectFunction(FString (UObjectBaseUtility::*)() const, &UObjectBaseUtility::GetName))
  10.     .Method(”GetWorld”, MakeFunction(&UObject::GetWorld))
  11.     .Register();
复制代码
这里因为是UE的类，所以不能使用UsingCppType，要使用UsingUClass，后面的函数基本一样。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

×
回复

使用道具 举报

返回列表 发新帖
懒得打字嘛，点击右侧快捷回复 【右侧内容，后台自定义】
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

小黑屋|手机版|Unity开发者联盟 ( 粤ICP备20003399号 )

GMT+8, 2024-4-29 19:17 , Processed in 0.427135 second(s), 27 queries .

Powered by Discuz! X3.5 Licensed

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表