xLua笔记（2）—Unity对象的MonoBehaviour Lua脚本

最新推荐文章于 2022-09-10 14:48:38 发布
最新推荐文章于 2022-09-10 14:48:38 发布
阅读量1.9k 收藏 6
点赞数 3
分类专栏： 技术开发 Unity项目开发 文章标签： lua unity
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/JoeyHuangzx/article/details/105214096
版权

我们通常用继承了monobehaivor的C#脚本来开发游戏，本节我尝试用lua脚本来制作这样这个脚本，在lua侧来开发实现业务逻辑。

1、根据unity对象的生命周期，我们定义常见的几个MonoBehaivor的函数，我们先创建一个lua脚本，包含了这里面的几个通用函数。
LuaMonoBehaviour.lua文件，目录在Assets\LuaScripts\Common下

function Awake()
    print("this is Awake function",self.gameObject.name)
end
function OnEnable()
     print("this is OnEnable function")
end

function Start()
    print("this is Start function")
end

function Update()
    print("this is Update function")
end

function OnDestroy()
    print("this is OnDestroy function")
end

2、然后我们还要在C#端定义一个XLuaMonoBehaviour.cs类

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;

public class XLuaMonoBehaviour : MonoBehaviour
{
    private void Awake(){}
    private void OnEnable(){}
    void Start() {}
    void Update(){}
    private void OnDestroy(){}
}

3、我们需要将C#类和lua脚本通过某一种方式建立一种联系，可以说是委托吧（下面讲到）。使得当我们在unity对象上挂在了XLuaMonoBehaviour.cs 类的时候，同样的调用到了LuaMonoBehaviour.lua脚本，并执行了其相对应的方法
在这里插入图片描述
4、然后我们需要在C#端定义一些桥接脚本，用来连接彼此之间相对应的方法。（在xlua官方教程中有个写好的LuaBehaviour.cs可以参考，我搬运过来稍微修改了下）

  • 初始化LuaEnv时，设置LuaEnv.Global给__index
  • 创建新的LuaTable来给lua脚本
  • 加载读取lua文件

首先我们需要用到上一篇文章（xLua笔记（1）—Lua启动类）的XLuaManager类，添加几个
方法

private void InitLuaEnv()
    {
        luaEnv = new LuaEnv();
        if (luaEnv != null)
        {
            luaEnv.AddLoader(CustomLoader);
            //设置__index，如果scriptEnv元表里没找到想要的值，就在__index里找
            this.meta = luaEnv.NewTable();
            meta.Set("__index", luaEnv.Global);
        }
    }

加载LuaMonoBehaviour.lua脚本的代码

public LuaTable InitMonoBehaviour(XLuaMonoBehaviour xLuaMonoBehaviour)
    {
        Debug.Log("InitMonoBehaviour");
        //新建一个表，并设置元表为上面定义的meta
        luaTable = luaEnv.NewTable();
        luaTable.SetMetaTable(meta);
        //把xLuaMonoBehaviour对象传到lua侧
        luaTable.Set("self", xLuaMonoBehaviour);
        DoString(LoadLuaScript("Common/LuaMonoBehaviour"), "LuaMonoBehaviour", luaTable);

        return luaTable;
    }
    
    /// <summary>
    /// 这里为了方便笔记，所以采用了C# IO来加载lua内容，只针对unity Editor 
    /// </summary>
    /// <param name="_filePath"></param>
    /// <returns></returns>
    private string LoadLuaScript(string _filePath)
    {
        Debug.Log("LoadLuaScript "+_filePath);
        string _scriptPath = string.Empty;
        _filePath = _filePath.Replace(".", "/") + ".lua";
        _scriptPath = Path.Combine(Application.dataPath, luaScriptsFolder);
        _scriptPath = Path.Combine(_scriptPath, _filePath);
        string str = FileManager.GetFileContent(_scriptPath);
       // Debug.Log("LuaScript " + str);
        return str;
    }

    /// <summary>
    /// 创建定义从C#到lua间的一个桥接，委托
    /// </summary>
    /// <param name="_targetName"></param>
    /// <param name="_function"></param>
    /// <returns></returns>
    public Action CallFunction(string _targetName, string _function)
    {
        return luaTable.Get<Action>(_function);
    }

我会在文章后面附上完整的XLuaManager.cs类

5、现在加载lua脚本，建立桥接关系都已经搭好了，我们还需要在XLuaMonoBehaviour.cs 里创建委托映射，如下：

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;

