ToLua的案例学习笔记

KaaPexei

文章目录

案例一：DoString的使用案例二：展示searchpath 使用，require 与 dofile 区别案例三：CS调用lua方法案例四：读写lua的全局变量的两种方式

复习lua与C#调用做的笔记，注释大部分都写在了代码里面
案例一：DoString的使用

1. using UnityEngine;
2. using LuaInterface;
3. using System;
5. public class HelloWorld : MonoBehaviour
6. {
7.     void Awake()
8.     {
9.         LuaState lua = new LuaState();//lua虚拟机
10.         lua.Start();//启动
11.         //lua代码
12.         string hello =
13.             @"               
14.                 print('hello tolua#')                                 
15.             ";
16.         
17.         lua.DoString(hello, "HelloWorld.cs");//注解（1）
18.         lua.CheckTop();//检测堆栈是否平衡，每次都需要手动调用
19.         lua.Dispose();注解（2）
20.         lua = null;
21.     }
22. }

复制代码

注解（1）
DoString（）函数：执行字符串
注解(2)
lua.CheckTop();
检测堆栈平衡

案例二：展示searchpath 使用，require 与 dofile 区别

1. public class ScriptsFromFile : MonoBehaviour
2. {
3.     LuaState lua = null;//lua虚拟机
4.     private string strLog = "";   
6.         void Start ()
7.     {
8. #if UNITY_5 || UNITY_2017 || UNITY_2018               
9.         Application.logMessageReceived += Log;
10. #else
11.         Application.RegisterLogCallback(Log);
12. #endif         
13.         lua = new LuaState();               
14.         lua.Start();        //开启虚拟机
15.         //如果移动了ToLua目录，自己手动修复吧，只是例子就不做配置了
16.         string fullPath = Application.dataPath + "\\ToLua/Examples/02_ScriptsFromFile";//lua文件路径
17.         lua.AddSearchPath(fullPath);     //搜索此路径   
18.     }
20.     void Log(string msg, string stackTrace, LogType type)
21.     {
22.         strLog += msg;
23.         strLog += "\r\n";
24.     }
26.     void OnGUI()
27.     {
28.         GUI.Label(new Rect(100, Screen.height / 2 - 100, 600, 400), strLog);
30.         if (GUI.Button(new Rect(50, 50, 120, 45), "DoFile"))
31.         {
32.             strLog = "";
33.             lua.DoFile("ScriptsFromFile.lua");       //DoFile                 
34.         }
35.         else if (GUI.Button(new Rect(50, 150, 120, 45), "Require"))
36.         {
37.             strLog = "";            
38.             lua.Require("ScriptsFromFile");            //require
39.         }
41.         lua.Collect();
42.         lua.CheckTop();
43.     }
45.     void OnApplicationQuit()
46.     {
47.         lua.Dispose();
48.         lua = null;
49. #if UNITY_5 || UNITY_2017 || UNITY_2018       
50.         Application.logMessageReceived -= Log;
51. #else
52.         Application.RegisterLogCallback(null);
53. #endif
54.     }
55. }

复制代码

1. lua代码：（ScriptsFromFile）
2. print("This is a script from a utf8 file")
3. print("tolua: 你好! こんにちは! ?????!")

复制代码

DoFile和Require的区别
（1）：经过运行发现每次调用DoFile都会输出，但是Require只会在第一次调用的时候输出。由此说明：DoFile在每次调用的时候都会对lua代码进行重新的加载。查看源码也是如此：

但是Reuire是在执行的时候先检测模块是否存在，如果不存在则加载，存在直接return，源码奉上：

(2)DoFile的参数需要带上.lua后缀，Require不需要后缀，直接名字就可。

案例三：CS调用lua方法

1. public class CallLuaFunction : MonoBehaviour
2. {
3.     private string script =
4.         @"  function luaFunc(num)                        
5.                 return num + 1
6.             end
8.             test = {}
9.             test.luaFunc = luaFunc
10.         ";
12.     LuaFunction luaFunc = null;
13.     LuaState lua = null;
14.     string tips = null;
15.        
16.         void Start ()
17.     {
18. #if UNITY_5 || UNITY_2017 || UNITY_2018
19.         Application.logMessageReceived += ShowTips;
20. #else
21.         Application.RegisterLogCallback(ShowTips);
22. #endif
23.         new LuaResLoader();//注解（1）
24.         lua = new LuaState();//定义虚拟机
25.         lua.Start();//开启虚拟机
26.         DelegateFactory.Init();  //注解（2）      
27.         lua.DoString(script);
29.         //Get the function object
30.         luaFunc = lua.GetFunction("test.luaFunc");//加载test表中的luaFunc
32.         if (luaFunc != null)
33.         {
34.             int num = luaFunc.Invoke<int, int>(123456);//注解（3）
35.             Debugger.Log("generic call return: {0}", num);
37.             luaFunc.BeginPCall();               
38.             luaFunc.Push(123456);
39.             luaFunc.PCall();        
40.             num = (int)luaFunc.CheckNumber();
41.             luaFunc.EndPCall();
42.             Debugger.Log("expansion call return: {0}", num);//注解（4）
44.             Func<int, int> Func = luaFunc.ToDelegate<Func<int, int>>();//注解（5）
45.             num = Func(123456);
46.             Debugger.Log("Delegate call return: {0}", num);
47.             
48.             num = lua.Invoke<int, int>("test.luaFunc", 123456, true);//注解6
49.             Debugger.Log("luastate call return: {0}", num);
50.         }
52.         lua.CheckTop();
53.         }
55.     void ShowTips(string msg, string stackTrace, LogType type)
56.     {
57.         tips += msg;
58.         tips += "\r\n";
59.     }
61. #if !TEST_GC
62.     void OnGUI()
63.     {
64.         GUI.Label(new Rect(Screen.width / 2 - 200, Screen.height / 2 - 150, 400, 300), tips);
65.     }
66. #endif
68.     void OnDestroy()
69.     {
70.         if (luaFunc != null)
71.         {
72.             luaFunc.Dispose();
73.             luaFunc = null;
74.         }
76.         lua.Dispose();
77.         lua = null;
79. #if UNITY_5 || UNITY_2017 || UNITY_2018
80.         Application.logMessageReceived -= ShowTips;
81. #else
82.         Application.RegisterLogCallback(null);
83. #endif
84.     }
85. }

