uLua學習筆記（一）：uLua安裝及上手

uLua下載：http://www.ulua.org/

VS2012/2013的用於編寫Lua的插件：https://babelua.codeplex.com/或http://unknownworlds.com/decoda/

 

在下載了uLua_vX.XX.zip后解壓得到一個XXX.unitypackage文件，將該文件導入到我們的工程中即可使用uLua了。

 

我們先來一個最簡單的示例：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaTest : MonoBehaviour
{
    void Start ()
    {
        LuaState luaState = new LuaState();
        luaState.DoString("print('hello world 世界')");
    }
}

將該腳本綁定到場景中的一個GameObject之上就可以看到效果了。

 

下面我們看一個加載外部lua文件的例子：

我們新建一個Resources目錄，在目錄里創建一個名為Test.lua.txt的文件，輸入lua代碼：

print("This is a script from a file 世界")

保存為UTF-8格式，注意Unity的TextAsset不支持lua的后綴名，所以后綴名要修改為txt。

修改上面的示例為下面的代碼即可：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaLoadFileTest : MonoBehaviour
{
    void Start ()
    {
        TextAsset luaString = Resources.Load<TextAsset>("Test.lua");

        LuaState luaState = new LuaState();
        luaState.DoString(luaString.text);
    }
}

注意Load的文件是不帶后綴名的。

 

下面的例子使用uLua創建一個GameObject：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaTest : MonoBehaviour
{
    private string lua = @"
            --加載模塊
            luanet.load_assembly('UnityEngine')
            luanet.load_assembly('Assembly-CSharp')

            --導入 Unity3D 的類
            Util = luanet.import_type('Util')
            GameObject = luanet.import_type('UnityEngine.GameObject')

            --創建一個新的 GameObject 對象
            local newGameObj = GameObject('NewObj')
            --添加粒子組件
            Util.AddComponent(newGameObj, 'UnityEngine', 'ParticleSystem')
        ";

    void Start ()
    {
        LuaState luaState = new LuaState();
        LuaScriptMgr._translator = luaState.GetTranslator();
        luaState.DoString(lua);
    }
}

 

下面的例子是設置和獲取Lua中的變量：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaTest : MonoBehaviour
{
    private string lua = @"
            --加載模塊
            luanet.load_assembly('UnityEngine')
            luanet.load_assembly('Assembly-CSharp')

            --導入 Unity3D 的類
            Util = luanet.import_type('Util')
            GameObject = luanet.import_type('UnityEngine.GameObject')

            --創建表
            particles = {}

            --循環
            for i = 1, Objs2Spawn, 1 do
                --創建 GameObject 對象
                local newGameObj = GameObject('NewObj' .. tostring(i))
                --添加組件
                local ps = Util.AddComponent(newGameObj, 'UnityEngine', 'ParticleSystem')
                --暫停粒子播放
                ps:Stop()

                --加入表
                table.insert(particles, ps)
            end

            --定義一個數據
            var2read = 42
        ";

    void Start ()
    {
        LuaState luaState = new LuaState();
        LuaScriptMgr._translator = luaState.GetTranslator();

        //賦值 Lua 中的數據
        luaState["Objs2Spawn"] = 5;

        luaState.DoString(lua);

        //讀取 Lua 中的數據
        print("Read from lua: " + luaState["var2read"].ToString());

        //獲取 LuaTable 對象
        LuaTable particles = (LuaTable)luaState["particles"];

        //遍歷播放粒子
        foreach(ParticleSystem ps in particles.Values)
        {
            ps.Play();
        }
    }
}

 

下面看看Unity如何調用uLua中的函數：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaTest : MonoBehaviour
{
    private string lua = @"
            --定義一個函數
            function luaFunc(message)
                print(message)
                return 42
            end
        ";

    void Start ()
    {
        LuaState luaState = new LuaState();
        LuaScriptMgr._translator = luaState.GetTranslator();
        
        //運行腳本確保函數已經創建
        luaState.DoString(lua);

        //獲取函數
        LuaFunction func = luaState.GetFunction("luaFunc");

        //調用函數
        object[] result = func.Call("I called a lua function!");

        //獲取結果
        print(result[0]);
    }
}

 

下面我們看看lua和U3D之間是如何相互傳遞數組：

using UnityEngine;
using System.Collections;
using LuaInterface;
using System;

public class LuaTest : MonoBehaviour
{
    private string lua = @"
        --定義一個函數
        function luaFunc(objs, len)
            for i = 0, len - 1 do
                print(objs[i])
            end
            --返回一個列表
            local table1 = {'111', '222', '333'}
            return table1
        end
    ";

    string[] objs = { "aaa", "bbb", "ccc" };

    void Start ()
    {
        LuaScriptMgr luaMgr = new LuaScriptMgr();
        LuaState luaState = luaMgr.lua;
        luaState.DoString(lua);

        //調用lua的函數獲取返回值
        LuaFunction f = luaState.GetFunction("luaFunc");
        object[] rs = f.Call(objs, objs.Length);

        //輸出lua的返回值
        LuaTable table = rs[0] as LuaTable;
        foreach (DictionaryEntry de in table)
        {
            Debug.Log(de.Value);
        }
    }
}

 

接下來我們看看Lua里的協程：

using UnityEngine;
using System.Collections;
using LuaInterface;

public class LuaCoroutines : MonoBehaviour {

    private string script = @"
            --導入程序集
            luanet.load_assembly('UnityEngine')
            --導入類型
            local Time = luanet.import_type('UnityEngine.Time')

            --使運行暫停指定的時間, 每幀調用
            function waitSeconds(t)
                --獲得結束時間
                local timeStamp = Time.time + t
                --時間沒到就 yield 中斷
                while Time.time < timeStamp do
                    coroutine.yield()
                end
            end

            --外部調用的方法
            function myFunc()
                print('Coroutine started')
                local i = 0
                for i = 0, 10, 1 do
                    print(i)
                    waitSeconds(1)
                end
                print('Coroutine ended')
            end
        ";

    private LuaThread co = null;

    void Start () {
        LuaState l = new LuaState();
        LuaScriptMgr._translator = l.GetTranslator();

        //創建函數
        l.DoString(script);

        //獲取函數
        LuaFunction f = l.GetFunction("myFunc");

        //創建協同程序
        co = new LuaThread(l, f);

        //啟動協同程序
        co.Start();
    }
    
    void Update () {
        if( !co.IsDead() )
        {
            //協同程序需要每幀進行調用
            co.Resume();
        }
        else
        {
            print("Coroutine has exited.");

            //清除協同程序
            co = null;
        }
    }
}