cocos2dx-3.x 導出自定義類到 lua 過程詳解

轉載請注明出處：http://www.cnblogs.com/Ray1024

 

一、簡介

最近正在學習cocos2d中的lua游戲開發，因為lua開發的熱更新特性，大家開發游戲好像都會優先選擇lua作為開發語言。

但是遇到一個問題，用lua寫一些簡單的程序沒什么問題，但是一旦需要一個復雜的類，在lua中直接寫就感覺有些吃力。所以想到，可以把游戲開發中比較復雜的模塊使用c++完成，然后導出到lua，讓lua可以輕松調用。

我從頭到尾完整地完成了cocos2dx-3.x中自定義類的導出過程，在網上查了好多資料，也碰到了很多錯誤，然而網上關於這塊的文章比較零散，如果有初學者使用的話得費半天勁才能找全。所以我在這篇文章中詳細地介紹整個過程，並將過程中容易出現的問題和解決方法列舉出來，供大家參考。

 

二、過程詳解

2.1 環境配置(windows環境下)

注意：安裝時全部選擇32位版本，否則會發生無法預料的錯誤。

 

首先，默認我們的cocos2dx-3.x已經安裝完成（這篇文章中，我是用的是cocos2dx-3.3版本），接下來是我們的環境配置：

　　a.下載python2.7.3版本，將安裝路徑例如（C:\Python27）添加到環境變量"Path"中;

　　b.下載並安裝pyyaml；

　　c.下載 pyCheetah解壓縮到python的以下路徑 "C:\Python27\Lib\site-packages";

　　d.確保已經安裝了android-ndk-r9b，不懂這個的請點擊此處查看配置方法;

　　e.設置 NDK_ROOT 的環境變量。

這樣，環境配置就完成了。

 

2.2 寫C++類

我測試用的是cocos2d-x-3.3\tests\lua-empt-test\project\Classes\HelloWorldScene.cpp。

 

2.3 寫一個導出的python腳本

1）進入目錄cocos2d-x-3.3\tools\tolua，復制一份genbindings.py，命名為genbindings_myclass.py
2）把生成目錄制定到咱工程里去，打開genbindings_myclass.py把

output_dir = '%s/cocos/scripting/lua-bindings/auto' % project_root

改成 

output_dir = '%s/tests/lua-empty-test/project/Classes/auto' % project_root

3）修改命令參數,把

cmd_args = {'cocos2dx.ini' : ('cocos2d-x', 'lua_cocos2dx_auto'), \
                    'cocos2dx_extension.ini' : ('cocos2dx_extension', 'lua_cocos2dx_extension_auto'), \
                    'cocos2dx_ui.ini' : ('cocos2dx_ui', 'lua_cocos2dx_ui_auto'), \
                    'cocos2dx_studio.ini' : ('cocos2dx_studio', 'lua_cocos2dx_studio_auto'), \
                    'cocos2dx_spine.ini' : ('cocos2dx_spine', 'lua_cocos2dx_spine_auto'), \
                    'cocos2dx_physics.ini' : ('cocos2dx_physics', 'lua_cocos2dx_physics_auto'), \
                    }

改成

cmd_args = {'myclass.ini' : ('myclass', 'lua_myclass_auto') }

 

2.4 寫myclass.ini文件

我們接下來寫myclass.ini文件，拷貝一份cocos2dx_spine.ini改名，修改成如下內容：

[myclass]
# the prefix to be added to the generated functions. You might or might not use this in your own
# templates
prefix = myclass
  
# create a target namespace (in javascript, this would create some code like the equiv. to `ns = ns || {}`)
# all classes will be embedded in that namespace
target_namespace =
  
android_headers = -I%(androidndkdir)s/platforms/android-14/arch-arm/usr/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.7/libs/armeabi-v7a/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.7/include
android_flags = -D_SIZE_T_DEFINED_ 
  
clang_headers = -I%(clangllvmdir)s/lib/clang/3.3/include 
clang_flags = -nostdinc -x c++ -std=c++11
  
