com.gameframex.unity.tencen.../README.md

5.8 KiB
Raw Permalink Blame History

基于com.tencent.xlua 的二次修改

该库主要服务于 https://github.com/GameFrameX/GameFrameX 作为子库使用。

使用方式(三种方式)

  1. 直接在 manifest.json 文件中添加以下内容

       {"com.gameframex.unity.tencent.xlua": "https://github.com/gameframex/com.gameframex.unity.tencent.xlua.git"}
    
  2. 在Unity 的Packages Manager 中使用Git URL 的方式添加库,地址为:https://github.com/gameframex/com.gameframex.unity.tencent.xlua.git

  3. 直接下载仓库放置到Unity 项目的Packages 目录下。会自动加载识别

改动功能

  1. 移除开发机器的统计代码

license release PRs Welcome Build status

(English Documents Available)

C#下Lua编程支持

xLua为Unity、 .Net、 Mono等C#环境增加Lua脚本编程的能力借助xLua这些Lua代码可以方便的和C#相互调用。

xLua的突破

xLua在功能、性能、易用性都有不少突破这几方面分别最具代表性的是

  • 可以运行时把C#实现方法操作符属性事件等等替换成lua实现
  • 出色的GC优化自定义struct枚举在Lua和C#间传递无C# gc alloc
  • 编辑器下无需生成代码,开发更轻量;

更详细的特性、平台支持介绍请看这里

安装

打开zip包你会看到一个Assets目录这目录就对应Unity工程的Assets目录保持这目录结构放到你的Unity工程。

如果希望安装到其它目录,请看FAQ相关介绍。

文档

快速入门

一个完整的例子仅需3行代码

安装好xLua建一个MonoBehaviour拖到场景在Start加入如下代码

XLua.LuaEnv luaenv = new XLua.LuaEnv();
luaenv.DoString("CS.UnityEngine.Debug.Log('hello world')");
luaenv.Dispose();

1、DoString参数为string可输入任意合法的Lua代码本示例在lua里调用C#的UnityEngine.Debug.Log打印了个日志。

2、一个LuaEnv实例对应Lua虚拟机出于开销的考虑建议全局唯一。

C#主动调用lua也很简单比如要调用lua的系统函数推荐方式是

  • 声明
[XLua.CSharpCallLua]
public delegate double LuaMax(double a, double b);
  • 绑定
var max = luaenv.Global.GetInPath<LuaMax>("math.max");
  • 调用
Debug.Log("max:" + max(32, 12));

建议绑定一次重复使用。生成了代码的话调用max是不产生gc alloc的。

热补丁

  • 侵入性小,老项目原有代码不做任何调整就可使用。
  • 运行时影响小,不打补丁基本和原有程序一样。
  • 出问题了可以用Lua来打补丁这时才会走到lua代码逻辑

这里是使用指南。

更多示例

技术支持

一群612705778 (已满)

二群703073338 (已满)

三群811246782

入群的问题:有问题该先从哪找答案

回答FAQ

平时也要谨记这答案90%以上问题都可以在FAQ里头找到答案。这些问题就别在群刷屏了。