一. 簡單介紹
文章介紹是在實際的游戲開發項目中,將自定義的C++類綁定到lua中,能夠讓lua調用c++類。會創建一個python腳本,執行python腳本會讓自動將我們的c++類綁定到lua。生成我們要的代碼。文章會介紹配置環境、編寫腳本、測試類、實際項目中調用,以及一些遇到的問題
二.兵馬未動糧草先行
當前我用的是quicklua 3.3 win7系統。下載需要的工具
可以先看一下 \tools\tolua \README.mdown里面有詳細介紹,而且都有下載地址
我現在是win系統,翻譯一下
(1). 要保證你的ndk是 android-ndk-r9b,配環境變量
(2). Python 2.7.3(32bit),配置環境變量,自己在網上查
安裝pyyaml 我之前安裝失敗是因為python版本不對,然后改成上面的
(3).pycheetah 解壓到你python文件下lib\site-packages
具體可以參考 http://cn.cocos2d-x.org/tutorial/show?id=2518
三.創建一個頭文件類CustomHeaders.h
在 項目的\frameworks\runtime-src\Classes創建一個類,就是項目放classes的地方.
批量綁定的時候用,具體作用后面會講到,可以創建一個例子
/*
手動添加需要綁定到lua的類頭文件
*/
#ifndef __CUSTOMHEADERS_H__
#define __CUSTOMHEADERS_H__
//...導入我們需要綁定的類的頭文件
#include "MyTestClass.h"//example
#include "MyTestClass2.h"//example
#endif
四.幾個測試類
我們需要綁定到lua的類。這里我寫了兩個測試類MyTestClass 和MyTestClass2。如
MyTestClass2.h
#ifndef __MYTESTCLASS2_H__
#define __MYTESTCLASS2_H__
#include "cocos2d.h"
class MyTestClass2
{
public:
static int getTestData();
private:
};
#endif
MyTestClass2.cpp
#include "MyTestClass2.h"
int MyTestClass2::getTestData()
{
int a = 22222;
return a;
}
兩個都差不多。就是返回整數。
五.寫一個python腳本,和一個ini
\tools\tolua文件夾下的genbindings.py復制一份。我們重新起名咱們用的py。
\tools\tolua文件夾下的任意一個ini文件復制一份。我們可以重新起名為我們用的配置文件比如myclass.ini
這里我該成myclass_genbindings.py。名字隨便。有兩個地方需要改然后找到
(1)修改py
1.output_dir = '%s/cocos/scripting/lua-bindings/auto' % project_root
將輸出路徑改為咱們自己的classes文件夾下。可以根據自帶的路徑寫出自己的路徑例如:
output_dir='%s/project/cardgame/frameworks/runtime-src/Classes' % project_root。
組裝的路徑。project_root當前項目的目錄,然后加上后面你自己的classes路徑
當然可以在classes文件夾下創建一個auto文件夾,來存放自動生成的文件,我這里沒有創建
2.
cmd_args = {'cocos2dx.ini' : ('cocos2d-x', 'lua_cocos2dx_auto'), 。。。
}
改成:
cmd_args = {'myclass.ini' : ('myclass', 'lua_myclass_auto')}
第一個參數是之前的ini文件。 第二個后面要用到。第三個是腳本生成的文件的名字lua_myclass_auto
(2)修改ini
1.將第一行改成 [上面的第二個]比如[myclass]
2.prefix = myclass
3.target_namespace =什么什么的改成 target_namespace =
注:后面會講到=空或者=其他的原因
4.headers = 什么什么的 改成咱們上面寫的CustomHeaders.h的路徑,可以根據已經有的路徑拼接處咱們的路徑
如:%(cocosdir)s/project/cardgame/frameworks/runtime-src/Classes/CustomHeaders.h
5、classes = 咱們需要綁定的類的名字 ,如
classes = MyTestClass MyTestClass2 可以支持多個。需要在CustomHeaders.h文件中導入自定義類的頭文件,然后在classes=后面添加上類名就 可以
OK了。我們 cd 到myclass_genbindings.py腳本的文件夾下,執行腳本 python myclass_genbindings.py 就可以自動綁定拉。
小技巧:在文件夾,按住shift+鼠標右鍵,可以看到 在此處打開命令窗口,比較方便、
六.上面寫ini簡單介紹
1、首先必須了解正則表達式,百度直接搜索正則表達式
2、關鍵參數
prefix 關系到lua函數開頭的名字,如prefix=cocos2dx,那么生成的代碼就是以lua_cocos2dx開頭
target_namespace 表面這些lua函數注冊到哪個命名空間,在lua中,就是代表注冊到那個表中,如target_namespace=custom,那么在lua中調用就是以 custom. 開頭(但這個參數好像控制不到,真正能控制的是在C++里面是否有custom的命名空間)
這里有兩點要注意的
(1)、如果有自定義的命名空間,cocos2dx主目錄的tools文件夾下bindings-generator\targets\lua下的conversions.yaml(js的是bindings-generator\targets\spidermonkey下的conversions.yaml)添加自己的命名空間:
ns_map:
"cocos2d::extension::": "cc."
"cocos2d::ui::": "ccui."
"cocos2d::": "cc."
"spine::": "sp."
"cocostudio::": "ccs."
"cocosbuilder::": "cc."
"CocosDenshion::": "cc."
"custom::": "custom."
這個文件貌似是一些替換操作配置(就是在生成C++文件中替換掉所設置的的字符串),自己研究一下就知道了。
(2)如果自己的代碼沒有命名空間,建議弄一個,不然遇到C++類中的類型
舀鱙A類中有函數參數或返回值用到State類型的,在生成過程中匯報錯,報錯消息稱沒有A的命名空間。。。那么這時候就得到第一點提及的地方加入一行:"A::":"A."的信息。在有命名空間的情況下,生成器直接通過。這里是個奇怪的問題。
headers 填入你所編寫的代碼的頭文件
classes 填入要生成的類,支持多個類,支持正則表達式,如classes = A,^A,^A$
skip 指定屏蔽函數,即不需要暴露給lua的函數,支持正則表達式,如 skip = Sprite::[getQuad getBlendFunc ^setPosition$ setBlendFunc]
rename_functions 重新命名暴露到lua中函數名(一般以C++編寫函數名暴露到lua),如 rename_functions = SpriteFrameCache::[addSpriteFramesWithFile=addSpriteFrames getSpriteFrameByName=getSpriteFrame],
等號前是原函數名,等號后是lua中的新函數名
rename_classes重命名類,如 rename_classes = SimpleAudioEngine::AudioEngine。前面是原名,后面是lua新名。這個好像沒效果,生成后還是那個名字
classes_have_no_parents 指定一些沒有父類的類
base_classes_to_skip 指定一些需要跳過的基類
abstract_classes 指定一些抽象類或者沒有構造函數的類,以手動方式編寫注冊到lua函數
編寫完后,把只要執行修改過的自定義的或者修改過的genbindings.py(http://www.cocoachina.com/bbs/read.php?tid=196416 提及)就可以生成出相關的代碼
3、自動生成的代碼會自動過濾掉C++中的protect、private屬性、重載父類的函數、帶省略號參數的函數(如Menu::create(MenuItem* item, ...) )
七。在我們的項目中添加剛才創建的類和自動生成的類、然后在
AppDelegate.cpp中:
(1)#include "lua_myclass_auto.hpp" //導入我們自動生成的文件
(2)找到腳本引擎初始化的地方,和其他的語句一樣
lua_myclass_auto.hpp中的方法register_all_**(L)這里是register_all_myclass(L)
編譯生成
可以了。
在lua中。使用例子
local testValue = MyTestClass:getTestData()
local testValue2 = MyTestClass2:getTestData()
print('==============='..testValue.."-------------"..testValue2)
遇到問題可能是配置不對,類寫的不對等。輸出那可以找到
lua的table 到c++的map ——>
可以模仿 ccs.SkeletonNode:changeSkins
luaval_to_std_map_string_string