public class XLuaMonoBehaviour : MonoBehaviour
{
    private LuaTable luaTable;
    private Action luaAwake;
    private Action luaStart;
    private Action luaUpdate;
    private Action luaOnEnable;
    private Action luaOnDestroy;

    private void Awake()
    {
        this.luaTable = XLuaManager.GetInstance().InitMonoBehaviour(this);
        luaAwake = CallLuaFunction("Awake");
        luaStart = CallLuaFunction("Start");
        luaUpdate = CallLuaFunction("Update");
        luaOnEnable = CallLuaFunction("OnEnable");
        luaOnDestroy = CallLuaFunction("OnDestroy");
        luaAwake?.Invoke();
    }

    private Action CallLuaFunction(string _fun)
    {
        return XLuaManager.GetInstance().CallFunction(gameObject.name, _fun);
    }

    private void OnEnable()
    {
        luaOnEnable?.Invoke();
    }

    // Start is called before the first frame update
    void Start()
    {
        luaStart?.Invoke();
    }

    // Update is called once per frame
    void Update()
    {
        luaUpdate?.Invoke();
    }

    private void OnDestroy()
    {
        luaOnDestroy?.Invoke();
        luaOnDestroy = null;
        luaStart = null;
        luaUpdate = null;
        this.luaTable.Dispose();
    }
}

6、这样，我们的功能都已经做好了，让我们来执行下吧

XLuaManager.GetInstance().StartUp();
XLuaManager.GetInstance().OnEntry();
GameObject.Find("Canvas/Button").AddComponent<XLuaMonoBehaviour>();

第一第二句主要是启动xlua的，第一章有介绍了。
第二句我在Canvas下的Button对象添加了一个XLuaMonoBehaviour.cs脚本。
执行效果如下：
在这里插入图片描述
这里打印的就是我们在lua文件里print的东西。我们可以看到执行顺序是跟C#端一样的。

后记：我是初学者，很多地方其实我也不是很懂，看了好久官方教程，还有官方的LuaBehaviour.cs类才写的了这个文章，在有些地方也说不出个所以然，只是照搬了做下笔记加深印象。如果说我有什么说的不对的地方，还望有哪位懂的大神指点下，多多纠正啊。

完整的XLuaManager.cs类发一次出来

using FileUtility;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using UnityEngine;
using XLua;

public class XLuaManager : MonoSingleton<XLuaManager>
{
    //放置LuaScripts代码的文件夹名字
    public const string luaScriptsFolder = "LuaScripts";
    //lua代码的文件名
    const string luaGameEntryScript = "LuaGameEntry";

    private LuaEnv luaEnv = null;
    private LuaTable luaTable = null;
    private LuaTable meta = null;

    // Start is called before the first frame update
    void Start()
    {

    }

    protected override void Init()
    {
        base.Init();
        InitLuaEnv();
    }

    private void InitLuaEnv()
    {
        luaEnv = new LuaEnv();
        if (luaEnv != null)
        {
            luaEnv.AddLoader(CustomLoader);
            this.meta = luaEnv.NewTable();
            meta.Set("__index", luaEnv.Global);
        }
    }

    /// <summary>
    /// 回调中可以根据这个参数去加载指定文件
    /// 如果需要支持调试，需要把filepath修改为真实路径传出。
    /// 该回调返回值是一个byte数组，如果为空表示该loader找不到，否则则为lua文件的内容
    /// </summary>
    /// <param name="_filePath"></param>
    /// <returns></returns>
    public static byte[] CustomLoader(ref string _filePath)
    {
        string _scriptPath = string.Empty;
        _filePath = _filePath.Replace(".", "/") + ".lua";
        if (Application.platform == RuntimePlatform.WindowsEditor)
        {
            _scriptPath = Path.Combine(Application.dataPath, luaScriptsFolder);
            _scriptPath = Path.Combine(_scriptPath, _filePath);
            byte[] _bytes = FileManager.SafeReadAllBytes(_scriptPath);
            return _bytes;
        }

        return null;
    }

    /// <summary>
    /// lua脚本启动入口
    /// </summary>
    public void OnEntry()
    {
        if (luaEnv != null)
        {
            loadScript(luaGameEntryScript);
            DoString("LuaGameEntry.Start()");
        }
    }

    // Update is called once per frame
    void Update()
    {

    }

    private void loadScript(string _scriptName)
    {
        DoString(string.Format("require('{0}')", _scriptName));
    }

