Unity XLua 官方案例學習

1. Helloworld

using UnityEngine;
using XLua;

public class Helloworld : MonoBehaviour {
    // Use this for initialization
    void Start () {
        LuaEnv luaenv = new LuaEnv();
        // 執行代碼塊，輸出 hello world
        luaenv.DoString("CS.UnityEngine.Debug.Log('hello world')");
        // 釋放資源
        luaenv.Dispose();
    }
}

 

 

　　該案例實現了在 Unity 控制台輸出 hello world。

 

2. U3DScripting

　　

　　

 

　　lua 代碼如下：

local speed = 10
local lightCpnt = nil

function start()
    print("lua start...")
    -- 訪問環境變量
    print("injected object", lightObject)
    -- 查找 Light 組件
    lightCpnt= lightObject:GetComponent(typeof(CS.UnityEngine.Light))
end

function update()
    local r = CS.UnityEngine.Vector3.up * CS.UnityEngine.Time.deltaTime * speed
    -- 繞y軸旋轉
    self.transform:Rotate(r)
    -- 修改光線顏色
    lightCpnt.color = CS.UnityEngine.Color(CS.UnityEngine.Mathf.Sin(CS.UnityEngine.Time.time) / 2 + 0.5, 0, 0, 1)
end

function ondestroy()
    print("lua destroy")
end

　　注意，如果要插入中文注釋，需要將 txt 編碼格式改為 UTF-8，否則無法執行。

 　　C# 代碼如下：

using UnityEngine;
using XLua;
using System;

[System.Serializable]
public class Injection
{
    public string name;
    public GameObject value;
}

[LuaCallCSharp]
public class LuaBehaviour : MonoBehaviour {
    public TextAsset luaScript;             // lua腳本文件
    public Injection[] injections;          // 需要注入到環境變量的物體

    internal static LuaEnv luaEnv = new LuaEnv(); //all lua behaviour shared one luaenv only!
    internal static float lastGCTime = 0;
    internal const float GCInterval = 1;//1 second 

    private Action luaStart;
    private Action luaUpdate;
    private Action luaOnDestroy;

    private LuaTable scriptEnv;

    void Awake()
    {
        scriptEnv = luaEnv.NewTable();

        LuaTable meta = luaEnv.NewTable();
        meta.Set("__index", luaEnv.Global);
        scriptEnv.SetMetaTable(meta);
        meta.Dispose();

        // 配置環境變量，在lua代碼里能直接調用
        scriptEnv.Set("self", this);
        foreach (var injection in injections)
        {
            scriptEnv.Set(injection.name, injection.value);
        }
        // 參數1：Lua代碼的字符串
        // 參數2：發生error時的debug顯示信息時使用
        // 參數3：代碼塊的環境變量
        luaEnv.DoString(luaScript.text, "LuaBehaviour", scriptEnv);

        // 訪問函數
        Action luaAwake = scriptEnv.Get<Action>("awake");
        scriptEnv.Get("start", out luaStart);
        scriptEnv.Get("update", out luaUpdate);
        scriptEnv.Get("ondestroy", out luaOnDestroy);

        // 執行事件
        if (luaAwake != null)
        {
            luaAwake();
        }
    }

    // Use this for initialization
    void Start ()
    {
        if (luaStart != null)
        {
            luaStart();
        }
    }
    
    // Update is called once per frame
    void Update ()
    {
        if (luaUpdate != null)
        {
            luaUpdate();
        }
        if (Time.time - LuaBehaviour.lastGCTime > GCInterval)
        {
            // 清楚lua未手動釋放的LuaBase對象，需定期調用，這里是1s調用一次
            luaEnv.Tick();
            LuaBehaviour.lastGCTime = Time.time;
        }
    }

    void OnDestroy()
    {
        if (luaOnDestroy != null)
        {
            luaOnDestroy();
        }
        luaOnDestroy = null;
        luaUpdate = null;
        luaStart = null;
        scriptEnv.Dispose();
        injections = null;
    }
}

　　該場景實現了 lua 代碼控制 U3D 物體，以實現物體的旋轉和顏色變化。

 

三、UIEvent

 　　

　　

　　lua 代碼如下：

function start()
    print("lua start...")
    -- 給button添加事件
    -- 點擊輸出 input 輸入內容
    self:GetComponent("Button").onClick:AddListener(function()
        print("clicked, you input is '" ..input:GetComponent("InputField").text .."'")
    end)
end

　　該場景實現了 lua 代碼為 button 添加事件響應函數，以實現點擊按鈕輸出輸入框內容。

　　注意，lua 中 . 和 : 的區別：

• •  定義的時候：Class:test() 與 Class.test(self) 是等價的
  •  調用的時候：object:test() 與 object.test(object) 等價

 　　在這里，調用類的方法使用 :，調用屬性用 . 。

 

　　C# 代碼還是上一場景的 LuaBehaviour.cs。

 

 四、InvokeLua

 　　C# 代碼如下：

