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;
        }
    }
}