复制代码

注解（1）：new LuaResLoader();
自定义加载lua文件，优先读取persistentDataPath/系统/Lua 目录下的文件（默认下载目录）未找到文件怎读取 Resources/Lua 目录下文件（仍没有使用LuaFileUtil读取），如果不想自定义则直接new LuaResLoader。自定义可参考：自定义加载lua文件，后面也会提到。
注解（2）：DelegateFactory.Init();
目前没有很好的理解，大佬们有什么高招吗？
注解（3）：int num = luaFunc.Invoke<int, int>(123456)
通用的方式（有GC、慎用）

注解（4）：注释3的另一种形式（个人理解），只是对返回值进行了特殊处理。无GC，注意最后的dispose，否则造成内存泄漏。
注释（5）：自行理解吧。

注解（6）：调用LuaState里面的函数

案例四：读写lua的全局变量的两种方式

1. using UnityEngine;
2. using System.Collections.Generic;
3. using LuaInterface;
5. public class AccessingLuaVariables : MonoBehaviour
6. {
7.     private string script =
8.         @"
9.             print('Objs2Spawn is: '..Objs2Spawn)
10.             var2read = 42
11.             varTable = {1,2,3,4,5}
12.             varTable.default = 1
13.             varTable.map = {}
14.             varTable.map.name = 'map'
15.             
16.             meta = {name = 'meta'}
17.             setmetatable(varTable, meta)
18.             
19.             function TestFunc(strs)
20.                 print('get func by variable')
21.             end
22.         ";
24.         void Start ()
25.     {
26. #if UNITY_5 || UNITY_2017 || UNITY_2018
27.         Application.logMessageReceived += ShowTips;
28. #else
29.         Application.RegisterLogCallback(ShowTips);
30. #endif
31.         new LuaResLoader();//默认加载lua
32.         LuaState lua = new LuaState();//虚拟机
33.         lua.Start();//启动
34.         lua["Objs2Spawn"] = 5;//相当于在lua文件中加入【Objs2Spawn = 5】即新增一个全局变量
35.         lua.DoString(script);//略
37.         //通过LuaState访问
38.         Debugger.Log("Read var from lua: {0}", lua["var2read"]); //读取第10行的变量，看第十行
39.         Debugger.Log("Read table var from lua: {0}", lua["varTable.default"]);  //LuaState 拆串式table，12行
41.         LuaFunction func = lua["TestFunc"] as LuaFunction;//TestFunc方法
42.         func.Call();//案例3的第一种方式，注意有GC，少量call可使用
43.         func.Dispose();
45.         //cache成LuaTable进行访问，很好理解
46.         LuaTable table = lua.GetTable("varTable");//包装成LuaTable
47.         Debugger.Log("Read varTable from lua, default: {0} name: {1}", table["default"], table["map.name"]);
48.         table["map.name"] = "new";  //table 字符串只能是key
49.         Debugger.Log("Modify varTable name: {0}", table["map.name"]);
51.         table.AddTable("newmap");
52.         LuaTable table1 = (LuaTable)table["newmap"];
53.         table1["name"] = "table1";
54.         Debugger.Log("varTable.newmap name: {0}", table1["name"]);
55.         table1.Dispose();
57.         table1 = table.GetMetaTable();
59.         if (table1 != null)
60.         {
61.             Debugger.Log("varTable metatable name: {0}", table1["name"]);
62.         }
64.         object[] list = table.ToArray();
66.         for (int i = 0; i < list.Length; i++)
67.         {
68.             Debugger.Log("varTable[{0}], is {1}", i, list[i]);
69.         }
71.         table.Dispose();                        
72.         lua.CheckTop();
73.         lua.Dispose();
74.         }
76.     private void OnApplicationQuit()
77.     {
78. #if UNITY_5 || UNITY_2017 || UNITY_2018
79.         Application.logMessageReceived -= ShowTips;
80. #else
81.         Application.RegisterLogCallback(null);
82. #endif
83.     }
85.     string tips = null;
87.     void ShowTips(string msg, string stackTrace, LogType type)
88.     {
89.         tips += msg;
90.         tips += "\r\n";
91.     }
93.     void OnGUI()
94.     {
95.         GUI.Label(new Rect(Screen.width / 2 - 300, Screen.height / 2 - 200, 600, 400), tips);
96.     }
97. }

复制代码