Unity接入tolua框架

Unity3D

这里我们不使用tolua框架本身的项目，而是在我们已有的工程项目中接入tolua热更框架。

引入tolua

  1. 下载tolua资源

    在引入tolua到我们的项目之前，需要下载tolua的资源包：tolua资源包

  2. 资源引入项目中

    上面下载完tolua资源后，我们得到 tolua-master.zip 一个，解压后即可看到这样的内容：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    ├─Assets
    │  ├─Editor
    │  ├─Lua
    │  ├─Plugins
    │  ├─Source
    │  └─ToLua
    ├─Luajit
    ├─Luajit64
    ├─ProjectSettings
    └─Unity5.x

    我们需要的只是Assets中的文件，将Assets文件夹中所有文件都复制到我们项目的Assets目录中。

  3. 生成常用类型注册文件

    将上面文件复制到我们项目对应目录后，在Uinty窗口会弹出这样一个窗口，点确定即可：

起点

在刚引入到项目中的Tolua\Msic中，有一个LuaClient.cs文件，这是tolua为我们封装好的启动接口，可以继承这个类来编写我们自己的tolua管理器，这里我们建立一个LuaMgr.cs，继承自LuaClient，并重写两个接口：InitLoader和LoadLuaFiles

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
using System.Collections;
using System.Collections.Generic;
using LuaInterface;
using UnityEngine;

public class LuaMgr : LuaClient
{
    protected override LuaFileUtils InitLoader()
    {
        return new LuaResLoader();
    }

    protected override void LoadLuaFiles()
    {
#if UNITY_EDITOR
        // 添加编辑器环境下获取 lua 脚本的路径（Assets/lua）
        luaState.AddSearchPath(Application.dataPath + "/lua");
#endif
        OnLoadFinished();
    }
}

在游戏控制中心脚本GameMgr的Awake方法中，启动lua管理器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class GameMgr : MonoBehaviour
{
    private static GameMgr _instance;
    private LuaMgr _luaMgr = null;

    public static GameMgr Instance{
        get{ return _instance; }
    }

    void Awake(){
        _instance = this;
        transform.name = "GameMgr";
        GameObject.DontDestroyOnLoad(gameObject);
        StartCoroutine(Init());
    }

    IEnumerator Init(){
        Screen.sleepTimeout = SleepTimeout.NeverSleep;  //阻止息屏
        Debug.Log("-- GameMgr Start");
        _luaMgr = gameObject.AddComponent<LuaMgr>();
        yield return 0 ;
    }

    void Start()
    {
        
    }

    void Update()
    {
        
    }
}

启动我们的游戏，此时可以看到打印出这样的信息：

1
2
17:32:10.921-0: LuaState start
UnityEngine.Debug:Log(Object)

这是在lua中打印出来的日志，具体位置：Assets/Lua/Main.lua

1
2
3
4
5
6
7
8
9
10
11
12
13
--主入口函数。从这里开始lua逻辑
function Main()					
	print("logic start")	 		
end

--场景切换通知
function OnLevelWasLoaded(level)
	collectgarbage("collect")
	Time.timeSinceLevelLoad = 0
end

function OnApplicationQuit()
end

至此，tolua框架算是引入成功了。

目录结构整理

导入tolua资源后，Assets目录结构不一定符合我们的要求，需要根据需要进行调整，tolua框架也支持我们这么做。

  1. 修改Generate目录

    Assets/Source/Generate目录用来保存tolua生成的可供lua调用的C#类的绑定类，我们项目希望将其放在Assets/Code/Module/Lua目录下，修改只需要打开Assets/Editor/Custom/CustomSettings.cs

    1
    public static string saveDir = Application.dataPath + "/Source/Generate/";

    修改为：

    1
    public static string saveDir = Application.dataPath + "/Code/Module/Lua/Generate/";

    然后将Assets/Source/LuaConst.cs移动到Assets/Code/Module/Lua中，并在此目录中创一个Generate目录，然后将鼠标焦点移到Unity编辑器，又会弹出之前的“点击确定自动生成常用类型注册文件，也可通过菜单逐步完成此功能”窗口，依旧点确定即可

    然后就可以在Assets/Code/Module/Lua/Generate/目录中看到一堆*wrap.cs文件，还能在unity编辑器中看到一堆报错~，这是因为我们自己生成了一份wrap.cs文件，跟原来的那堆文件重名了，只需要把Source目录删除即可，这样就成功修改了存放wrap.cs文件的目录。

  2. 修改Tolua目录

    Assets/Tolua目录是tolua框架的核心库存放的地方，但是我们习惯将第三方插件存放在项目的Assets/ThirdParty目录下，这里我们直接将Tolua目录挪到Assets/ThirdParty目录下，然后修改以下配置：

    1. LuaConst.cs 中的 toluaDir ：

      1
      public static string toluaDir = Application.dataPath + "/ThirdParty/ToLua/Lua";        //tolua lua文件目录

    2. CustomSettings.cs 中的 toluaBaseType ：

      1
      public static string toluaBaseType = Application.dataPath + "/ThirdParty/ToLua/BaseType/";

  3. 修改入口文件main.lua的位置

    我们希望将lua的入口文件放置到Assets/Code/Lua目录下，只需要将Assets/Lua整个目录移动到Assets/Code下，然后修改LuaConst.cs文件：

    1
    public static string luaDir = Application.dataPath + "/Code/Lua";                //lua逻辑代码目录

  4. Done

呵呵到天亮

游戏前端一枚。