using UnityEngine;
using XLua;

public class InvokeLua : MonoBehaviour
{
    [CSharpCallLua]
    public interface ICalc
    {
        int Add(int a, int b);
        int Mult { get; set; }
    }

    [CSharpCallLua]
    public delegate ICalc CalcNew(int mult, params string[] args);

    private string script = @"
                local calc_mt = {
                    __index = {
                        Add = function(self, a, b)
                            return (a + b) * self.Mult
                        end
                    }
                }

                Calc = {
                    -- 多參數函數
                    New = function (mult, ...)
                        print(...)
                        return setmetatable({Mult = mult}, calc_mt)
                    end
                }
            ";
    // Use this for initialization
    void Start()
    {
        LuaEnv luaenv = new LuaEnv();
        Test(luaenv);//調用了帶可變參數的delegate，函數結束都不會釋放delegate，即使置空並調用GC
        luaenv.Dispose();
    }

    void Test(LuaEnv luaenv)
    {
        luaenv.DoString(script);
        // 訪問 lua 函數
        CalcNew calc_new = luaenv.Global.GetInPath<CalcNew>("Calc.New");
        ICalc calc = calc_new(10, "hi", "john"); //constructor
        Debug.Log("sum(*10) =" + calc.Add(1, 2));   // (1+2)*10
        calc.Mult = 100;
        Debug.Log("sum(*100)=" + calc.Add(1, 2));   // (1+2)*100
    }
}

 

 　　該場景實現了 C# 調用 lua 代碼的函數，table。注意要加上  [CSharpCallLua] 。

 

 五、NoGc

 　　看不懂。

 

 六、Coroutine

 　　總共有四個代碼文件，關鍵代碼如下。

　　1. CoroutineTest.cs

LuaEnv luaenv = null;
// Use this for initialization
void Start()
{
    luaenv = new LuaEnv();
    // 執行 coruntine_test
    luaenv.DoString("require 'coruntine_test'");
}

　　2. coruntine_test.lua

local util = require 'xlua.util'

local yield_return = (require 'cs_coroutine').yield_return

local co = coroutine.create(function()
    print('coroutine start!')
    local s = os.time()
    -- 協程等待3秒
    yield_return(CS.UnityEngine.WaitForSeconds(3))
    print('wait interval:', os.time() - s)
    
    local www = CS.UnityEngine.WWW('http://www.cnblogs.com/coderJiebao/p/unity3d22.html')
    -- 協程加載網頁
    yield_return(www)
    if not www.error then
        print(www.bytes)
    else
        print('error:', www.error)
    end
end)

assert(coroutine.resume(co))

　　3. cs_coroutine.lua

local util = require 'xlua.util'

-- 新建物體
local gameobject = CS.UnityEngine.GameObject('Coroutine_Runner')
-- 設置不自動銷毀
CS.UnityEngine.Object.DontDestroyOnLoad(gameobject)
-- 添加組件
local cs_coroutine_runner = gameobject:AddComponent(typeof(CS.Coroutine_Runner))

local function async_yield_return(to_yield, cb)
    cs_coroutine_runner:YieldAndCallback(to_yield, cb)        -- 調用 C# 函數
end

return {
    yield_return = util.async_to_sync(async_yield_return)
}

　　4. Coroutine_Runner.cs

[LuaCallCSharp]
public class Coroutine_Runner : MonoBehaviour
{
    public void YieldAndCallback(object to_yield, Action callback)
    {
        // 開啟協程，回調callback
        StartCoroutine(CoBody(to_yield, callback));
    }

    private IEnumerator CoBody(object to_yield, Action callback)
    {
        if (to_yield is IEnumerator)
            yield return StartCoroutine((IEnumerator)to_yield);
        else
            yield return to_yield;
        callback();
    }
}

　　該場景實現了協程等待3s和加載網頁的功能。

　　調用流程為：CoroutineTest.Start -> coruntine_test（創建協程，調用 yield_return 方法）-> cs+coroutine.async_yield_return -> Coroutine_Runner.YieldAndCallback。

 

七、AsyncTest

　　繼續看不懂，后期補上。

 

八、Hotfix

1. 使用方式

　　(1) 在 github 上下載 xlua 源碼后，將 Asserts 文件夾內的文件以及 Tools 文件夾直接拖到工程，這時候會報錯，刪除 Tools 文件夾下的 System.dll 和 System.core.dll 即可。

　　(2) 添加 HOTFIX_ENABLE 和 INJECT_WITHOUT_TOOL 兩個宏（在 File->Build Setting->Player Setting->Scripting Define Symbols）　

　　(3) 執行XLua/Generate Code菜單

　　(4) 編寫代碼，注意在需要熱更新的地方添加[Hotfix]標簽

　　(5) 注入，構建手機包這個步驟會在構建時自動進行，編輯器下開發補丁需要手動執行"XLua/Hotfix Inject In Editor"菜單。注入成功會打印“hotfix inject finish!”或者“had injected!”。 　　　

 

