柚子快報(bào)激活碼778899分享：游戲 設(shè)計(jì)模式 xLua詳解

http://yzkb.51969.com/

目錄

環(huán)境準(zhǔn)備xLua導(dǎo)入

C#調(diào)用LuaLua解析器Lua文件加載重定向Lua解析管理器全局變量的獲取全局函數(shù)的獲取List和Dictionary映射table類映射table接口映射tableLuaTable映射table

Lua調(diào)用C#準(zhǔn)備工作Lua使用C#類Lua調(diào)用C#枚舉Lua使用C# 數(shù)組 List 字典數(shù)組List字典

Lua使用C#擴(kuò)展方法Lua使用C# ref和out函數(shù)refout

函數(shù)重載lua調(diào)用C# 委托和事件Lua使用C#二維數(shù)組Lua中null與nil的比較系統(tǒng)類型與Lua互相訪問lua使用C#協(xié)程Lua使用C#泛型

環(huán)境準(zhǔn)備

xLua導(dǎo)入

我們來到github搜索xLua,直接下載zip壓縮包 我們把這兩個(gè)文件夾復(fù)制到工程中 編譯完之后窗口上就會(huì)有這個(gè)Xlua的選項(xiàng)（這里有可能會(huì)提示某個(gè)腳本編譯失敗，加個(gè)using System.Reflection） 我們可以先點(diǎn)擊第二個(gè)選項(xiàng)，再點(diǎn)擊第一個(gè)選項(xiàng)生成 然后這里要導(dǎo)入ABbrowser工具，詳情請(qǐng)看AssetBundle詳解 這里根據(jù)教程還需要導(dǎo)入三個(gè)類 我依次寫到這上面 BaseManager

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class BaseManagerwhere T:new()//where T:new() 指定了泛型類型 T 必須具有無參數(shù)的構(gòu)造函數(shù)

{

private static T instance;

public static T GetInstance()

{

if (instance == null)

instance = new T();

return instance;

}

}

SingletonAutoMono

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class SingletonAutoMono:MonoBehaviour where T : Monobehaviour

{

private static T instance;

public static T GetInstance()

{

if (instance == null)

{

GameObject obj = new GameObject();

obj.name = typeof(T).ToString();

DontDestoryOnLoad(obj);

instance = obj.AddComponent();

}

return instance;

}

}

SingletonMono類

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

// Start is called before the first frame update

public class SingletonMono : MonoBehaviour where T : MonoBehaviour

{

private static T instance;

public static T Getinstance()

{

retrun instance;

}

protected virtual void Awake()

{

instance = this;

}

}

然后我們要導(dǎo)入AB包管理器，這個(gè)也在AssetBundle詳解里

C#調(diào)用Lua

Lua解析器

這里的核心就是LuaEnv，我們把腳本附著到相機(jī)上，然后運(yùn)行

public class Lesson1_LuaEnv : MonoBehaviour

{

// Start is called before the first frame update

void Start()

{

//Lua解析器 能夠讓我們?cè)赨nity中執(zhí)行Lua

LuaEnv env = new LuaEnv();

//執(zhí)行Lua語言

env.DoString("print('こにちは')");

}

// Update is called once per frame

void Update()

{

}

}

//幫助我們定時(shí)清除Lua中沒有手動(dòng)釋放的對(duì)象

//在幀更新中定時(shí)執(zhí)行或切場(chǎng)景時(shí)執(zhí)行

env.Tick();

//銷毀Lua解析器

env.Dispose();

這里如果有很多個(gè)語句需要執(zhí)行，一句一句調(diào)用太慢了怎么辦，我們這里可以使用DoString通過字符名來執(zhí)行Lua腳本名，Lua中使用require來跨腳本運(yùn)行 我們現(xiàn)在先在Unity中新建一個(gè)Resources文件夾， 然后在文件夾中新建一個(gè).txt文件再把后綴更改為.lua 再用相應(yīng)的lua軟件打開 我們先只寫一句話 但是現(xiàn)在又有個(gè)問題，Unity無法直接識(shí)別Lua文件，所以再改成Main.lua.txt

env.DoString("require('Main')");

Lua文件加載重定向

