Unity3D開發入門教程（四）——用Lua實現元件

五邑隱俠，本名關健昌，12年遊戲生涯。 本教程以 Unity 3D + VS Code + C# + tolua 為例。

 

一、Lua元件基類

1、在 Assets/Lua 目錄下新建com目錄用於存放Lua元件

2、在Assets/Lua/com 目錄新建Component.lua檔案，新增Lua元件基類Component，實現Unity3D元件的生命週期

Assets/Lua/com/Component.lua

---@class Component @Component class
local Component = {}

--- Awake
function Component:Awake()
end

--- OnEnable
function Component:OnEnable()
end

--- Start
function Component:Start()
end

--- Update
function Component:Update()
end

--- FixedUpdate
function Component:FixedUpdate()
end

--- LateUpdate
function Component:LateUpdate()
end

--- OnGUI
function Component:OnGUI()
end

--- OnDisable
function Component:OnDisable()
end

--- OnDestroy
function Component:OnDestroy()
end

--- ExtendComponent
---@return Component
function ExtendComponent()
    return CreateComponent(Component)
end

--- CreateComponent
---@param componentClass Component
---@return Component
function CreateComponent(componentClass)
    local o = {}
    
    for k, v in pairs(componentClass) do
        o[k] = v
    end

    return o
end

local com = {
    ExtendComponent = ExtendComponent,
    CreateComponent = CreateComponent,
}

return com

3、基類 Component 只是實現了空的生命週期方法，子類只需要實現所需的生命週期方法，子類沒有實現的生命週期方法會有預設的空實現。

4、由於通過C#呼叫Lua的方法時，以元表方式繼承的方法會報空。這裡通過拷貝key方式繼承基類，呼叫com.ExtendComponent（）方法返回一個繼承Component的子類table。

5、子類通過 com.CreateComponent 方法建立物件。

6、下面給出一個簡單的樣例元件 TestComponent

Assets/Lua/com/TestComponent.lua

local com = require("Assets.Lua.com.Component")

---@class TestComponent @TestComponent class
TestComponent = com.ExtendComponent()

function TestComponent.new(paramList)
    local o = com.CreateComponent(TestComponent)

    -- member fields
    o.num = paramList[0] -- Array by C#, index begin from 0
    return o
end

function TestComponent:Awake()
    print(self.num)
    print("TestComponent:Awake")
end

function TestComponent:Start()
    print("TestComponent:Start")
end

function TestComponent:OnDestroy()
    print("TestComponent:OnDestroy")
end

注意：

1） 這裡 TestComponent 是全域性的變數，因為C#直接訪問的是全域性變數，區域性變數無法直接訪問。

2）C#傳過來的陣列引數 paramList，下標從0開始

 

二、通用C#元件指令碼

using UnityEngine;
using LuaInterface;

public class LuaComponent : MonoBehaviour
{
    public string luaClassName = "";
    public string[] paramList = null;

    private LuaState luaState = null;
    private LuaTable luaObj = null;

    void Awake()
    {
        LuaClient luaClient = LuaClient.Instance;
        this.luaState = luaClient.GetLooper().luaState;
        this.luaState.DoFile(this.luaClassName + ".lua");
        this.luaObj = callLuaNew();

        callLuaFunc("Awake");
    }

    void OnEnable()
    {
        callLuaFunc("OnEnable");
    }

    // Start is called before the first frame update
    void Start()
    {
        callLuaFunc("Start");
    }

    // Update is called once per frame
    void Update()
    {
        callLuaFunc("Update");
    }

    void FixedUpdate()
    {
        callLuaFunc("FixedUpdate");
    }

    void LateUpdate()
    {
        callLuaFunc("LateUpdate");
    }

    void OnGUI()
    {
        callLuaFunc("OnGUI");
    }

    void OnDisable()
    {
        if (LuaClient.Instance != null)
        {
            callLuaFunc("OnDisable");
        }
    }

    void OnDestroy()
    {
        if (LuaClient.Instance != null)
        {
            callLuaFunc("OnDestroy");
        }

        this.luaState = null;
        this.luaObj = null;
    }

    public LuaTable callLuaNew()
    {
        LuaFunction luaFunc = luaState.GetFunction(this.luaClassName + "." + "new");
        luaFunc.BeginPCall();
        luaFunc.Push(this.paramList);
        luaFunc.PCall();
        LuaTable table = luaFunc.CheckLuaTable();
        luaFunc.EndPCall();
        luaFunc.Dispose();
        luaFunc = null;
        return table;
    }

    private void callLuaFunc(string funcName)
    {
        LuaFunction luaFunc = luaState.GetFunction(this.luaClassName + "." + funcName);
        luaFunc.BeginPCall();
        luaFunc.Push(this.luaObj);
        luaFunc.PCall();
        luaFunc.EndPCall();
        luaFunc.Dispose();
        luaFunc = null;
    }
}

 

1、這個元件給 Unity3D暴露兩個欄位：luaClassName、paramList。可以在Unity3D中設定Lua類名、初始化引數列表（引數個數可在Unity3D調整）

2、在 Awake 生命週期載入跟 luaClassName 同名的 .lua 檔案，呼叫 Lua的 luaClassName 類的 new 方法，把 paramList 當作引數傳過去，得到 Lua物件。

3、其他生命週期方法都是呼叫 Lua 類的同名方法，從而可以在 Lua 實現具體的生命週期邏輯。

 

三、新增 Lua 元件搜尋路徑

為了讓 Lua虛擬機器知道元件的路徑，在Main.cs重寫父類的 Awake 生命週期方法，新增搜尋路徑 Lua/com

Assets/CSharp/Main.cs

new void Awake()
{
    base.Awake();

    // search path
    string fullPath = Application.dataPath + "/Lua/com";
    luaState.AddSearchPath(fullPath);
}

 

四、測試效果

1、在GameObject選單，選擇Create Empty，新增一個空GameObject

2、在屬性皮膚給這個空GameObject新增Lua Component元件，設定 Lua Class Name 為 TestComponent，下標0的引數為 12

3、執行效果日誌