xLua学习笔记(一) 加载Lua代码

xLua的安装

首先从xLua的Github主页上下载资源包

https://github.com/Tencent/xLua

解压下载好的压缩包,将压缩包中Assets文件夹下的内容复制到Unity工程的Assets文件夹下即可

Assets文件夹

字符串加载

通过字符加载Lua代码的方式如下

using UnityEngine;
using XLua;

public class XLuaLoad : MonoBehaviour 
{

    private LuaEnv luaenv;

    void Start () 
    {
        luaenv = new LuaEnv();
        object[] returns = luaenv.DoString
            (
                @"
                print('load lua by string.')
                return 1, 'hello'
                 "
            );
        Debug.Log("return value: " + returns[0] + " " + returns[1]);
    }
    
    void Update () 
    {
        if (luaenv != null)
        {
            luaenv.Tick();
        }
    }

    void Destroy()
    {
        if (luaenv != null)
        {
            luaenv.Dispose();
        }
    }
}

将脚本挂载到任何一个游戏物体上,执行程序,可以得到

这里使用到了LuaEnv对象的DoString方法,该方法的定义如下

object[] DoString(string chunk, string chunkName = "chuck", LuaTable env = null)
  • 描述:

    执行一个代码块。

  • 参数:

参数 说明
chunk Lua代码字符串
chunkName 发生error时的debug显示信息中使用,指明某某代码块的某行错误
env 这个代码块
  • 返回值:

代码块里return语句的返回值

上面的代码中我们执行了

        object[] returns = luaenv.DoString
            (
                @"
                print('load lua by string.')
                return 1, 'hello'
                 "
            );

DoString返回将包含两个object, 一个是double类型的1, 一个是string类型的“hello”

加载Lua文件

新建一个lua文件,命名为my_script.lua,并向文件中写入下列测试代码

接下来将my_script.lua文件放到Resources文件夹下,修改my_script.lua文件的后缀名txt

然后通过以下方式加载my_script.lua文件中的Lua代码

using UnityEngine;
using XLua;

public class XLuaLoad : MonoBehaviour 
{
    private LuaEnv luaenv;

    void Start () 
    {
        luaenv = new LuaEnv();
        luaenv.DoString
            (
                @"
                require 'my_script'
                 "
            );     
    }
    
    void Update () 
    {
        if (luaenv != null)
        {
            luaenv.Tick();
        }
    }

    void Destroy()
    {
        if (luaenv != null)
        {
            luaenv.Dispose();
        }
    }
}

仍然是调用LuaEnv对象的DoString方法,不过这里通过使用Lua的全局函数require函数来加载其它的文件,在加载的时候会使用默认的Loader去加载文件

将脚本挂载到任何一个游戏物体上,执行程序,可以得到

使用上述方法加载Lua代码时需要注意:

  1. Lua代码文件的文件名必须是XXX.lua.txt的格式,通过require引入的文件的时候只需要传入XXX
  2. Lua代码文件必须放在Resources文件夹下,不能放在Resources下的某个文件夹里

如果没有注意以上两点,运行的时候就会抛出异常,提示找不到文件

如果想要把Lua代码文件放在任意文件夹下的话,就需要使用AddLoader方法添加自定义的Loader

void AddLoader(CustomLoader loader)
  • 描述
    增加一个自定义loader

  • 参数:

参数 说明
loader 类型为delegate byte[] CustomLoader(ref string filepath),当一个文件被require时,这个loader会被回调其参数是require的参数,如果该loader找到文件,可以将其读进内存,返回一个byte数组。如果需要支持调试的话,而filepath要设置成IDE能找到的路径(相对或者绝对都可以)

需要注意的是,require的参数是什么,loader在回调的时候filepath就会被设置为什么

只需要对上面的代码进行略微修改即可

using UnityEngine;
using XLua;

public class XLuaLoad : MonoBehaviour 
{
    private LuaEnv luaenv;

    void Start () 
    {
        luaenv = new LuaEnv();
        luaenv.AddLoader(LuaLoader);
        luaenv.DoString
            (
                @"
                require 'lua/my_script'
                 "
            );     
    }

    private byte[] LuaLoader(ref string filepath)
    {
        TextAsset script = Resources.Load("lua/" + filepath + ".lua") as TextAsset;
        return script.bytes;
    }
    
    void Update () 
    {
        if (luaenv != null)
        {
            luaenv.Tick();
        }
    }

    void Destroy()
    {
        if (luaenv != null)
        {
            luaenv.Dispose();
        }
    }
}

在LuaLoader中可以使用任何方式来加载Lua代码,只要最后返回代码字符的byte数组即可

可以向LuaEnv中添加若干个Loader,在require的时候会依次调用每一个Loader,直到有一个Loader成功为止,如果全部失败则会抛出异常,提示找不到文件

建议的加载Lua脚本方式是:整个程序就一个DoString("require 'main'"),然后在main.lua加载其它脚本(类似lua脚本的命令行执行:lua main.lua)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容

  • 指令集 lua_capture_error_log lua_use_default_type lua_malloc...
    吃瓜的东阅读 11,979评论 0 2
  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,147评论 7 35
  • 猛地想一股脑扎进池水 忘却一切 那个我 在哪?
    二叔Sltsun阅读 280评论 0 4
  • 在我遇到的男生中,带我吃喝玩乐的人有很多,在我生病时嘘寒问暖的也有很多,唯独只有你是把药买来亲手送给我,并叮嘱我要...
    记录生活点点滴滴阅读 252评论 0 0
  • 这几天网上充斥着对乐嘉带4岁女儿徒步76公里沙漠的评论,不禁让我想起另一件类似的我刚亲历的事情。月初带米去某名山大...
    Friz阅读 306评论 0 0