這部分的內(nèi)容是自定義lua文件加載路徑 當(dāng)require被調(diào)用時(shí)，會(huì)先去Addloader中的函數(shù)路徑找文件，然后再去默認(rèn)路徑（Resources）中尋找 我們現(xiàn)在寫一個(gè)基本邏輯，Addloder會(huì)實(shí)現(xiàn)重定向功能，它接受一個(gè)委托

void Start()

{

LuaEnv env = new LuaEnv();

env.AddLoader(MyCustomLoader);

env.DoString("require('Main')");

}

//自動(dòng)執(zhí)行

private byte[] MyCustomLoader(ref string filePath)

{

Debug.Log(filePath);

//通過函數(shù)中的邏輯，去加載lua文件

return null;

}

我們新建一個(gè)叫做Lua的文件夾 然后在里面新建一個(gè)Main文件 我們來詳細(xì)解釋一下這段代碼 這里AddLoader的調(diào)用參數(shù)是一個(gè)委托變量，類似于C++中的函數(shù)指針，而MyCustomLoader這里是通過env傳入的lua文件名。如果我把 env.DoString(“require(‘Main’)”);這行注釋掉，那么MyCustomLoader將不會(huì)執(zhí)行 在這里，filePath是Main,Application.dataPath是Unity/xxx/Asset

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using XLua;

using System.IO;

using Unity.VisualScripting;

public class Lesson2_Loader : MonoBehaviour

{

void Start()

{

LuaEnv env = new LuaEnv();

env.AddLoader(MyCustomLoader);

env.DoString("require('Main')");

}

//自動(dòng)執(zhí)行

private byte[] MyCustomLoader(ref string filePath)

{

//傳入的參數(shù)是require執(zhí)行的腳本文件名

string path = Application.dataPath + "/Lua/" + filePath + ".lua";

Debug.Log(path);

if(File.Exists(path))

{

return(File.ReadAllBytes(path));

}

else

{

Debug.Log("重定向失敗，文件名為" + filePath);

}

//拼接一個(gè)lua所在路徑

//通過函數(shù)中的邏輯，去加載lua文件

return null;

}

}

Lua解析管理器

我們用一個(gè)管理器來管理LuaEnv 其他邏輯都是前面提到過的

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using XLua;

using System.IO;

//Lua管理器

//提供lua解析器

//保證解析器的唯一性

public class LuaMgr:BaseManager

{

//執(zhí)行Lua語言的函數(shù)

//釋放垃圾

//銷毀

//重定向

private LuaEnv luaEnv;

public void Init()

{

//如果已經(jīng)初始化了，直接返回

if (luaEnv != null)

return;

luaEnv = new LuaEnv();

//加載lua腳本重定向

luaEnv.AddLoader(MyCustomLoader);

}

private byte[] MyCustomLoader(ref string filePath)

{

string path = Application.dataPath + "/Lua/" + filePath + ".lua";

Debug.Log(path);

if (File.Exists(path))

{

return (File.ReadAllBytes(path));

}

else

{

Debug.Log("重定向失敗，文件名為" + filePath);

}

return null;

}

public void DoString(string str)

{

luaEnv.DoString(str);

}

public void Tick()

{

luaEnv.Tick();

}

public void Dispose()

{

luaEnv.Dispose();

luaEnv = null;

}

}

然后我們寫一個(gè)測(cè)試類來測(cè)試 我們的代碼邏輯在這個(gè)腳本中第一次使用LuaMgr，所以需要Init，如果初始化之后在其他的腳本就可以直接使用LuaMgr了

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class Lesson3_LuaMgr : MonoBehaviour

{

// Start is called before the first frame update

void Start()

{

LuaMgr.GetInstance().Init();//LuaMgr是一個(gè)單例類，所以可以直接訪問

LuaMgr.GetInstance().DoString("require('Main')");

}

// Update is called once per frame

void Update()

{

}

}