    /// <summary>
    /// 加载lua代码块
    /// </summary>
    /// <param name="_luaScript"></param>
    public void DoString(string _luaScript,string _chunkName="chunk",LuaTable _luaTable=null)
    {
        if (luaEnv != null)
        {
            try
            {
                luaEnv.DoString(_luaScript,_chunkName,_luaTable);
            }
            catch (System.Exception ex)
            {

                Debug.Log(ex.Message);
            }
        }
    }

    public LuaEnv GetLuaEnv()
    {
        return this.luaEnv;
    }


    public LuaTable InitMonoBehaviour(XLuaMonoBehaviour xLuaMonoBehaviour)
    {
        Debug.Log("InitMonoBehaviour");
        //新建一个表，并设置元表为上面定义的meta
        luaTable = luaEnv.NewTable();
        luaTable.SetMetaTable(meta);
        //把xLuaMonoBehaviour对象传到lua侧
        luaTable.Set("self", xLuaMonoBehaviour);
        DoString(LoadLuaScript("Common/LuaMonoBehaviour"), "LuaMonoBehaviour", luaTable);

        return luaTable;
    }
    
    /// <summary>
    /// 这里为了方便笔记，所以采用了C# IO来加载lua内容，只针对unity Editor 
    /// </summary>
    /// <param name="_filePath"></param>
    /// <returns></returns>
    private string LoadLuaScript(string _filePath)
    {
        Debug.Log("LoadLuaScript "+_filePath);
        string _scriptPath = string.Empty;
        _filePath = _filePath.Replace(".", "/") + ".lua";
        _scriptPath = Path.Combine(Application.dataPath, luaScriptsFolder);
        _scriptPath = Path.Combine(_scriptPath, _filePath);
        string str = FileManager.GetFileContent(_scriptPath);
       // Debug.Log("LuaScript " + str);
        return str;
    }

