Cocos2d-x之LUA脚本引擎深入分析

Cocos2d-x 前端之家
前端之家收集整理的这篇文章主要介绍了Cocos2d-x之LUA脚本引擎深入分析，前端之家小编觉得挺不错的，现在分享给大家，也给大家做个参考。

另：本章所用Cocos2d-x版本为:

Cocos2d-2.0.2

http://cn.cocos2d-x.org/download

大家好，又是一周过去了，这一周忙的有点焦头烂额，除了工作照例每天加班到九点外，工具箱又做了大幅改进，新的论坛游戏兔子game2z也上线了，Cocos2d-x的学习时间被压缩的很少了，现在是凌晨一点零六分，看着妻子睡熟的样子，我也只能告诉自已，坚持到底。

好了，不说废话，本周奉上一篇初级入门教程博文，Cocos2d-x中的LUA引导与入门。

做为惯例，一切都是以HelloWorld的样例为准。我们今天学习用LUA来完成一版HelloWorld。

大家既使没有看过我的“HelloWorld 深入分析”一文，想必也无数次运行过Cocos2d-x里的HelloCpp工程，对于运行的结果画面熟烂于心。我们回想一下，这个画面里有什么。嗯，一个背景图精灵，一个文字标签，一个关闭按钮。OK，咱们就做这么个东西。

首先，我们要知道LUA是个什么东西，至于官方怎么说可以百度去查，但我想告诉你的是LUA就是一种可以在不必修改C++代码的情况下实现逻辑处理的手段。稍微讲的再明白一点，就是你用指定语法写一些逻辑处理函数然后保存成文本格式，这个文件称为脚本文件，可以被游戏执行。经过若干年的发展，现在在LUA中写逻辑，除了调用注册到LUA的静态C函数外，也已经可以方便的访问到C++工程中的类的成员函数。这是游戏开发史上最重要的技术之一。其改变了很多设计方案，使游戏变的灵活强大而极具扩展性。

在Cocos2d-x中，有两个类来完成对于LUA脚本文件的处理。

1. CCLuaEngine：LUA脚本引擎

2. CCScriptEngineManager：脚本引擎管理器。

CCLuaEngine类的基类是一个接口类，叫做CCScriptEngineProtocol，它规定了所有LUA引擎的功能函数，它和CCScriptEngineManager都存放在libcocos2d下的script_support目录中的CCScriptSupport.h/cpp中。

首先我们来看一下CCScriptEngineProtocol:


