xLua README

The project's README from github.com/Tencent/xLua. As one markdown file: README.md.

license release PRs Welcome Build status

(English Documents Available)

C# 下 Lua 编程支持

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


xLua 的突破

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

更详细的特性、平台支持介绍请参考 xLua 文档: 功能特性。


安装

xLua 可以直接简单的安装在 Unity 项目中.

  1. 从 Releases 中下载发行版, 或直接下载本仓库代码.
  2. 打开下载下来的源码压缩包, 你会看到一个 Assets 目录, 这目录就对应 Unity 工程的 Assets 目录,保持这目录结构, 将其内容置入 Unity 项目即可.

注意, Assets/Examples 目录下为示例代码, 你应该在生产环境下删去他们.

如果希望安装到其它目录,请看 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 的系统函数,推荐方式是:

注意, 请不要重复调用 luaEnv.Global.GetInPath<LuaMax>, 这没有任何必要.


热补丁

除了使用 Lua 在 Unity 进行脚本编写, 你也可以使用 Lua 实现 "热补丁". xLua 提供了使用 Lua 逻辑替换 C# 方法逻辑的方案.

参考使用指南: xLua 文档: 热补丁


更多示例


技术支持

一群:612705778 (已满)

二群:703073338 (已满)

三群:811246782

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

回答:FAQ

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

xLua (Tencent/xLua)

Searching Database…

10.2K ·GitHub
这是做什么的?xLua 为 C# 环境(Unity、.Net 和 Mono)加入了 Lua 脚本支持,让 Lua 代码和 C# 可以方便地互相调用,最常见的就是用来给 Unity 游戏写脚本。
Lua 实际是在哪里运行的——xLua 自带解释器吗?是的。你创建的每一个 LuaEnv 实例都对应一个 Lua 虚拟机,README 建议只保留一个实例,全局唯一,以减少开销。
怎么把它加到我的 Unity 项目里?从 GitHub Releases 下载构建包(或者直接拿仓库代码),把它 Assets 目录里的内容放进你项目的 Assets 文件夹,保持原有目录结构。上线发布前要把 Assets/Examples 删掉。
需要另外安装什么吗?不需要——它以纯源码的形式装进你的 Unity 项目,没有任何额外步骤。以后如果想用第三方的 Lua 库,有专门的指南教你怎么加、怎么删。
热更新功能是开箱即用的吗?不是——需要先手动开启;08Hotfix 示例里提到,要按文档中的热更新指南来开启它。
手机端能用吗,还是只能在电脑上用?移动端是一等公民:项目支持 android 和 ios,同时也支持 windows、linux 和 osx。
Lua 那边具体能做些什么?自带的示例展示了用 Lua 写 MonoBehaviour 和 UI 逻辑、把 Lua 的面向对象和 C# 混用、让 Lua 协程和 Unity 协程一起跑(甚至能把异步代码变成同步写法)、调用泛型方法、加载带数字签名的脚本,以及在 Lua 里重新实现 C# 的值类型。
写个 hello world 需要多少代码?三行:创建一个 LuaEnv,然后用 DoString 执行任意合法的 Lua 代码——快速上手示例是在 Lua 里通过 C# 的 UnityEngine.Debug.Log 输出日志的。C# 也能反过来调用 Lua,比如从全局表里取出一个 Lua 函数。
热更新功能有什么用?它可以在运行时把 C# 的方法、运算符、属性和事件替换成 Lua 实现。老项目不用改任何代码,而且补丁真正生效之前程序行为和原来完全一样——所以已发布版本里的问题可以用 Lua 来修。
性能方面有什么特别的吗?有——xLua 主打 GC 优化:自定义 struct 和 enum 在 Lua 和 C# 之间传递时不产生任何 C# GC 分配。在编辑器里开发时它还会跳过代码生成,让开发迭代保持轻快。
Creator
Tencent
Size
25.8 MB
Stars
10.2K
Age
9y
Commits · 90 Days