Cocos2d+Lua 游戏开发中的技巧系列之一 Lua require的语法糖

参考文档  --- https://blog.csdn.net/lovesmiles/article/details/80939240

笔记:

Lua/JS尾调用   http://www.ruanyifeng.com/blog/2015/04/tail-call.html
Lua的闭包详解   (和JS一吊样)

Lua中的元表与元方法(_index与_newIndex区别) https://blog.csdn.net/u013654125/article/details/100151633
qucik lua中require和import的区别    
2种区别在定义对象时. class()/local X={}   (前者用new 后者直接用)

Lua - table输出乱序 (如果元素不为键值对，则按顺序遍历元素 Or乱序)         Lua与C++接口对照    类声明继承

【译】从 JS 学习 Lua    
 Cocos2d-x Lua 1.环境搭建并开始项目 https://blog.csdn.net/zhouyongku/article/details/72891661

VS新建类/引用库(lib/dll)  table模拟OOP/cc.exports.      断点无效(整了一天 教训:仔细查Log/提示) <2020/3/13>

 studio与cocos版本不批配(CSB无法加载)  回调函数(使用this=self) print/f输出nil  

如何查对应接口tolua_usertype  无声明提前    <踩蚂蚁code:下方>

 

2020/3/12/

cocos2d-lua:新建项目环境搭建弄了好久 <博客https://www.jianshu.com/p/b00d518c649c>
 报错:    运行引擎下setUp.py文件, DOS窗口Log提示:ANDROID_SDK_ROOT/NDK_ROOT not found
 解决办法:  环境变量Path中要引用%NDK_ROOT%.   SDK都配了一直not found是因为:路径要到tools 泪奔

2020/3/14/
cocosStudio与cocos版本不批配 (导致CSB无法加载)  

回调函数self不是原来self(类似JS解决: 使用this=self)

常见bug: <a nil value>

sp =cc.Sprite:create();  self:addChild(sp);

这种情况不外户: 对象或方法为nil

OOP: 面向对象

一些笔记:

---

        作为一个中级即将要成为高级的游戏开发程序员，用Lua写了一二年游戏的你，require这个有什么好提的，天天在用，使用中还有什么技巧可言？

  这个require在使用过程中，真的还有一些技巧，当然，这个技巧并不是说在游戏运行效率上有惊天的变化，而仅仅是一个语法糖，不用对游戏性能也没有半毛钱的影响，但是用了，可能对游戏开发效率和阅读效率都有些帮助。

    先分享一下require在Lua源代码中的实现...嗯，算了，这一步跳过吧，require加载一个lua的过程很多博客已经说了，我也说得并不比别人好，还是直接进入主题吧。

通常，很多游戏的reuire是这样子用的：比如，某游戏的包背管理器的是在PackageMgr.lua里面实现的，这个文件在游戏的Res\script\lua\mgr\PackageMgr.lua里面。假如PackageMgr.lua里面是这样子写的,即这个PackageMgr.lua是直接返回的一个单例。

local PackageMgr={}
 
--这里面是游戏逻辑
 
return PackageMgr

那么，在其它地方引用这个单例时，最常见的一种代码的写法是这样子：

方法1

local packet = require("script.lua.mgr.PackageMgr")

将Res设置成lua的搜索根路径，在引用时，使用全路径，这样子的用法是比较经典的，它的问题唯一在：写的代码太多了，你要引用别人写的一个模块，还要知道它所在的路径，假如这个路径很长，码起来很累的，copy也会出错，而且加载出错，要到运行时才能知道没有这个路径。

为了解决拼写过长的问题，我们可以考虑另外一种解决方案:

方法2

我们将Res\script\lua\mgr\添加到游戏的搜索路径，这样，在使用时就可以

local packet = require("PackageMgr")

只需要一个PackageMgr模块名就能将它引用进来了，是不是省了很多字？嗯，这种写法也有一个问题：就是假如游戏的文件夹太多，这样子就要添加很多的搜索路径，搜索路径太多的话，搜索的效率自然会降低了，而且，太多的文件路径，怎么添加？手工添加还是脚本添加？新增的和删除的文件夹怎么维护也是个问题。