cocos_headers = -I%(cocosdir)s/cocos -I%(cocosdir)s/cocos/2d -I%(cocosdir)s/cocos/base -I%(cocosdir)s/cocos/ui -I%(cocosdir)s/cocos/physics -I%(cocosdir)s/cocos/2d/platform -I%(cocosdir)s/cocos/2d/platform/android -I%(cocosdir)s/cocos/math/kazmath -I%(cocosdir)s/extensions -I%(cocosdir)s/external -I%(cocosdir)s/cocos/editor-support -I%(cocosdir)s
  
cocos_flags = -DANDROID -DCOCOS2D_JAVASCRIPT
  
cxxgenerator_headers =
  
# extra arguments for clang
extra_arguments = %(android_headers)s %(clang_headers)s %(cxxgenerator_headers)s %(cocos_headers)s %(android_flags)s %(clang_flags)s %(cocos_flags)s %(extra_flags)s 
  
# what headers to parse
headers = %(cocosdir)s/tests/lua-empty-test/project/Classes/HelloWorldScene.h
  
# what classes to produce code for. You can use regular expressions here. When testing the regular
# expression, it will be enclosed in "^$", like this: "^Menu*$".
classes = HelloWorld
  
# what should we skip? in the format ClassName::[function function]
# ClassName is a regular expression, but will be used like this: "^ClassName$" functions are also
# regular expressions, they will not be surrounded by "^$". If you want to skip a whole class, just
# add a single "*" as functions. See bellow for several examples. A special class name is "*", which
# will apply to all class names. This is a convenience wildcard to be able to skip similar named
# functions from all classes.
  
skip =
  
rename_functions =
  
rename_classes =
  
# for all class names, should we remove something when registering in the target VM?
remove_prefix =
  
# classes for which there will be no "parent" lookup
classes_have_no_parents =
  
# base classes which will be skipped when their sub-classes found them.
base_classes_to_skip = Ref ProcessBase
  
# classes that create no constructor
# Set is special and we will use a hand-written constructor
abstract_classes =
  
# Determining whether to use script object(js object) to control the lifecycle of native(cpp) object or the other way around. Supported values are 'yes' or 'no'.
script_control_cpp = no

改的時候要注意這些行：

[myclass]
prefix = myclass
target_namespace =
headers = %(cocosdir)s/tests/lua-empty-test/project/Classes/HelloWorldScene.h
classes = HelloWorld
skip =
abstract_classes =

 

2.5 運行python腳本

下面要自動生成代碼了，打開命令行工具，cd到cocos2d-x-3.3\tools\tolua下，敲入

python genbindings_myclass.py

回車運行。如果前面沒問題的話你會在cocos2d-x-3.3\tests\lua-empty-test\project\Classes多了一個文件夾auto。

如果生成成功，那么恭喜你已經越過了難度最大、陷阱最多的地方。如果出現錯誤，那么很可能是你第一部分的環境配置有問題。

 

注意：如果出現錯誤“dos2unix 既不是內部或外部命令,也不是可運行的程序”這樣的錯誤，我的解決方法是，把自己從網上下載的dos2unix.exe文件放在C:\Windows\System32這個文件夾底下，再重新運行腳本，就發現錯誤沒有了。如果還不行，可以配置環境變量里的path，使之指向C:\Windows\System32目錄。dos2unix.exe的下載目錄：http://pan.baidu.com/s/1kTghHzD。

 

2.6 把自定義類的module加入lua

然后把里面生成lua_myclass_auto.cpp和lua_myclass_auto.hpp加入工程中。

把我們生成的個module在腳本引擎初始化的時候加入lua。編輯AppDelegate.cpp，包含lua_myclass_auto.hpp頭文件，在

LuaEngine* engine = LuaEngine::getInstance();

后面加入

register_all_myclass(engine->getLuaStack()->getLuaState());

 

2.7 編譯運行

編譯運行。這樣HelloWorld這個類就被導出到lua了。

 

2.8 導出成功，在lua中使用
這樣整個導出過程就完成了，我們就可以在lua中使用自定義類了。

 

這樣我們就大功告成了！