[cpp] view plain copy
  1. classCC_DLLCCScriptEngineProtocol:publicCCObject
  2. {
  3. public:
  4. //取得LUA的全局指针，所有的LUA函数都需要使用这个指针来做为参数进行调用。
  5. virtuallua_State*getLuaState(void)=0;
  7. //通过LUA脚本ID移除对应的CCObject
  8. virtualvoidremoveCCObjectByID(intnLuaID)=0;
  10. //通过函数索引值移除对应的LUA函数。
  11. voidremoveLuaHandler(intnHandler)=0;
  12. //将一个目录中的LUA文件加入到LUA资源容器中。
  13. voidaddSearchPath(constchar*path)=0;
  14. //执行一段LUA代码
  15. virtualintexecuteString(char*codes)=0;
  16. //执行一个LUA脚本文件。
  17. intexecuteScriptFile(char*filename)=0;
  18. //调用一个全局函数。
  19. intexecuteGlobalFunction(char*functionName)=0;
  20. //通过句柄调用函数多种形态。
  21. //通过句柄调用函数,参数二为参数数量。
  22. intexecuteFunctionByHandler(intnHandler,intnumArgs=0)=0;
  24. intexecuteFunctionWithIntegerData(intdata)=0;
  26. intexecuteFunctionWithFloatData(floatdata)=0;
  28. intexecuteFunctionWithBooleanData(booldata)=0;
  29. 名称。
  30. intexecuteFunctionWithCCObject(char*typeName)=0;
  31. //将一个整数数值压栈做为参数。
  32. intpushIntegerToLuaStack(intdata)=0;
  33. //将一个浮点数值压栈做为参数。
  34. intpushFloatToLuaStack(//将一个布尔数值压栈做为参数。
  35. intpushBooleanToLuaStack(//将一个CCObject指针和类型名压栈做为参数。
  36. intpushCCObjectToLuaStack(CCObject*pObject,87); background-color:inherit; font-weight:bold">char*typeName)=0;
  37. //执行单点触屏事件
  38. intexecuteTouchEvent(inteventType,CCTouch*pTouch)=0;
  39. //执行多点触屏事件。
  40. intexecuteTouchesEvent(//执行一个回调函数。
  41. intexecuteSchedule(floatdt)=0;
  42. };

这个接口类的功能函数的具体实现，我们要参看CCLuaEngine类。

现在我们打开CCLuaEngine.h：

copy
    //加入lua的头文件，约定其中代码使用C风格
  1. extern"C"{
  2. #include"lua.h"
  3. }
  4. //相应的头文件。
  5. #include"ccTypes.h"
  6. #include"cocoa/CCObject.h"
  7. #include"touch_dispatcher/CCTouch.h"
  8. #include"cocoa/CCSet.h"
  9. #include"base_nodes/CCNode.h"
  10. #include"script_support/CCScriptSupport.h"
  11. //使用Cocos2d命名空间
  12. NS_CC_BEGIN
  13. //由CCScriptEngineProtocol派生的实际功能类。
  14. classCCLuaEngine:publicCCScriptEngineProtocol
  15. //析构
  16. ~CCLuaEngine();
  17. //取得LUA的全局指针，所有的LUA函数都需要使用这个指针来做为参数进行调用。
  18. void){
  19. returnm_state;
  20. …此处省略若干字。
  21. //加入一个多线程加载LUA脚本的实时回调函数，此函数用于ANDROID
  22. voidaddLuaLoader(lua_CFunctionfunc);
  23. //取得当前单件实例指针
  24. staticCCLuaEngine*engine();
  25. private:
  26. //构造，单例，你懂的。
  27. CCLuaEngine(void)
  28. :m_state(NULL)
  29. {
  30. //初始化函数。
  31. boolinit(void);
  32. //将一个句柄压栈
  33. boolpushFunctionByHandler(intnHandler);
  34. //唯一的LUA指针
  35. lua_State*m_state;
  36. };
  37. NS_CC_END

分析其CPP实现：

copy
    //本类的头文件。
  1. #include"CCLuaEngine.h"
  2. //这里用到了tolua++库，tolua++库是一个专门处理LUA脚本的第三方库，可以很好的完成LUA访问C++类及成员函数的功能。如果没有tolua++,这块要处理起来可是麻烦死了。
  3. #include"tolua++.h"
  4. //加入lua库的相应头文件。
  5. extern"C"{
  6. #include"lualib.h"
  7. #include"lauxlib.h"
  8. #include"tolua_fix.h"
  9. }
  10. //加入Cocos2d-x所用的相应头文件。
  11. #include"cocos2d.h"
  12. #include"LuaCocos2d.h"
  13. #include"cocoa/CCArray.h"
  14. #include"CCScheduler.h"
  15. //如果是ANDROID平台，加上对多线程加载LUA脚本的支持，使用相应的头文件。
  16. #if(CC_TARGET_PLATFORM==CC_PLATFORM_ANDROID)
  17. #include"Cocos2dxLuaLoader.h"
  18. #endif
  19. //开始Cocos2d-x命名空间。
  20. NS_CC_BEGIN
  21. //析构。
  22. CCLuaEngine::~CCLuaEngine()
  23. //结束对LUA指针的使用，关闭LUA。
  24. lua_close(m_state);
  25. //初始始。
  26. boolCCLuaEngine::init(void)
  27. //开始对LUA的使用，创建一个LUA指针。
  28. m_state=lua_open();
  29. //打开相应的库。
  30. luaL_openlibs(m_state);
  31. //打开使用tolua封装的访问Cocos2d-x的库。
  32. tolua_Cocos2d_open(m_state);
  33. tolua_prepare_ccobject_table(m_state);
  34. //如果是ANDROID平台，也加上对LUA进行多线程加载的库支持。
  35. #if(CC_TARGET_PLATFORM==CC_PLATFORM_ANDROID)
  36. addLuaLoader(loader_Android);
  37. #endif
  38. returntrue;
  39. //取得单例指针。
  40. CCLuaEngine*CCLuaEngine::engine()
  41. CCLuaEngine*pEngine=newCCLuaEngine();
  42. pEngine->init();
  43. pEngine->autorelease();
  44. returnpEngine;
  45. voidCCLuaEngine::removeCCObjectByID(intnLuaID)
  46. tolua_remove_ccobject_by_refid(m_state,nLuaID);
  47. //<spanstyle="font-family:Arial,sans-serif;">通过函数索引值移除对应的LUA函数。</span>
  48. voidCCLuaEngine::removeLuaHandler(intnHandler)
  49. tolua_remove_function_by_refid(m_state,nHandler);
  50. voidCCLuaEngine::addSearchPath(char*path)
  51. //取得全局表package
  52. lua_getglobal(m_state,"package");
  53. //取得其中的path字段,压入栈顶。
  54. lua_getfield(m_state,-1,"path");
  55. //取得当前的目录字符串。
  56. char*cur_path=lua_tostring(m_state,-1);
  57. //参数出栈，恢复堆栈。
  58. lua_pop(m_state,1);
  59. //将新路径字符串加入到路径串列中，压入栈顶。
  60. lua_pushfstring(m_state,"%s;%s/?.lua",cur_path,path);
  61. //设置path字段值路径
  62. lua_setfield(m_state,-2,0); background-color:inherit">//执行一段LUA代码
  63. intCCLuaEngine::executeString(char*codes)
  64. //执行一段LUA代码。返回值存放到nRet中。
  65. intnRet=luaL_dostring(m_state,codes);
  66. //进行下拉圾收集。
  67. lua_gc(m_state,LUA_GCCOLLECT,0);
  68. //如果出错，打印日志。
  69. if(nRet!=0)
  70. CCLOG("[LUAERROR]%s",lua_tostring(m_state,-1));
  71. lua_pop(m_state,1);
  72. returnnRet;
  73. return0;
  74. intCCLuaEngine::executeScriptFile(char*filename)
  75. //执行一个LUA脚本文件。返回值存放到nRet中。
  76. intnRet=luaL_dofile(m_state,filename);
  77. //lua_gc(m_state,0);
  78. //调用一个全局函数。
  79. intCCLuaEngine::executeGlobalFunction(char*functionName)
  80. //将全局函数放在栈顶
  81. /*queryfunctionbyname,stack:function*/
  82. //判断是否是函数。
  83. if(!lua_isfunction(m_state,-1))
  84. CCLOG("[LUAERROR]name'%s'doesnotrepresentaLuafunction",functionName);
  85. //调用函数。
  86. interror=lua_pcall(m_state,1,0);/*callfunction,stack:ret*/
  87. if(error)
  88. //cleanerrormessage
  89. //getreturnvalue
  90. //如果取得的第一个参数不是数字，返回错误。
  91. if(!lua_isnumber(m_state,-1))
  92. //取得数字的参数存放在ret中。
  93. intret=lua_tointeger(m_state,-1);
  94. //参数出栈，恢复堆栈。
  95. /*stack:-*/
  96. returnret;
  97. intCCLuaEngine::executeFunctionByHandler(intnumArgs)
  98. if(pushFunctionByHandler(nHandler))
  99. if(numArgs>0)
  100. lua_insert(m_state,-(numArgs+1));/*stack:...funcarg1arg2...*/
  101. interror=0;
  102. //try
  103. //{
  104. error=lua_pcall(m_state,numArgs,0);/*stack:...ret*/
  105. //}
  106. //catch(exception&e)
  107. //CCLOG("[LUAERROR]lua_pcall(%d)catchC++exception:%s",nHandler,e.what());
  108. //lua_settop(m_state,0);
  109. //return0;
  110. //catch(...)
  111. //CCLOG("[LUAERROR]lua_pcall(%d)catchC++unknownexception.",nHandler);
  112. lua_settop(m_state,0);
  113. intret=0;
  114. //如果返回参数是数字转为整数。
  115. if(lua_isnumber(m_state,108); list-style:decimal-leading-zero outside; color:inherit; line-height:18px; margin:0px!important; padding:0px 3px 0px 10px!important"> ret=lua_tointeger(m_state,-1);
  116. }//如果是布尔型转为true或false
  117. elseif(lua_isboolean(m_state,108); list-style:decimal-leading-zero outside; color:inherit; line-height:18px; margin:0px!important; padding:0px 3px 0px 10px!important"> ret=lua_toboolean(m_state,153); background-color:inherit; font-weight:bold">else
  119. intCCLuaEngine::executeFunctionWithIntegerData(intdata)
  120. lua_pushinteger(m_state,data);
  121. returnexecuteFunctionByHandler(nHandler,1);
  123. intCCLuaEngine::executeFunctionWithFloatData(floatdata)
  124. lua_pushnumber(m_state,参数二为布尔型数据。
  125. intCCLuaEngine::executeFunctionWithBooleanData(booldata)
  126. lua_pushboolean(m_state,参数二为CCObject指针数据和其类型名称。
  127. intCCLuaEngine::executeFunctionWithCCObject(char*typeName)
  128. tolua_pushusertype_ccobject(m_state,pObject->m_uID,&pObject->m_nLuaID,pObject,typeName);
  129. intCCLuaEngine::pushIntegerToLuaStack(//将整数值压入堆栈
  130. lua_pushinteger(m_state,data);
  131. //返回参数的数量。
  132. returnlua_gettop(m_state);
  133. intCCLuaEngine::pushFloatToLuaStack(//将数字值压入堆栈
  134. lua_pushnumber(m_state,87); background-color:inherit; font-weight:bold">intCCLuaEngine::pushBooleanToLuaStack(//将boolean值压入堆栈
  135. lua_pushboolean(m_state,87); background-color:inherit; font-weight:bold">intCCLuaEngine::pushCCObjectToLuaStack(CCObject*pObject,87); background-color:inherit; font-weight:bold">intCCLuaEngine::executeTouchEvent( CCPointpt=CCDirector::sharedDirector()->convertToGL(pTouch->getLocationInView());
  136. //将参数压栈后调用函数。
  139. //执行多点触屏事件。
  140. intCCLuaEngine::executeTouchesEvent(//将类型参数压栈后调用函数。
  141. //创建一个表
  142. lua_newtable(m_state);
  143. //将多个触点信息参数放入表中。
  144. CCDirector*pDirector=CCDirector::sharedDirector();
  145. CCSetIteratorit=pTouches->begin();
  146. CCTouch*pTouch;
  147. intn=1;
  148. while(it!=pTouches->end())
  149. pTouch=(CCTouch*)*it;
  150. CCPointpt=pDirector->convertToGL(pTouch->getLocationInView());
  151. //将位置x压入堆栈
  152. //将栈顶的数值放入到表中对应索引n的数值中
  153. lua_rawseti(m_state,n++);
  154. ++it;
  155. //以表做为第二参数压栈，调用函数。
  156. intCCLuaEngine::executeSchedule(floatdt)
  157. returnexecuteFunctionWithFloatData(nHandler,dt);
  158. //加入一个多线程加载LUA脚本的实时回调函数，此函数用于ANDROID
  159. voidCCLuaEngine::addLuaLoader(lua_CFunctionfunc)
  160. if(!func)return;
  161. //取得全局表
  162. //取得全局表中的“loaders”表
  163. "loaders");
  164. //将设定的函数和参数压栈
  165. lua_pushcfunction(m_state,func);
  166. //将参数压栈
  167. for(inti=lua_objlen(m_state,-2)+1;i>2;--i)
  168. //取得原"loaders"表第i-1个参数
  169. lua_rawgeti(m_state,i-1);
  170. //将取出的值放到新"loaders"表中第i个数值
  171. //将函数设为新"loaders"表的第2个参数
  172. lua_rawseti(m_state,2);
  173. //把“loaders”表放到全局表中
  174. boolCCLuaEngine::pushFunctionByHandler(intnHandler)
  175. //找出注册函数表的第nHandler个数值
  176. lua_rawgeti(m_state,LUA_REGISTRYINDEX,nHandler);/*stack:...func*/
  177. CCLOG("[LUAERROR]functionrefid'%d'doesnotreferenceaLuafunction",nHandler);
  178. false;
  179. }

然后我们来看一下CCScriptEngineManager，这个类被称为脚本引擎管理器，其实很简单，只是用来设定当前项目的唯一正在使用的脚本引擎。也许Cocos2d-x打算用它管理多种类型脚本引擎，比如python，js等。


copy
    classCC_DLLCCScriptEngineManager
  1. ~CCScriptEngineManager(void);
  2. //取得单例指针
  3. CCScriptEngineProtocol*getScriptEngine(void){
  4. returnm_pScriptEngine;
  5. //设置使用的LUA管理器
  6. voidsetScriptEngine(CCScriptEngineProtocol*pScriptEngine);
  7. //移除使用的LUA管理器。
  8. voidremoveScriptEngine(staticCCScriptEngineManager*sharedManager(//销毁单例
  9. staticvoidpurgeSharedManager( CCScriptEngineManager( :m_pScriptEngine(NULL)
  10. //使用的LUA脚本引擎
  11. CCScriptEngineProtocol*m_pScriptEngine;
  12. 其对应的CPP实现:
  13. //全局唯一的
  14. staticCCScriptEngineManager*s_pSharedScriptEngineManager=NULL;
  15. //析构
  16. CCScriptEngineManager::~CCScriptEngineManager( removeScriptEngine();
  17. voidCCScriptEngineManager::setScriptEngine(CCScriptEngineProtocol*pScriptEngine)
  18. removeScriptEngine();
  19. m_pScriptEngine=pScriptEngine;
  20. m_pScriptEngine->retain();
  21. //移除使用的LUA管理器。
  22. voidCCScriptEngineManager::removeScriptEngine(if(m_pScriptEngine)
  23. m_pScriptEngine->release();
  24. m_pScriptEngine=NULL;
  25. //取得单例指针
  26. CCScriptEngineManager*CCScriptEngineManager::sharedManager(if(!s_pSharedScriptEngineManager)
  27. s_pSharedScriptEngineManager=newCCScriptEngineManager();
  28. returns_pSharedScriptEngineManager;
  29. voidCCScriptEngineManager::purgeSharedManager(if(s_pSharedScriptEngineManager)
  30. deletes_pSharedScriptEngineManager;
  31. s_pSharedScriptEngineManager=NULL;
  32. 现在我们来实际操作一下。

    打开HelloLua工程中的AppDelegate.cpp:

    在AppDelegate::applicationDidFinishLaunching()函数中看这几行代码：

    copy
    //取得LUA脚本引擎
  1. CCScriptEngineProtocol*pEngine=CCLuaEngine::engine();
  2. //设置脚本引擎管理器使用新创建的LUA脚本引擎
  3. CCScriptEngineManager::sharedManager()->setScriptEngine(pEngine);
  4. //如果是ANDROID平台，获hello.lua内存到字符串然后执行字符串
  5. CCString*pstrFileContent=CCString::createWithContentsOfFile("hello.lua");
  6. if(pstrFileContent)
  7. pEngine->executeString(pstrFileContent->getCString());
  8. #else
  9. //如果不是ANDROID平台，取得hello.lua文件全路径并执行文件。
  10. std::stringpath=CCFileUtils::sharedFileUtils()->fullPathFromRelativePath("hello.lua");
  11. pEngine->addSearchPath(path.substr(0,path.find_last_of("/")).c_str());
  12. pEngine->executeScriptFile(path.c_str());
  13. #endif

就这样，hello.lua中的脚本就可以被执行了。

现在我们将HelloLua工程目录拷出一份来，将目录和工程命名为StudyLua，并在程序运行目录中加入相关资源图片。之后我们打开hello.lua:


[html] copy
    --设置内存回收
  1. collectgarbage("setpause",100)
  2. collectgarbage("setstepmul",5000)
  3. --取得窗口大小
  4. localwinSize=CCDirector:sharedDirector():getWinSize()
  5. --将Hello背景图加入
  6. localfunctioncreateLayerHello()
  7. locallayerHello=CCLayer:create()
  8. --加入背景图
  9. localbg=CCSprite:create("Hello.png")
  10. bg:setPosition(winSize.width/2,winSize.height/2)
  11. layerHello:addChild(bg)
  12. --创建HelloWorld
  13. locallabel=CCLabelTTF:create("HelloCocos2d-x","Arial",50)
  14. label:setPosition(winSize.width/2,60)
  15. label:setVisible(true)
  16. layerHello:addChild(label)
  17. returnlayerHello
  18. end
  19. --将关闭按钮菜单加入
  20. localfunctioncreateExitBtn()
  21. locallayerMenu=CCLayer:create()
  22. --局部函数，用于退出
  23. localfunctionmenuCallbackExit()
  24. CCDirector:sharedDirector():endToLua()
  25. --创建退出按钮
  26. localmenuPopupItem=CCMenuItemImage:create("CloseNormal.png","CloseSelected.png")
  27. --放在居上角附近
  28. menuPopupItem:setPosition(winSize.width-50,winSize.height-50)
  29. --注册退出函数
  30. menuPopupItem:registerScriptHandler(menuCallbackExit)
  31. --由菜单按钮项创建菜单
  32. localmenuClose=CCMenu:createWithItem(menuPopupItem)
  33. menuClose:setPosition(0,0)
  34. menuClose:setVisible(true)
  35. --将菜单加入层中
  36. layerMenu:addChild(menuClose)
  37. returnlayerMenu
  38. --创建场景
  39. localsceneGame=CCScene:create()
  40. --将Hello背景图加入
  41. sceneGame:addChild(createLayerHello())
  42. sceneGame:addChild(createExitBtn())
  43. --运行场景
  44. CCDirector:sharedDirector():runWithScene(sceneGame)

运行一下：



我只能说，一切好极了，下课！

本文出自：http://blog.csdn.net/honghaier/article/details/8700574

猜你在找的Cocos2d-x相关文章

创建自定义的Cocos2d-x场景
操作步骤 1、创建cocos2d-x工程 2、新建 Scene1.cpp Scene1.h Scene1.h代码 #ifndef __SCE...
给vs2010安装上cocos2d-x的模版
开发环境：OS(WINDOWS 8.1 X64 企业版) cocos2d-x 2.2.1 vs2010 想给vs安装上cocos的模版，...
Python创建Cocos2d-x 2.2方法
把创建项目做成一个批处理，当创建项目时可以省时省力很多。 操作步骤 1、在 E:cocos2d-x-...
cocos2dx 物理碰撞
https://www.cnblogs.com/JiaoQing/p/3906780.html 四个响应函数 1 EventListenerPhysics...
cocos2d-js 自定义事件监听派发
转载于 http://www.cnblogs.com/kenkofox/p/3926797.html 熟悉js的dom事件或者flash事件的...
cocos常用 实用 公共函数 lua代码
公共资源加载，缓存retain；防止被自动销毁 2. 数字滚动递增；用于得奖后，总金币跳动增加...
cocos creator box2d
title Map 使用box2d var sfloors = this.tiledMap.getObjectGroup(‘Special_Floor‘).g...
（转）让quick-cocos2d-x支持加密的plist文件
前篇：quick-cocos2d-x图片资源加密 在前篇里面，我们实现了图片资源的加密，但还没有实现...
（转）quick-cocos2d-x图片资源加密(续)
摘要: 对在quick-cocos2d-x上实现的资源加密方法的补充 前篇： quick-cocos2d-x图片资源加...
Cocos Creator 动态改变sprite图片
首先将存放图片最外层文件夹命名为resources 　　 changeBj: function(){ 　　　　var url...
iOSAndroidSwiftHybridCocos2d-xFlutterXcodeSilverlightcocoaCordova
调试桥筛选栏假异步不会丢失AndPermissio权限申请抽屉式systemUI信号栏多行排列跨多行显示viewmode数据共享录制语音视频通话多行显示Studio3.5拉伸控件望远镜发动态走势图点赞控件显示牌冷启动v3签名v2签名v1签名本地html外接键盘流式标签