# UnLua

**Repository Path**: xiayuxia/UnLua

## Basic Information

- **Project Name**: UnLua
- **Description**: A feature-rich, easy-learning and highly optimized Lua scripting plugin for UE4.
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-08-30
- **Last Updated**: 2024-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![LOGO](./Images/UnLua.png)

# 概述
**UnLua**是适用于UE4的一个高度优化的**Lua脚本解决方案**。它遵循UE4的编程模式，功能丰富且易于学习，UE4程序员可以零学习成本使用。

# 在UE4中使用Lua
* 直接访问所有的UCLASS, UPROPERTY, UFUNCTION, USTRUCT, UENUM，无须胶水代码。
* 替换蓝图中定义的实现 ( Event / Function )。
* 处理各类事件通知 ( Replication / Animation / Input )。

更详细的功能介绍请查看[功能清单](Docs/Features.md)。

# 优化特性
* UFUNCTION调用，包括持久化参数缓存、优化的参数传递、优化的非常量引用和返回值处理。
* 访问容器类（TArray, TSet, TMap），内存布局与引擎一致，Lua Table和容器之间不需要转换。
* 高效的结构体创建、访问、GC。
* 支持自定义静态导出类、成员变量、成员函数、全局函数、枚举。

# 平台支持
* 运行平台：Windows / Android / iOS / Linux / OSX
* 引擎版本：Unreal Engine 4.17.x - Unreal Engine 4.26.x

**注意**: 4.17.x 和 4.18.x 版本需要对 Build.cs 做一些修改。

# 快速开始
## 安装
  1. 复制 `Plugins` 目录到你的UE工程根目录。
  2. 重新启动你的UE工程

## 开始UnLua之旅
**注意**: 如果你是一位UE4萌新，推荐使用更详细的[图文版教学](Docs/Quickstart_For_UE4_Newbie.md)继续以下步骤。
  1. 新建蓝图后打开，添加接口 `UnLuaInterface`
  2. 在接口的 `GetModule` 函数中填入Lua文件路径，如 `GameModes.BP_MyGameMode_C`
  3. 点击菜单栏中的 `Lua Template` 图标生成Lua模版文件
  4. 打开 `Content/Script/GameModes/BP_MyGameMode_C.lua` 编写你的代码

# 更多示例
  * [01_HelloWorld](Content/Script/Tutorials/01_HelloWorld.lua) 快速开始的例子
  * [02_OverrideBlueprintEvents](Content/Script/Tutorials/02_OverrideBlueprintEvents.lua) 覆盖蓝图事件（Overridden Functions）
  * [03_BindInputs](Content/Script/Tutorials/03_BindInputs.lua) 输入事件绑定
  * [04_DynamicBinding](Content/Script/Tutorials/04_DynamicBinding.lua) 动态绑定
  * [05_BindDelegates](Content/Script/Tutorials/05_BindDelegates.lua) 委托的绑定、解绑、触发
  * [06_NativeContainers](Content/Script/Tutorials/06_NativeContainers.lua) 引擎层原生容器访问
  * [07_CallLatentFunction](Content/Script/Tutorials/07_CallLatentFunction.lua) 在协程中调用 `Latent` 函数
  * [08_CppCallLua](Content/Script/Tutorials/08_CppCallLua.lua) 从C++调用Lua
  * [09_StaticExport](Content/Script/Tutorials/09_StaticExport.lua) 静态导出自定义类型到Lua使用
  * [10_Replications](Content/Script/Tutorials/10_Replications.lua) 覆盖网络复制事件

# 模块说明
* UnLua 主要运行时模块
* UnLuaEditor 编辑器模块，提供Lua模版生成和commandlet控制台命令
* UnLuaDefaultParamCollector 编码模块，收集UFUNCTION的默认参数
* UnLuaIntelliSense 编码模块，生成用于智能提示的符号信息到内部使用的IDE（即将开放），默认不启用

# 文档
* [功能清单](Docs/Features.md)：更详细的功能列表
* [实现原理](Docs/How_To_Implement_Overriding.md)：介绍 UnLua 的两种覆盖机制
* [编程指南](Docs/UnLua_Programming_Guide.md)：介绍 UnLua 的主要功能和编程模式
* [API](Docs/API.md)：更详细的 UnLua API 说明
* [FAQ](Docs/FAQ.md)：常见问题解答

# 许可证
* UnLua根据[MIT](LICENSE.TXT)分发。