好了，我们既想获得方法2的简洁，又想获得方法1 的高效率，自然的就出现了第三种方法

方法3

我们定义一个新的require,为了区别require，我们就叫做GameRequire吧。

function GameRequire(luaFileName)
    local fullLuaFilePath = FullPath[luaFileName]
    if fullLuaFilePath then
        return require(fullLuaFilePath)
    else
        return require(luaFileName)
    end
end

阅读上面GameRequire的实现代码，首先，通过一个全局的FullPath表，将luaFileName转换成FullLuaFilePath，假如存在FullLuaFilePath，我们就用FullLuaFilePath 进行require，假如不存在，我们就用luaFileName进行require。这样，我们在使用时只要输入一个lua文件名，就能自动实现全路径的搜索加载啦。相信大家都已经看出这里面实现文件名转换成长路径逻辑的关键是FullPath这个表了，这个表具体是长这样子的：

FullPath ={
 
Package="script.lua.mgr.PackageMgr",
MainUI ="script.lua.ui.MainUI",
....
 
 
} 

可以看出这个FullPath是一个全局的变量表，这个表里面的内容非常简单，就是将所有的lua文件都转换成了长路径保存，通常这个FullPath.lua是用脚本来实现和维护的，哪个同学新增了一个lua文件，就跑一下维护脚本，更新一下这个FullPath.lua，这样子大家都可以用GameRequire("文件名")就可以引用新增的模块了。

写到这里，相信很多写了几年lua的同学都想喷我了，什么辣鸡啊，这些东西也有什么好写的，不是很常见的吗？没有什么好说的。好吧，好吧，很显然，写GameRequire还是太累了，虽然我们可以把GameRequire简写成GR之类的，但还要写引号，括号。下面的方法就是解决这个懒人问题的奇淫技巧。这种方法是我自己原创出来的(虽然技术含量基本没有，可能也有很多大佬不宵，不过我觉得还是很意思的)。

方法4

我们知道lua里面有元表这个东西，元表里面的__index方法相信很多同学都知道了，这里面我们要用__index方法来实现lua文件的加载，使得我们可以少写点代码

 

local GameRequire= GameRequire
_GModel ={}
_GModelMeta={
__index =function(t,key)
    local modelFile = GameRequire(key)
    --t[key] = modelFile --这里是开启缓存功能
    return modelFile
 
end
 
}

我们定义了一个全局的变量_GModel,这个变量有一个元表_GModelMeta,里面有一个元方法。使用时是这样子使用的：

local packet = _GModel.PackageMgr

这样子就实现require的调用了。原理听我慢慢分析一下：

首先： _GModel.PackageMgr和 _GModel["PackageMgr"]是等价的对吧？（这是lua的语法，如果你不知道的，那么这篇文章对你来说真的是白看了）。

其次：lua先在_GModel表里面查找“PackageMgr”成员，查不到，就在元表_GModelMeta里面查找，_GModelMeta里面也找不到啊，没关系，_GModelMeta有一个__index元方法，那就调用 __index方法来查找吧，这样子__index里面的GameRequire函数就被调用 了，然后返回GameRequire的结果。上面__index函数被调用里，里面的参数t就是_GModel,key就是“PackageMgr”，为什么这二个参数值是这样子？你得回去查查元表的调用过程了。

上面的代码还有一句注释掉了的，这个注释掉的是一个缓存代码，假如将它打开，第一次调用时_GModel找不到成员，会触发GameRequire，同时，将GameRequire的返回值存在了_GModel里面了，第二次调用时，因为_GModel已经有模块的数据，将会直接返回，不再调用GameRequire，也就是也不会调用到require了，省了lua内部的查找过程，在这个角度看，开了缓存的_GModel的效率比require还要高一点。写的代码比require少，效率还要比require高那么一点点的方法，是不是个奇技淫巧？

好了，到这里，我们就完成了require的奇技介绍了。如果你愿意你可以将_GModel简单写成_M

local packet = _M.PackageMgr

这样子，require是不是就可以码很少字啦？哈哈，不过千万不要将_GModel简单写成_G,因为_G是lua的保留变量。
————————————————
MainScene.lua
 

