MORPH
SIGN IN SIGN UP
Tencent / xLua UNCLAIMED

xLua is a lua programming solution for C# ( Unity, .Net, Mono) , it supports android, ios, windows, linux, osx, etc.

10065 0 1 C
Normal View History Raw
logo
2018-06-22 18:05:47 +08:00
![](Assets/XLua/Doc/xLua.png)
English document
2018-06-22 18:02:29 +08:00
[![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tencent/xLua/blob/master/LICENSE.TXT)
v2.1.15版本发布相关
2020-06-24 10:08:20 +08:00
[![release](https://img.shields.io/badge/release-v2.1.15-blue.svg)](https://github.com/Tencent/xLua/releases)
English document
2018-06-22 18:02:29 +08:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/xLua/pulls)
[![Build status](https://travis-ci.org/Tencent/xLua.svg?branch=master)](https://travis-ci.org/Tencent/xLua)
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
## Lua programming solution for C#
English document
2018-06-22 18:02:29 +08:00
xlua not a framework
2018-06-25 10:12:42 +08:00
xLua adds Lua scripting capability to Unity, .Net, Mono, and other C# environments. With xLua, Lua code and C# code can easily call each other.
English document
2018-06-22 18:02:29 +08:00
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
## xLua's superior features
English document
2018-06-22 18:02:29 +08:00
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
xLua has many breakthroughs in function, performance, and ease of use. The most significant features are:
English document
2018-06-22 18:02:29 +08:00
Grammatical changes (#1062) The most significant is that "inplace" is not a word. There are others too.
2023-05-15 04:05:14 +00:00
* You can use C# implementations (methods, operators, properties, events, etc...) in Lua.
* Outstanding GC optimization, customized struct, no C# gc alloc when passing the enumerated objects between C# and Lua;
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* Lightweight development with no needs to generate code in editor mode;
English document
2018-06-22 18:02:29 +08:00
## Installation
Grammatical changes (#1062) The most significant is that "inplace" is not a word. There are others too.
2023-05-15 04:05:14 +00:00
Unpack the ZIP package and you will see an Assets directory, which corresponds to the Unity project's Assets directory. Keep the directory structure in your Unity project.
English document
2018-06-22 18:02:29 +08:00
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
If you want to install it to another directory, please see the [FAQs](Assets/XLua/Doc/Faq_EN.md).
English document
2018-06-22 18:02:29 +08:00
## Documents
* [FAQs](Assets/XLua/Doc/Faq_EN.md): Frequently asked questions are summarized here. You can find answers to questions for beginners.
* (Must-read) [XLua Tutorial](Assets/XLua/Doc/XLua_Tutorial_EN.md): This is a tutorial. The supporting code can be found [here](Assets/XLua/Tutorial/).
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* (Must-read) [XLua Configuration](Assets/XLua/Doc/Configure_EN.md): Descriptions on how to configure xLua.
* [Hotfix Operation Guide](Assets/XLua/Doc/Hotfix_EN.md): Description on how to use the hotfix feature.
* [Add/remove third-party Lua Libraries on xLua](Assets/XLua/Doc/Add_Remove_Lua_Lib.md): Descriptions on how to add or remove third-party Lua extension libraries.
English document
2018-06-22 18:02:29 +08:00
* [xLua APIs](Assets/XLua/Doc/XLua_API_EN.md): API documentation
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* [Secondary Development of the Build Engine](Assets/XLua/Doc/Custom_Generate_EN.md): Descriptions on how to do secondary development of the build engine.
English document
2018-06-22 18:02:29 +08:00
## Quick Start
A complete example requires only 3 lines of code:
Install xLua, create a MonoBehaviour drag scenario, add the following code to Start:
```csharp
XLua.LuaEnv luaenv = new XLua.LuaEnv();
luaenv.DoString("CS.UnityEngine.Debug.Log('hello world')");
luaenv.Dispose();
```
1. The DoString parameter is a string, and you can enter any allowable Lua code. In this example, Lua calls C#’s UnityEngine.Debug.Log to print a log.
2. A LuaEnv instance corresponds to a Lua virtual machine. Due to overhead, it is recommended that the Lua virtual machine be globally unique.
It is simple that C# actively calls Lua. For example, the recommended method to call Lua's system function is:
* Declare
```csharp
[XLua.CSharpCallLua]
public delegate double LuaMax(double a, double b);
```
* Bind
```csharp
var max = luaenv.Global.GetInPath<LuaMax>("math.max");
```
* Call
```csharp
Debug.Log("max:" + max(32, 12));
```
It is recommended that you bind once and reuse it. If code is generated, no gc alloc is generated when calling max.
## Hotfix
* This has lower intrusiveness, and it can be used without any modification of the original code of the old project.
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* This has little impact on the runtime, which is almost the same as the original program which hotfix is not used.
English document
2018-06-22 18:02:29 +08:00
* If you have problems, you can also use Lua to patch. Then the Lua code logic is involved.
[Here](Assets/XLua/Doc/Hotfix_EN.md) is the usage guide:
## More Examples
* [01_Helloworld](Assets/XLua/Examples/01_Helloworld/): Quick Start Examples
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* [02_U3DScripting](Assets/XLua/Examples/02_U3DScripting/): This example shows how to use Mono to write MonoBehaviour.
* [03_UIEvent](Assets/XLua/Examples/03_UIEvent/): This example shows how to use Lua to write UI logic.
* [04_LuaObjectOrented](Assets/XLua/Examples/04_LuaObjectOrented/): This example shows the cooperation between Lua's object-oriented programming and C#.
* [05_NoGc](Assets/XLua/Examples/05_NoGc/): This example shows how to avoid the value type GC.
* [06_Coroutine](Assets/XLua/Examples/06_Coroutine/): This example shows how Lua coroutines work with Unity coroutines.
* [07_AsyncTest](Assets/XLua/Examples/07_AsyncTest/): This example shows how to use Lua coroutines to synchronize asynchronous logic.
* [08_Hotfix](Assets/XLua/Examples/08_Hotfix/): These are Hotfix examples (Please enable hotfix feature. See the [Guide](Assets/XLua/Doc/Hotfix_EN.md) for details).
English document
2018-06-22 18:02:29 +08:00
* [09_GenericMethod](Assets/XLua/Examples/09_GenericMethod/): This is a generic function support demo.
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
* [10_SignatureLoader](Assets/XLua/Examples/10_SignatureLoader/): This example shows how to read the Lua script with a digital signature. See the [Digital Signature](Assets/XLua/Doc/signature.md) document for details.
* [11_RawObject](Assets/XLua/Examples/11_RawObject/): This example shows how to specify transferring a Lua number in the int after boxing when the C# parameter is an object.
English document
2018-06-22 18:02:29 +08:00
* [12_ReImplementInLua](Assets/XLua/Examples/12_ReImplementInLua/): This shows how to change complex value types to Lua implementations.
增加异步函数在lua中热更的示例 (#1134) * 增加异步函数热更示例 * 增加异步函数热更示例 * 在readme中增加异步函数热更示例
2024-09-04 20:07:18 +08:00
* [14_HotfixAsyncAwait](Assets/XLua/Examples/14_HotfixAsyncAwait/): This shows how to change asynchronous functions and await keyword to Lua implementation.
English document
2018-06-22 18:02:29 +08:00
## Technical support
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
QQ Group 1: 612705778 (may be full)
English document
2018-06-22 18:02:29 +08:00
Xlua英文文档更正 (#398) 原文翻译的已经很好，直接按照自己的见解有一点修改，大大加油
2018-06-25 10:08:56 +08:00
QQ Group 2: 703073338
English document
2018-06-22 18:02:29 +08:00
一、二群已满，添加三群信息
2022-01-19 11:02:09 +08:00
QQ Group 3: 811246782
English document
2018-06-22 18:02:29 +08:00
Check answers: If you encounter a problem, please read the FAQs first.
Reference in New Issue Copy Permalink