快速入门
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相关介绍。
文档
- 常见问题解答:常见问题都总结在这里,初使用大多数问题都可以在这里找到答案。
- (必看)XLua教程:教程,其配套代码这里。
- (必看)XLua的配置:介绍如何配置xLua。
- 热补丁操作指南:介绍如何使用热补丁特性。
- XLua增加删除第三方lua库:如何增删第三方lua扩展库。
- XLua API:API文档。
- 生成引擎二次开发指南:介绍如何做生成引擎的二次开发。
快速入门
一个完整的例子仅需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代码逻辑;
这里是使用指南。
更多示例
- 01_Helloworld: 快速入门的例子。
- 02_U3DScripting: 展示怎么用lua来写MonoBehaviour。
- 03_UIEvent: 展示怎么用lua来写UI逻辑。
- 04_LuaObjectOrented: 展示lua面向对象和C#的配合。
- 05_NoGc: 展示怎么去避免值类型的GC。
- 06_Coroutine: 展示lua协程怎么和Unity协程相配合。
- 07_AsyncTest: 展示怎么用lua协程来把异步逻辑同步化。
- 08_Hotfix: 热补丁的示例(需要开启热补丁特性,如何开启请看指南)。
- 09_GenericMethod: 泛化函数支持的演示。
- 10_SignatureLoader: 展示如何读取经数字签名的lua脚本,参见数字签名的文档介绍。
- 11_RawObject: 当C#参数是object时,如何把一个lua number指定以boxing后的int传递过去。
- 12_ReImplementInLua: 展示如何将复杂值类型改为lua实现。
技术支持
一群:612705778
二群:703073338
入群的问题:有问题该先从哪找答案
回答:FAQ
平时也要谨记这答案,90%以上问题都可以在FAQ里头找到答案。这些问题就别在群刷屏了。