local MainScene = class("MainScene", cc.load("mvc").ViewBase);
local PlayScene = import("app.views.PlayScene");

function MainScene:ctor()
        local sp = display.newSprite("img/cover.jpg");
        sp:setPosition(display.cx, display.cy);
        self:addChild(sp);
        
        local sp1 =  ccui.Button:create( "img/play_button.png","img/play_button.png","img/play_button.png" );
        sp1:setPosition(display.cx, display.cy - 200);
        self:addChild(sp1);

      sp1:addTouchEventListener(function(ref, evenType)
            if cc.EventCode.BEGAN == evenType then
            elseif cc.EventCode.ENDED == evenType then
                local playScene2 = PlayScene.new() ;
                 
                print(" : ", display, display.replaceScene, import("app.views.PlayScene"), playScene2);
              cc.Director:getInstance():replaceScene(import("app.views.PlayScene").new()); -- display.replaceScene(playScene2)
            end
        end);
end

function MainScene:onEnter()
end

function MainScene:onExit()
end

return MainScene

PlayScene.lua

local PlayScene = class("PlayScene", function()
    return display.newScene("PlayScene")
end)

local Game = require("app.models.Game")
cc.exports.PushCenter = require("src.app.PushCenter");
    

function PlayScene:ctor()

   self.game_ = Game.new(self)

    local bg = display.newSprite("img/bg.jpg");
        bg:setPosition(display.cx, display.cy)
        self:addChild(bg);

    local star = display.newSprite("img/star.png")
        star:setPosition(display.left + 50, display.top - 50)
        self:addChild(star)

    --self.starsLabel_ = nil;

        self.starsLabel_  = cc.Label:createWithSystemFont(self.game_:getStars(), "Arial", 40)
        :move(display.left + 90, display.top - 50)
        :addTo(self)

       self:onNodeEvent("enter", self.onEnter);
       self:onNodeEvent("exit", self.onExit);
end

 function PlayScene:onTouchBegan(pTouch,event)
 print("self  game_:", self, self.game_);

  print(" pTouch  event:", pTouch:getLocation(), event.name);

          self.game_:onTouch(event)
end

local  function addListenerEvent(self)
local this = self;
   local listener1 = cc.EventListenerTouchOneByOne:create()  --创建一个单点事件监听
    listener1:setSwallowTouches(true)  --是否向下传递
    --注册三个回调监听方法
    listener1:registerScriptHandler(handler(self, self.onTouchBegan),cc.Handler.EVENT_TOUCH_BEGAN )
 
    local eventDispatcher = self:getEventDispatcher() --事件派发器
    
    eventDispatcher:addEventListenerWithSceneGraphPriority(listener1, self) --分发监听事
 
end



function PlayScene:onEnter()
    local this = self;
    PushCenter:addListener("BUG_ENTER_HOLE_EVENT", function(event)
        self.starsLabel_:setString(self.game_:getStars())
    end, self)

    PushCenter:addListener("PLAYER_DEAD_EVENT", handler(self, self.onPlayerDead_), self)


     self:getScheduler():scheduleScriptFunc( function(dt)
                                                this.game_:step()
                                                end, 0.02, false);
                                            
     
        self:getScheduler():scheduleScriptFunc( function(dt)
                                                    this.game_:addBug()
                                                    print("===2");
                                                    end, 2, false);
 

   --[[ self:setTouchEnabled(true)
    self:addNodeEventListener(cc.NODE_TOUCH_EVENT, function(event)
        return this.game_:onTouch(event)
    end)]]
    addListenerEvent(self);
end
 
function PlayScene:onExit()
end

function PlayScene:onPlayerDead_()
print("--------------------------------game over");
    local text = string.format("你戳死了 %d 只虫子", self.game_:getDeadCount())
    cc.ui.UILabel.new({text = text, size = 96})
        :align(display.CENTER, display.cx, display.cy)
        :addTo(self)

    cc.ui.UIPushButton.new("img/exit_button.png")
        :onButtonClicked(function()
            app:enterScene("MainScene", nil, "Random", 1.0)
        end)
        :pos(display.cx, display.cy - 200)
        :addTo(self)