接下來我們講AB包和Mgr相關(guān)邏輯 由于AB包不識(shí)別lua，所以還是先修改成txt 我們選中Main文件，新建一個(gè)lua的AB包 我們先清除一下代碼 然后構(gòu)建 現(xiàn)在我們要做的其實(shí)就是在AB包中執(zhí)行l(wèi)ua 我們?cè)賮斫忉尯瘮?shù)邏輯 這里我們又加了一個(gè)重定向邏輯MyCustomABLoader，用來從AB包中加載數(shù)據(jù)，在MyCustomABLoader中，我們之前使用的邏輯是手動(dòng)聲明AB包的對(duì)象然后進(jìn)行讀取，但是我們?cè)贏B包的教程中做了一個(gè)AB包管理器，所以這里使用AB包管理器來做

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using XLua;

using System.IO;

//Lua管理器

//提供lua解析器

//保證解析器的唯一性

public class LuaMgr:BaseManager

{

//執(zhí)行Lua語言的函數(shù)

//釋放垃圾

//銷毀

//重定向

private LuaEnv luaEnv;

public void Init()

{

//如果已經(jīng)初始化了，直接返回

if (luaEnv != null)

return;

luaEnv = new LuaEnv();

//加載lua腳本重定向

luaEnv.AddLoader(MyCustomLoader);

luaEnv.AddLoader(MyCustomABLoader);

}

public void DoLuaFIle(string fileName)

{

string str = string.Format("require('{0}')",fileName);

}

private byte[] MyCustomLoader(ref string filePath)

{

string path = Application.dataPath + "/Lua/" + filePath + ".lua";

Debug.Log(path);

if (File.Exists(path))

{

return (File.ReadAllBytes(path));

}

else

{

Debug.Log("重定向失敗，文件名為" + filePath);

}

return null;

}

//重定向加載AB包中的lua腳本

private byte[] MyCustomABLoader(ref string filePath)

{

//從AB包中加載lua文件

//加載AB包

// string path = Application.streamingAssetsPath + "/lua";

// AssetBundle ab = AssetBundle.LoadFromFile(path);

// TextAsset tx = ab.LoadAsset(filePath+".lua");

// //加載除了lua文件 byte數(shù)組

return tx.bytes;

TextAsset lua=ABMgr.GetInstance().LoadRes("lua",filePath+".lua");

if (lua != null)

return lua.bytes;

else

return null;

}

public void DoString(string str)

{

luaEnv.DoString(str);

}

public void Tick()

{

luaEnv.Tick();

}

public void Dispose()

{

luaEnv.Dispose();

luaEnv = null;

}

}

全局變量的獲取

我們?cè)贛ain.lua的文件下新建一個(gè)Test.lua 在test中定義如下變量 這里我們?cè)L問全局變量的方式是通過Main.lua進(jìn)行的 這里很有意思的是，require調(diào)用Test的邏輯本質(zhì)上并不是Main自己調(diào)用的，而是xlua調(diào)用的，通過堆?？梢钥吹?所以如果我require(‘一個(gè)不存在的文件’)，會(huì)在xlua層報(bào)錯(cuò)也是有跡可循的了。

現(xiàn)在我們要使用mgr來調(diào)用Test中的變量 這個(gè)Globe有點(diǎn)類似大G表，可以通過這個(gè)操縱Test中的數(shù)據(jù)

int i=LuaMgr.GetInstance().Global.Get("testNumber");

Debug.Log(i);

可以發(fā)現(xiàn)成功打印 但是這里取到的值也只是個(gè)拷貝，并不會(huì)修改原來的數(shù) 如果想修改可以使用set 這里也不能取到test中聲明的本地變量，換言之只能操作大G表的內(nèi)容

全局函數(shù)的獲取

函數(shù)我們依舊在test中寫 我們先調(diào)用無參無返回值方法，使用委托

public class Lesson5_CallFunction : MonoBehaviour

{

// Start is called before the first frame update

void Start()

{

LuaMgr.GetInstance().Init();

LuaMgr.GetInstance().DoLuaFile("Main");

//無參無返回的獲取

//委托

CustomCall call = LuaMgr.GetInstance().Global.Get("testFun");

call();

}

// Update is called once per frame

void Update()

{

}

}

有參有返回：

public delegate void CustomCall2(int a);

//調(diào)用

[CSharpCallLua]//自定義委托一定要有

CustomCall2 call2 = LuaMgr.GetInstance().Global.Get("testFun2");