    /// <summary>
    /// 创建定义从C#到lua间的一个桥接，委托
    /// </summary>
    /// <param name="_targetName"></param>
    /// <param name="_function"></param>
    /// <returns></returns>
    public Action CallFunction(string _targetName, string _function)
    {
        return luaTable.Get<Action>(_function);
    }


}
JoeyHuangzx
关注
专栏目录
腾讯XLua 01-lua来写MonoBehaviour
.Vergil 技术博客
01-12 3908
前几天腾讯开源了热更新矿建XLua，今天开始第一天的学习(每天更新)Example1.C# 与lua的互相调用public class Helloworld : MonoBehaviour { // Use this for initialization void Start () { // 用luaenv虚拟机 来电泳lua语句, lua 语句通过已经绑定的Debu
Unity3D 基于XLua框架、Unity和Lua的相互调用（XLua框架）
zyr0612的博客
08-26 727
目前xLua除了原生的loader外，还添加了从Resource加载的loader，需要注意的是因为Resource只支持有限的后缀，放Resources下的lua文件得加上txt后缀。3.映射到Dictionary，List 但是字典和数组各有优缺点，字典只会映射到带Key的，数组只会映射到不带Key的元素。4.映射到LuaTable类，这种方式好处是不需要生成代码，但也有一些问题，比如慢，比方式2要慢一个数量级，比如没有类型检查。--lua访问静态的属性和方法。--lua访问成员变量和方法。......
XLua官方Examples 02_U3DScripting 怎么用lua来写MonoBehaviour
yhx956058885的博客
10-12 581
1.lua脚本LuaTestScript.lua.txt local speed = 10 local lightCpnt = nil function start() print("lua start...") print("injected object", lightObject) lightCpnt= lightObject:GetComponent(typeof(CS.UnityEngine.Light)) --CS.UnityEngine.Color end function u
xlua入门（1）lua来写MonoBehaviour
步云端的博客
02-27 1840
using UnityEngine; using System.Collections; using System.Collections.Generic; using XLua; using System; [System.Serializable] public class Injection { public string name; public GameObject v...
[Unity热更新]LuaFramework05.MonoBehaviour(lua版本)
weixin_30906701的博客
07-06 102
[Unity热更新]LuaFramework05.MonoBehaviour(lua版本) 参考链接： http://blog.sina.com.cn/s/blog_6788cd880102wbc0.html 1.c#层 LuaComponent.cs ...
Unity3D中MonoBehaviour类整理
Never give up~
06-12 3423
Variables useGUILayout Disabling this lets you skip the GUI layout phase. Functions CancelInvoke Cancels all Invoke calls on this MonoBehaviour. Invoke Invokes the method methodName in time second
面试：浅析unity/xlua中的协程实现
qq_35422344的博客
02-27 1350
问题来源：什么是协程程序https://blog.csdn.net/qq_33575542/article/details/82805857#%E4%BB%80%E4%B9%88%E6%98%AF%E5%8D%8F%E5%90%8C%E7%A8%8B%E5%BA%8F%EF%BC%9F 文章来源：https://mp.weixin.qq.com/s/K1xIxdJqjBD0ND8ShM2xMg ...
XLua与Unity深度集成：C#脚本与Lua交互示例
XLua是一种强大的Lua脚本插件，它允许在Unity游戏引擎中无缝集成Lua脚本，为开发者提供了一种更灵活的方式来扩展和控制游戏逻辑。本文将重点讲解如何利用XLua实现C#与Unity之间的交互，通过创建一个名为`LuaCallText...
XLua学习笔记：fish.lua修改Unity内的Treasour.cs脚本
chh19941125的专栏
11-04 255
unity调用外部的fish.lua文件 using System.Collections; using System.Collections.Generic; using System.IO; using UnityEngine; using XLua; public class HotFixScripts : MonoBehaviour { private LuaEnv luaE...
[Unity + XLua]如何在LuaBehaviour组件上序列化Lua中声明的变量
weixin_40885067的博客
09-10 853
Unity配合XLua序列化Lua中声明的变量
MonoBehaviour类的使
12-28
MonoBehaviour类的使用
Xlua 踩坑笔记（二 ） Xlua对Unity的简单调用
qq_40391388的博客
05-07 1270
介绍一下Lua对Unity的使用，对于Lua怎么使用的请去看我的一文章 这篇主要是介绍一下Lua获取Unity的物体完成对该物体的名字更改，属性赋值，脚本添加，组件获取等日常操作 有了样本相信剩下的其他组件获取等就不是问题了，大家简单了解后可以去看我的第三坑 using System.Collections; using System.Collections.Generic; usin...
从零开始搭xlua框架（三）实现类似C#UnityEngine.MonoBehaviour.Invoke
qq_43204246的博客
01-09 756
之前一直在纠结lua里面没有invoke这个函数 很不方便 就一直在网上找lua中的延迟调用函数 发现根本就没有 我想要的答案 后来跑xlua的交流群里面去问了一下 终于有人给解决方案了 实际上很简单的一件事 只是自己有点死脑壳 想不通 解决方案： C#端实现 定时器 给lua调用就好了 C#端 using System; using System.Collections.Generi...
Unity Xlua MonoProxy Mono代理类
zzzsss123333的博客
07-04 4279
Unity Xlua
SLua-在Lua中实现Unity中的生命周期
祝你万事顺利的博客
07-25 847
Enumerable.Cast(IEnumerable) Method ： Casts the elements of an IEnumerable to the specified type. 将一个IEnumerable的元素转换为一个具体的类型。 实现Unity中的Unity生命周期 1.获取Lua的表 2.获取表中的Update方法 3.使用强制类...
Lua调用C#语言十（Lua实现Unity生命周期函数）
赵某人
06-24 554
C#代码 using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Events; public class LuaObjMgr : SingletonAutoMono<LuaObjMgr> { public UnityAction start; public UnityAction update; public UnityAction
Unity学习一之(初学脚本 MonoBehaviour类 )
double kill = 2.0;
01-13 1988
在看到Unity界面的第一眼,突然感觉到无穷的压力.全英文界面对于我这种初学者而且英文渣得一#的人实在是有点吃不消.用了一天的时间了解了Unity的工具栏的使用以及各种按键的作用,同时刷完了我第一个UNITY地形,感觉很有爱.....软件的使用会随着以后的开发练习会逐步熟练,所以不再多说. 我所知道的Unity是基于组件开发的引擎,当然我现在也只出于理解的层面.我们可以在各种游戏对象上添加自己写
Unity热更新_lua文件自动获取常用的unity生命周期函数
lizhenxiqnmlgb的博客
08-12 571
主要功能： 使得"UI预设"同名的lua文件，自动获取常用的unity生命周期函数（eg:Awake()、Start()、Update()....） 详细描述： 使用委托技术，与特定的(lua文件)lua函数，进行映射。 C#代码： /*** * * Title: “纯lua框架”，C#与lua文件映射调用 * ...
Unity3D——将Unity中自定义的类映射到Lua中来调用
virus2014的专栏
12-07 3641
众所周知，Unity3D游戏的热更新在IOS平台需要使用Lua语言，虽然效率低于C#的实现，但也是没有办法的办法；现在网上比较流行的是一个基于ToLua的LuaFramework的框架，对于这个框架，网上教程资源比较多，下面就说一下自定义类乃至自定义扩展的内容如何映射到lua中，进而使用。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值