2. 常用函數

xlua.hotfix(class, [method_name], fix)

•  描述 ： 注入lua補丁
•  class ： C#類，兩種表示方法，CS.Namespace.TypeName或者字符串方式"Namespace.TypeName"，字符串格式和C#的Type.GetType要求一致，如果是內嵌類型（Nested Type）是非Public類型的話，只能用字符串方式表示"Namespace.TypeName+NestedTypeName"；
•  method_name ： 方法名，可選；
•  fix ： 如果傳了method_name，fix將會是一個function，否則通過table提供一組函數。table的組織按key是method_name，value是function的方式。

 

xlua.private_accessible(class)

•  描述 ： 讓一個類的私有字段，屬性，方法等可用
•  class ： 同xlua.hotfix的class參數

util.hotfix_ex(class, method_name, fix)

•  描述 ： xlua.hotfix的增強版本，可以在fix函數里頭執行原來的函數，缺點是fix的執行會略慢。
•  method_name ： 方法名；
•  fix ： 用來替換C#方法的lua function。

 

 

base(csobj)

 

•  描述：子類 override 函數通過 base 調用父類實現
•  csobj：對象
•  返回值：新對象

 

 

3. 打補丁

　　xlua 可以用 lua 函數替換 C# 的構造函數，函數，屬性，事件的替換。

　　（1） 函數

　　可以指定一個函數，也可以傳遞由多個函數組成的 table。

-- 注入lua補丁，替換HotfixCalc.Add
xlua.hotfix(CS.HotfixCalc, 'Add', function(self, a, b)
    -- 原來為 a-b
    return a + b
end)

 

-- 通過table提供一組函數
-- table的組織按key是methodname,value是function的方式
xlua.hotfix(CS.HotfixCalc, {
        Test1 = function(self)
        print('Test1', self)
        return 1
        end;
        Test2 = function(self, a, b)
            print('Test2', self, a, b)
            return a + 10, 1024, b
        end;
        -- static 函數不需要加self
        Test3 = function(a)
        print(a)
        return 10
        end;
        Test4 = function(a)
        print(a)
        end;
        -- 多參數
        Test5 = function(self, a, ...)
        print('Test4', self, a, ...)
        end
})

 

　　（2） 構造函數

　　構造函數對應的 method_name 是 ".ctor"，和普通函數不一樣的是，構造函數的熱補丁並不是替換，而是執行原有邏輯后調用 lua。

-- 構造函數
['.ctor'] = function(csobj)
    return {evt = {}, start = 0}
end;

 

 

　　（3） 屬性

　　每一個屬性都對應一個get,set函數。

-- 屬性AProp的賦值和取值
set_AProp = function(self, v)
    print('set_AProp', v)
    self.AProp = v
end;
get_AProp = function(self)
    return self.AProp
end;

 

 

　　（4） [] 操作符

　　賦值對應 set_Item，取值對應 set_Item。

-- []操作符，賦值和取值
get_Item = function(self, k)
    print('get_Item', k)
    return 1024
end;
set_Item = function(self, k, v)
    print('set_Item', k, v)
end;

 

　　對於其他操作符，C#的操作符都有一套內部表示，比如+號的操作符函數名是op_Addition。

 

　　（5） 事件

　　+= 操作符是 add_...，-= 操作符是 remove_... ，函數第一個參數是自身，第二個參數是操作符右邊的 delegate。

-- 事件AEvent +=
add_AEvent = function(self, cb)
    print('add_AEvent', cb)
    table.insert(self.evt, cb)
end;
-- 事件AEvent -=
remove_AEvent = function(self, cb)
    print('remove_AEvent', cb)
    for i, v in ipairs(self.evt) do
        if v == cb then
            table.remove(self.evt, i)
            break
        end
    end
end;

 

 

　　（6） 析構函數

　　函數名是 Finalize，傳一個 self 參數。和普通函數不一樣的是，析構函數的熱補丁並不是替換，而是開頭調用 lua 函數后繼續原有邏輯。

-- 析構函數
Finalize = function(self)
    print('Finalize', self)
end

 

 

　　（7） 泛化類型

　　每個泛化類型都是一個獨立的類型，需要對實例化后的類型分別打補丁。

xlua.hotfix(CS['GenericClass`1[System.Double]'], {
    ['.ctor'] = function(obj, a)
        print('GenericClass<double>', obj, a)
    end;
    Func1 = function(obj)
        print('GenericClass<double>.Func1', obj)
    end;
    Func2 = function(obj)
        print('GenericClass<double>.Func2', obj)
        return 1314
    end
})

 

 

　　（8） 子類調用父類

-- 子類調用父類的方法
xlua.hotfix(CS.BaseTest, 'Foo', function(self, p)
        print('BaseTest', p)
        base(self):Foo(p)
    end)
xlua.hotfix(CS.BaseTest, 'ToString', function(self)
        return '>>>' .. base(self):ToString()
    end)