end

return PlayScene

Game.lua

local Game = class("Game")

Game.HOLE_POSITION = cc.p(display.cx - 30, display.cy - 75)
Game.INIT_STARS = 50
Game.BUG_ENTER_HOLE_EVENT = "BUG_ENTER_HOLE_EVENT"
Game.PLAYER_DEAD_EVENT = "PLAYER_DEAD_EVENT"

local BugAnt = import(".BugAnt")
local BugSpider = import(".BugSpider")
--local PushCenter = require("src.app.PushCenter");

function Game:ctor(stage)
    self.stage_ = stage

    self.stars_ = Game.INIT_STARS
    self.bugs_ = {}
    self.bugsSprite_ = {}
    self.deadCount_ = 0

--    cc(self):addComponent("components.behavior.EventProtocol"):exportMethods()
end

function Game:getStars()
    return self.stars_
end

function Game:getDeadCount()
    return self.deadCount_
end

function Game:addBug()
    local bug
    if math.random(1, 2) % 2 == 0 then
        bug = BugAnt.new()
    else
        bug = BugSpider.new()
    end
    bug:setInitPosition(Game.HOLE_POSITION)

    self.bugs_[#self.bugs_ + 1] = bug

    local sprite = display.newSprite(bug:getSpriteName());
    sprite:setPosition(bug:getPosition())
    sprite:setRotation(bug:getRotation())
   self.stage_:addChild(sprite) 

    self.bugsSprite_[#self.bugsSprite_ + 1] = sprite
end

function Game:bugEnterHole_(index)
 

    local bug = self.bugs_[index]
    local sprite = self.bugsSprite_[index]

 
    local action = cc.Sequence:create( cc.FadeIn:create(0.5),
                                        cc.CallFunc:create(function()
       print("============");
       sprite:removeFromParent(true);
                                        end ) )                                      
    sprite:runAction(action);

    table.remove(self.bugs_, index)
    table.remove(self.bugsSprite_, index)

    self.stars_ = self.stars_ - 1
    --  self:dispatchEvent({name = Game.BUG_ENTER_HOLE_EVENT})
    PushCenter.pushEvent("BUG_ENTER_HOLE_EVENT");
    audio.playSound("sfx/bug_enter.wav")

    if self.stars_ <= 0 then
    self:playerDead_()
    end
end

function Game:playerDead_()
   -- self:dispatchEvent({name = Game.PLAYER_DEAD_EVENT})
        PushCenter.pushEvent("PLAYER_DEAD_EVENT");
    audio.playSound("sfx/player_dead.wav")
end

function Game:step()
    if self.stars_ <= 0 then return end

    for i = #self.bugs_, 1, -1 do
        local bug = self.bugs_[i]
        bug:step()

        local sprite = self.bugsSprite_[i]
        sprite:setPosition(bug:getPosition())

        if bug:getDist() <= 0 then
            self:bugEnterHole_(i)
        end
    end
end

function Game:bugDead_(index)
    local bug = self.bugs_[index]
    local sprite = display.newSprite(bug:getDeadSpriteName());
    sprite:setPosition(bug:getPosition())
    sprite:rotation(math.random(0, 360))
    self.stage_:addTo(sprite)
        

 
         
    local action = c.Sequence:create( cc.FadeIn(0.5),
                                        cc.DelayTime:create(2.0),
                                        cc.CallFunc:create(function( )

                                            self.bugsSprite_[index]:removeSelf()
                                            table.remove(self.bugs_, index)
                                            table.remove(self.bugsSprite_, index)

                                            self.deadCount_ = self.deadCount_ + 1
                                            audio.playSound("sfx/bug_dead.wav")
                                        end ) )                                      
    sprite:runAction(action);



end
 
function Game:onTouch(event)
    if self.stars_ <= 0 then return end

    if event.name == "began" then
        local x, y = event.x, event.y

        for i = #self.bugs_, 1, -1 do
            local bug = self.bugs_[i]
            if bug:checkTouch(x, y) then
                self:bugDead_(i)
            end
        end
    end

    return false
end

return Game