Unity3D开发入门教程（四）——用Lua实现组件

五邑隐侠，本名关健昌，12年游戏生涯。 本教程以 Unity 3D + VS Code + C# + xlua 为例。

 

一、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、运行效果日志