使用cocos2d脚本生成lua绑定

2022-02-27 17:38:54

这几天要老大要求把DragonBones移到cocos2dx 3.0 里边，并且绑定lua使用接口。因为刚学lua，使用的引擎也刚从2.2改为3.0，各种不熟悉，折腾了好几天才弄完，有空了总结一下

这篇先说一下cocos2d生成lua绑定的修改，有空的话再写一篇lua中注册回调到c++中方法

假设我的目录名称是DragonBones

project_root 项目路径这里我要把DragonBones目录设置为项目路径,但是我的脚本运行目录是在tools下的所以设置如下

project_root = os.path.abspath(os.path.join(os.path.dirname(file), '..'))
cocos_root 设置coco2dx项目的路径

cocos_root = os.path.abspath(os.path.join(project_root, '..', 'cocos2d-x'))
设置解析脚本路径这个路径主要是用来配置cocos2d-x/tools/bindings-generator/generator.py 文件路径的

cxx_generator_root = os.path.abspath(os.path.join(cocos_root, 'tools/bindings-generator'))
这个是设置配置文件路径其实就是db_DragonBones.ini的路径和当前.py文件在同一个目录下

script_root = '%s/tools' % project_root
设置生成文件的目录就是生成的那些.hpp 和.cpp 以及lua的路径

output_dir = '%s/scripting/lua-bindings/auto' % project_root
要生成lua绑定的源文件参数

cmd_args = {
'db_DragonBones.ini' : ('db_DragonBones', >'lua_DragonBones_auto'),
}
- db_DragonBones 这个参数不知道做什么用的，但是要保证和db_DragonBones.ini内第一行中括号里的名字一样一般和 ini文件名相同
- lua_DragonBones_auto 定义生成的hpp 和 cpp的文件名

方法前缀

prefix = db_DragonBones
lua里要用到的名称空间其实就是要把绑定的类放在一个叫db的表里，防止和别的绑定的方法或类冲突

target_namespace = db
native代码中的原名称空间

cpp_namespace = dragonBones

这里得注意一下，这个加上之后发现native中 dragonBones命名空间下的方法没有转成在lua中的db 原因是因为需要在cocos2d-x/tools/bindings-generator/targets/lua/conversions.yaml 内加入名称空间的转换

ns_map:
"dragonBones::": "db."
头文件这个里边要include了所有要暴露方法的头文件参考目录是cocos2dx的目录来设置头文件目录

headers = %(cocosdir)s/../headers.h
要生成的类需要暴露给lua用的类都要写在这里

classes = AnimationData ...
要跳过不生成lua接口的的方法我这里是重载等号操作符有问题，在说本来在lua里边也不会这么调用，不如过改个方法名实现类似的功能来做

skip = AnimationData::[operator=],

设置的都差不多了

这里不得不提的是，看一下conversions.yaml这个文件就大约知道这个脚本创建的过程是怎么映射的

最重要的一句话，暴露给lua的接口和类尽量简单,这个中间的问题越少

因为你不注意的话，有写接口编译什么的没问题，lua调用的时候，会告诉你找不到

码农公寓