【xLua】C#访问Lua

访问Lua的变量

在Resources文件夹中新建一个CSharpCallLua.lua.txt文件，定义几个变量

i = 10
str = "wwz"
isStu = false

void Start()
{
    LuaEnv luaEnv = new LuaEnv();

    luaEnv.DoString("require 'CSharpCallLua'");
 
    int i = luaEnv.Global.Get<int>("i");
    print(i);
    string str = luaEnv.Global.Get<string>("str");
    print(str);
    bool isStu = luaEnv.Global.Get<bool>("isStu");
    print(isStu);

    luaEnv.Dispose();
}

Lua的number类型对于C#的int，float，double的，如果类型不对，会返回0

比如在Lua中i = 10.1，C# 中int i = luaEnv.Global.Get(“i”);得到的i将是0

所以在C#中也可以用float，double来接收Lua的number类型

double i = luaEnv.Global.Get<double>("i");

这样就能正常输出了
在这里插入图片描述

访问Lua的table

1.映射到普通class或struct

定义一个class，有对应于table的字段的public属性，而且有无参数构造函数即可，比如对于{f1 = 100, f2 = 100}可以定义一个包含public int f1;public int f2;的class。
这种方式下xLua会帮你new一个实例，并把对应的字段赋值过去。
table的属性可以多于或者少于class的属性。可以嵌套其它复杂类型。
要注意的是，这个过程是值拷贝，如果class比较复杂代价会比较大。而且修改class的字段值不会同步到table，反过来也不会。
这个功能可以通过把类型加到GCOptimize生成降低开销。

在Lua中

person = {
	name="wwz",age=18
}

在C#中，新建Person类，字段必须和Lua的key相同才能获取对应的值

public class Person
{
    public string name;
    public int age;
}

Person person = luaEnv.Global.Get<Person>("person");
print(person.name + "," + person.age);
p.name = "haha";//修改class的字段值不会同步到table，反过来也不会，值拷贝
luaEnv.DoString("print(person.name)");

在这里插入图片描述
修改class的字段值不会同步到table，反过来也不会

2.映射到一个interface

扫描二维码关注公众号，回复： 6058470 查看本文章

这种方式依赖于生成代码（如果没生成代码会抛InvalidCastException异常），代码生成器会生成这个interface的实例，如果get一个属性，生成代码会get对应的table字段，如果set属性也会设置对应的字段。甚至可以通过interface的方法访问lua的函数。

在Lua中

i = 10.1
str = "wwz"
isStu = false

person = {
	name="wwz",age=18,
	addt=function(self,a,b)--self表示table本身
		print(a+b)
	end
}

    [CSharpCallLua]
    interface IPerson
    {
        string name { get; set; }
        int age { get; set; }
        void eat(int a, int b);
    }

在Unity 2018.3.0f2版本下出现错误，原来Unity 2018 不支持xLua

本次用的是Unity 2018.3.0f2和xlua_v2.1.14，由于兼容性问题

【xLua】添加CSharpCallLua还是报错

最终，换成Unity 2017.1.0f3 和xlua_v2.1.9

IPerson p = luaEnv.Global.Get<IPerson>("person");
print(p.name + "," + p.age);
p.name = "haha";//修改interface的字段值会同步到table
luaEnv.DoString("print(person.name)");
p.add(10,20);

在这里插入图片描述

在Lua中
可以这么写

function person:add(a,b)
	print(a+b)
end

也可以这么写

function person.add(self,a,b)
	print(a+b)
end

3.更轻量级的by value方式：映射到Dictionary<>，List<>

不想定义class或者interface的话，可以考虑用这个，前提table下key和value的类型都是一致的。

在Lua中

person = {
	name="wwz",age=18,
	2,3,5,6,"haha",true,	
	addt=function(self,a,b)--self表示table本身
		print(a+b)
	end
}

在C#中，

Dictionary<>只映射有key的value

Dictionary<string, object> dict = luaEnv.Global.Get<Dictionary<string, object>>("person");
foreach (string key in dict.Keys)
{
    print(key + "," + dict[key]);
}

在这里插入图片描述

List<>只映射没有key的，还可以指定类型映射

List<object> list = luaEnv.Global.Get<List<object>>("person");
foreach (object o in list)
{
    print(o);
}

在这里插入图片描述

指定类型映射

List<int> list = luaEnv.Global.Get<List<int>>("person");
foreach (int o in list)
{
    print(o);
}

只映射int类型的
在这里插入图片描述

4.另外一种by ref方式：映射到LuaTable类

这种方式好处是不需要生成代码，但也有一些问题，比如慢，比方式2要慢一个数量级，比如没有类型检查。

LuaTable能映射所有类型，不用生成代码，但性能低，不推荐使用

LuaTable tab = luaEnv.Global.Get<LuaTable>("person");
print(tab.Get<string>("name"));
print(tab.Get<int>("age"));
print(tab.Get<LuaFunction>("add"));
for (int i = 0; i < tab.Length; i++)
{
    print(tab[i]);
}

在这里插入图片描述

访问Lua的function

1.映射到delegate

这种是建议的方式，性能好很多，而且类型安全。缺点是要生成代码（如果没生成代码会抛InvalidCastException异常）。
delegate要怎样声明呢？
对于function的每个参数就声明一个输入类型的参数。
多返回值要怎么处理？从左往右映射到c#的输出参数，输出参数包括返回值，out参数，ref参数。
参数、返回值类型支持哪些呢？都支持，各种复杂类型，out，ref修饰的，甚至可以返回另外一个delegate。
delegate的使用就更简单了，直接像个函数那样用就可以了。

无返回值

function add(a,b)
	print(a+b)
end

[CSharpCallLua]
delegate void Add(int a, int b);

Add add = luaEnv.Global.Get<Add>("add");
add(10,30);

在这里插入图片描述
但是报错了

add = null;//调用完成后，需要置空，没有委托引用没有释放时，  luaEnv.Dispose();会报错

一个返回值

function add2(a,b)
	return a+b
end

[CSharpCallLua]
delegate int Add2(int a, int b);

Add2 add2 = luaEnv.Global.Get<Add2>("add2");
int res =  add2(10, 30);
print(res);
add2 = null;

在这里插入图片描述

多返回值(out或ref)

function add3(a,b)
	return a+b,a,b
end

[CSharpCallLua]
delegate int Add3(int a, int b ,out int resa,out int resb);

Add3 add3 = luaEnv.Global.Get<Add3>("add3");
int resa; int resb;
int res3 = add3(10, 30, out resa, out resb);
print(res3 + "," + resa + "," + resb);
add3 = null;

在这里插入图片描述

2.映射到LuaFunction

这种方式的优缺点刚好和第一种相反。
使用也简单，LuaFunction上有个变参的Call函数，可以传任意类型，任意个数的参数，返回值是object的数组，对应于lua的多返回值。

LuaFunction luaFunction = luaEnv.Global.Get<LuaFunction>("add3");
object[] os = luaFunction.Call(1, 2);
foreach (var o in os)
{
    print(o);
}

在这里插入图片描述

使用建议
1、访问lua全局数据，特别是table以及function，代价比较大，建议尽量少做，比如在初始化时把要调用的lua function获取一次（映射到delegate）后，保存下来，后续直接调用该delegate即可。table也类似。
2、如果lua测的实现的部分都以delegate和interface的方式提供，使用方可以完全和xLua解耦：由一个专门的模块负责xlua的初始化以及delegate、interface的映射，然后把这些delegate和interface设置到要用到它们的地方。

访问Lua的变量

访问Lua的table

访问Lua的function

猜你喜欢