Lua调用自定义C++类 和遇到的问题解决

在已有项目中新加入新的类绑定

  如果原来项目中有了之前的类绑定，那么新加入的类绑定做法如下：

   1.在原Class文件下加入需要绑定的cpp和。h头文件 

    2.在原lua与C++交互的头文件里面加入新的类引用

    

   3.修改原ini文件，加入新加的类

 保存后，执行生成绑定的bat文件即可，完成绑定。

Lua调用自定义C++类

Skip to end of metadata

Go to start of metadata

对于如何将自己写的C++类注册进Lua环境，让Lua去调用自定义的C++类。在Cocos2d-x 3.2版本中，提供了bindings-generator脚本来封装toLua++的用法。

【使用工具】

• Windows7 x64

• Cocos2d-x v3.2（下载地址）

• Cocos Code IDE 1.0.1 （支持自定义类的智能提示功能）（下载地址 ）

• python 2.7.x（v3.2版本不一定要2.7.3，我用2.7.8也成功了的，bit32位）

• NDK r9d，解压并配置环境变量NDK_ROOT（v3.2版本不一定要r9b，我用r9d成功了的）
  -- NDK装完要记得重启，不然是没法用的 重启之后可以用 ndk-build -version 来验证成功与否

• pyyaml，安装到 "Python的安装目录\Lib\site-packages"（点击下载）

• Cheetah，并解压到 "Python的安装目录\Lib\site-packages"（点击下载）

  -- pyyaml和cheetah 还有另外一种方法安装，就是用setuptools<easy_install>安装python库，安装方法在这（点击下载）

• dos2unix，windows下可能在执行脚本时有这个错误。解压到一某个目录下面, 并设置PATH环境变量的值指向bin目录下。（点击下载）

  【绑定方法】

  以下介绍的是在 Windows7 + VS2012 + Cocos Code IDE。

  并使用Cocos Code IDE创建的Lua项目，绑定方法。

  1、将自定义的C++代码放在frameworks\runtime-src\Classes下

  当然放哪里是随意的，我喜欢放在Classes下。

  

  2、添加自定义类的.ini文件

  在 frameworks\cocos2d-x\tools\tolua 中，复制一份该文件夹下cocos2dx.ini的配置信息，然后修改一些参数，改成我们自定义类的参数。

  

  以下列出需要修改的参数配置：

   

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

  [custom_api]    # prefix会被添加到生成的函数.你也可以选择不添加这个到你的模板 prefix = custom_api    # 所有的类都会嵌入到这个命名空间 target_namespace = my    # 类所在的路径，如果有多个，用空格隔开 headers = %(cocosdir)s/../runtime-src/Classes/PanZoomLayer.h    # 需要注册的类，如果有多个，用空格隔开 classes = PanZoomLayer    # 不提供给Lua的public成员函数 skip = PanZoomLayer::[onTouchesBegan onTouchesMoved onTouchesEnded init onEnter onExit update]    # 这些全空就好了 rename_functions = rename_classes =  remove_prefix =  classes_have_no_parents =  base_classes_to_skip = abstract_classes =  script_control_cpp = no

   

   

  3、genbindings.py 添加自定义的配置.ini

  在 frameworks\cocos2d-x\tools\tolua 的 genbindings.py 中的129行找到cmd_args。

  将我们自定义的 custom_api.ini 添加进去，并注释掉其他.ini（这些已经不需要重新生成）

  

  4、运行 genbindings.py 脚本

  在终端运行 genbindings.py 脚本。

  在这里，我是直接写了一个批处理文件 .bat 。

  注意：只要需要用到的工具都下载，安装，配置好了，一般就能生成成功。

  生成失败的，基本都是因为工具没有配置好。

  

  生成成功后，在 frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto 中会找到我们生成的C++的桥接文件， lua_custom_api_auto.cpp 和 lua_custom_api_auto.hpp 。

  

  其中，lua_custom_api_auto.hpp 中的 register_all_custom_api 就是我们用来将PanZoomLayer类注册到Lua环境中的关键函数。

  

  以及在 frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto\api 中也能够找到我们提供给Lua调用的接口文件。

  

  5、编译注册到Lua

  注册自定义类的函数在我们的 lua_custom_api_auto.hpp 中可以看到。

  register_all_custom_api(lua_State* tolua_S)

  

  使用 VS2012 打开 frameworks\runtime-src\proj.win32 下的工程。

  （1）将自定义的类 PanZoomLayer 添加到项目工程的Classes下。

  

  （2）将 lua_custom_api_auto.cpp、lua_custom_api_auto.hpp 添加到工程liblua的auto下。

  

   

  （3）添加lualib工程的文件搜索路径。

  将 $(EngineRoot)../runtime-src/Classes 路径加进去。

  

  （4）编辑 frameworks\runtime-src\Classes 下的入口类 AppDelegate.cpp

  • 添加：lua_custom_api_auto.hpp 头文件

  

  注册：register_all_custom_api(state)

  注意：register_all_custom_api 的上下两句话，必须加上！

  

  （5）编译运行整个项目，完成C++类的注册到Lua。

  然后就可以再Lua中愉快的使用自定义的类了！

  local op_test = my.custom_api:new()
  local op_test1 = op_test:ShowUI(3)

遇到的生成问题大部分都是前面的配置不正确引起的；

其中 You don't have the C version of NameMapper installed! 这个问题是因为：

就是headers的路径有问题，因为genbindings.py的位置不同，所以相应的

?

1 2 3

project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..' , '..' )) cocos_root = os.path.abspath(os.path.join(project_root, '')) cxx_generator_root = os.path.abspath(os.path.join(project_root, 'tools/bindings-generator' ))

都会相应改变，project_root和cocos_root是一样的都是从genbindings.py开始算起向上2个层级

此时可以将headers的路径改为绝对路径

例如：headers = /Users/tokou/WORK/5-Cocos2dx/Project/UI/uitestLua/frameworks/runtime-src/Classes/TestScene.h 

就可以了