call2(10);

這里可能會(huì)報(bào)錯(cuò)，去xlua窗口重新生成一下就好了 這里委托都可以使用Unity/C#/提供的，不需要自己寫 接下來是多返回值，在C#中使用out 和 ref來接收 首先是聲明委托

//多返回值委托

[CSharpCallLua]

public delegate int CustomCall3(int a, out int b, out bool c, out string d, out int e);

然后是接收

//多返回值獲取

CustomCall3 call3 = LuaMgr.GetInstance().Global.Get("testFun3");

int b;bool c; string d; int e;

Debug.Log("多返回值：" + call3(100, out b, out c, out d, out e));

Debug.Log(b + "_" + c + "_" + d + "_" + e);

然后是變長(zhǎng)參數(shù) 首先說一下ref和out的區(qū)別 ref 關(guān)鍵字用于傳遞一個(gè)已初始化的變量作為參數(shù)，并且要求方法在使用這個(gè)參數(shù)之前初始化它。 out 關(guān)鍵字用于傳遞一個(gè)未初始化的變量作為參數(shù)，方法在使用這個(gè)參數(shù)之前必須將其初始化。 我們依舊可以用這些參數(shù)

[CSharpCallLua]

public delegate int CustomCall4(int a, ref int b, ref bool c, ref string d, ref int e);

//多返回值獲取

CustomCall4 call4 = LuaMgr.GetInstance().Global.Get("testFun3");

int b1=0; bool c1=false; string d1=""; int e1=0;//要初始化

Debug.Log("變長(zhǎng)參數(shù)：" + call4(100, ref b, ref c, ref d, ref e));

Debug.Log(b + "_" + c + "_" + d + "_" + e);

以下是完整代碼

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.UIElements;

using XLua;

//無參無返回值的委托

public delegate void CustomCall();

//有參有返回的委托

[CSharpCallLua]

public delegate void CustomCall2(int a);

//多返回值委托

[CSharpCallLua]

public delegate int CustomCall3(int a, out int b, out bool c, out string d, out int e);

//變長(zhǎng)參數(shù)

[CSharpCallLua]

public delegate int CustomCall4(int a, ref int b, ref bool c, ref string d, ref int e);

public class Lesson5_CallFunction : MonoBehaviour

{

// Start is called before the first frame update

void Start()

{

LuaMgr.GetInstance().Init();

LuaMgr.GetInstance().DoLuaFile("Main");

//無參無返回的獲取

//委托

CustomCall call = LuaMgr.GetInstance().Global.Get("testFun");

call();

//有參有返回的獲取

CustomCall2 call2 = LuaMgr.GetInstance().Global.Get("testFun2");

call2(10);

//多返回值獲取

CustomCall3 call3 = LuaMgr.GetInstance().Global.Get("testFun3");

int b;bool c; string d; int e;

Debug.Log("多返回值：" + call3(100, out b, out c, out d, out e));

Debug.Log(b + "_" + c + "_" + d + "_" + e);

//多返回值獲取

CustomCall4 call4 = LuaMgr.GetInstance().Global.Get("testFun3");

int b1=0; bool c1=false; string d1=""; int e1=0;

Debug.Log("變長(zhǎng)參數(shù)：" + call4(100, ref b, ref c, ref d, ref e));

Debug.Log(b + "_" + c + "_" + d + "_" + e);

}

// Update is called once per frame

void Update()

{

}

}

List和Dictionary映射table

我們先在test中聲明

testList={1,2,3,4,5,6}

testList2={"123","123",true,1,1.2}

--Dictionary

testDic1={

["1"]=1,

["2"]=1,

["3"]=1,

["4"]=1

}

testDic2={

["1"]=1,

[true]=1,

[false]=true

["123"]=false

}

老方法調(diào)用

List list = LuaMgr.GetInstance().Global.Get>("testList");

for(int i = 0; i < list.Count; i++)

{

Debug.Log(list[i]);

}

不過get還是不能改數(shù)據(jù)本身 我們?cè)倏匆幌聞偛诺膖estDic，testList2存的不只有int型 所以我們?cè)谌〉街档臅r(shí)候選擇object

List