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閱讀 227,797評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,179評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,628評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,642評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,444評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,948評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,040評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,185評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,717評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,794評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,418評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,414評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,750評論 2 370

推薦閱讀更多精彩內容

  • 指令集 lua_capture_error_log lua_use_default_type lua_malloc...
    吃瓜的東閱讀 12,054評論 0 2
  • 無意中看到zhangwnag大佬分享的webpack教程感覺受益匪淺,特此分享以備自己日后查看,也希望更多的人看到...
    小小字符閱讀 8,206評論 7 35
  • 猛地想一股腦扎進池水 忘卻一切 那個我 在哪?
    二叔Sltsun閱讀 283評論 0 4
  • 在我遇到的男生中,帶我吃喝玩樂的人有很多,在我生病時噓寒問暖的也有很多,唯獨只有你是把藥買來親手送給我,并叮囑我要...
    記錄生活點點滴滴閱讀 257評論 0 0
  • 這幾天網上充斥著對樂嘉帶4歲女兒徒步76公里沙漠的評論,不禁讓我想起另一件類似的我剛親歷的事情。月初帶米去某名山大...
    Friz閱讀 311評論 0 0