unity游戏开发之ULua框架介绍（一）

1.基础介绍

①ULua 集成开发环境叫作：SimpleFramework，SimpleFramework 分为NGUI 和UGUI两个版本，区别是NGUI 版本的框架资源中含有NGUI 这个插件。SimpleFramework 自己不是Unitypackage 格式，而是一个Unity3D的项目工程，能够用Unity 直接打开。

②SimpleFramework 和ULua

SimpleFramework > ULua > Lua

ULua 是对原生Lua 环境进行了一次“包装”，用于知足Unity 环境下的热更新需求。为了更方便的使用，因而又对ULua 进行“二次包装”，包装成了一个框架：SimpleFramework。

2. SimpleFramework框架资源结构

（1）六个根文件夹

   ①Examples：SimpleFramework 热更新案例；

   ②Lua：SimpleFramework 框架自带的Lua 源码文件（咱们本身写的Lua 脚本也是存放在Lua 文件夹中）；

   ③NGUI：当你需用更高版本的NGUI 时，替换便可，不然不须要碰；

   ④Plugins：uLua 运行所依赖的底层库文件，不须要碰；

   ⑤Scripts：SimpleFramework 自带的C#脚本文件；

   ⑥uLua：uLua 所有代码。

备注：uLua：④ ⑥       SimpleFramework：① ② ⑤       ngui：③

（2）框架自带菜单命令

      Lua 菜单：uLua 环境相关处理命令；

      Game 菜单：用于打包不一样平台的AssetBundle 文件。

（3）框架使用步骤

      Lua 菜单-->Welcome Screen 该窗口展现了框架的使用步骤。

     <1>Lua-->Gen Lua Wrap File [生成Wrap 文件(必备操做)]

     该命令用于生成“Lua 包装文件”，存放在uLua\Source\LuaWrap 目录下。该文件夹下所有是C#脚本，这些脚本文件的名称特色是：脚本名+ Wrap；

Wrap 文件介绍：

该文件夹下的脚本对Unity 内经常使用组件脚本的二次包装，Lua 环境运行后，会，把这些Wrap 文件加载到Lua 运行环境(Lua 虚拟机)中，最终的效果就是：Lua 调用Wrap 文件，Wrap 文件调用C#，来实现Lua 调用C#。生成Wrap 文件的目的是为了提升Lua 的执行效率。

<2>Game-->Build xxxx [生成不一样平台的AssetBundle 资源(必备操做)]

Game-->Build Windows Resource 生成Windows 平台下的AB 文件。生成后的AB 会存放到StreamingAssets 文件夹下。在生成的过程当中同时还会把Lua 文件夹下的全部脚本拷贝到该目录，存放到lua 文件夹下。

（4）Lua 文件夹结构分析

   SimpleFramework 框架自带的Lua 源码文件。

    ①3rd：第三方的Lua 脚本插件；

    ②Common：公共Lua 文件目录；

    ③Controller：控制器目录；

    ④Logic：管理器目录；

    ⑤System：cstolua 的系统目录；

    ⑥View：视图层目录。

3.uLua 文件夹结构

uLua是SimpleFramework 框架项目的核心，在Unity 环境下使用uLua能够实现Lua 脚本与Unity 内C#脚本的交互，经过Lua 脚原本操做Unity3D内的各类游戏组件。

 

①Core：uLua 核心；

②Docs：uLua 文档，其实就是LuaInterface 的PDF 使用文档；

③Editor：uLua 编辑器扩展（项目内全部的Editor 文件夹都是编辑器扩展文件夹，并不局限于根目录）；

④Examples：uLua 自带演示案例；

⑤Source：cstolua 核心目录。

4.uLua 环境下的代码交互

（1）基础介绍

   你们都知道可使用LuaInterface 项目中的两个DLL 文件来实现C#与Lua 的交互。而在uLua 环境下本质也是经过LuaInterface 来实现Lua 与C#语言交互的。可是uLua 对LuaInterface 进行了二次的封装，因此在代码书写上和原生的会稍有不一样。

（2）C#代码中执行Lua 代码

   LuaState lua = new LuaState();

   lua.DoString("print('Hello World Monkey')");

   说明:

   <1>一样须要在C#代码中引入LuaInterface；

   <2>原生的Lua 解析器对象“Lua”被二次封装成了“

   <3>LuaState 类存在的位置是：uLua\Core\Lua.cs。

（3）Lua 代码中操做Unity 内的类[反射方式/ 原生方式]

   演示:经过Lua 代码在Unity 环境内建立一个游戏物体。

   luanet.load_assembly('UnityEngine')

   GameObject = luanet.import_type('UnityEngine.GameObject')

   BoxCollider = luanet.import_type('UnityEngine.BoxCollider')

   local player = GameObject('Monkey')

   player:AddComponent(luanet.ctype(BoxCollider))

说明：

<1>这种方式就是咱们提到的原生方式；

<2>luanet 已经被封装到了LuaInterface 命名空间内，因此咱们能够在Lua代码中直接使用luanet 这个对象；

<3>在Lua 环境内操做C#中的类建立对象，不要写new 关键字！！！

<4>在Lua 环境内操做C#中的类建立对象，访问对象中的方法使用分号（:）；

<5>这种“反射方式”在项目开发中并不经常使用，可是也有用武之地，真正大量使用的是下方的Wrap 方式。

（4）Lua 代码中操做Unity 内的类[Wrap 方式]

luanet.load_assembly('UnityEngine')

GameObject = UnityEngine.GameObject

BoxCollider = UnityEngine.BoxCollider

local player = GameObject('Monkey')

player:AddComponent(BoxCollider.GetClassType())

LuaScriptMgr lua = new LuaScriptMgr();

lua.Start();

说明：

<1>这种是在uLua 开发过程当中最经常使用的方式，95%+状况都是使用这种方式；

<2>Wrap 方式实现Lua 调用C#，依赖的是以前生成的LuaWrap 文件（也就是经过菜单自动生成到uLua\Source\LuaWrap 下的脚本文件）；

<3>当使用Wrap 方式时，运行Lua 代码须要使用LuaScriptMgr；

<4>须要把AppConst.cs 脚本中的的DebugMode 修改成true。

5.包装新的Wrap 脚本

当咱们用Lua 的Wrap 方式访问Unity 中的组件脚本，或者本身写的脚本的使用，若是这些脚本没有自动生成“xxxxWrap”,项目运行后，就会报错。

好比Animator 脚本，就没有默认生成Wrap 格式的文件。遇到这种状况，咱们就须要往框架的Wrap 生成器中添加咱们要处理的新的类。

步骤以下：

①找到uLua\Editor\WrapFile.cs 打开该脚本，

使用该格式进行添加：_GT(typeof(类名)) ；

②Lua-->Clear LuaBinder File + Wrap File 清空原有的Wrap 文件；

③Lua-->Gen Lua Wrap Files 从新生成Wrap 文件；

这样就能看的新增的Wrap 脚本文件了。