文件加载
例子:打印一个字符串
首先需要实例化一个LuaEnv,你可以讲LuaEnv理解为虚拟机,比较耗费内存,保持全局一个就可以。
LuaEnv luaenv = new LuaEnv();
方式一:luaenv.DoString("print('Hello World!')")
方式二:luaenv.DoString("require 'lua');
print("Hello World!") //lua中打印字符串的代码
测试结果:
C#访问Lua
访问全局基本数据类型的变量
通过访问LuaEnv.Global就可以实现基本数据类型的访问。
lua脚本:
a=10
str="Hello"
b=true
C#脚本
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
Debug.Log(luaenv.Global.Get<int>("a"));
Debug.Log(luaenv.Global.Get<string>("str"));
Debug.Log(luaenv.Global.Get<bool>("b"));
测试结果:
访问全局Function
1、映射到delegate
这种方式,性能好很多,而且类型安全。缺点是要生成代码(如果没生成代码会抛InvalidCastException异常)。
如何生命delegate
对于function的每个参数就声明一个输入类型的参数。
多返回值要怎么处理?从左往右映射到c#的输出参数,输出参数包括返回值,out参数,ref参数。
参数、返回值类型支持哪些呢?都支持,各种复杂类型,out,ref修饰的,甚至可以返回另外一个delegate。
delegate的使用就更简单了,直接像个函数那样用就可以了。
lua脚本:
function Add(i,j)
return i+j;
end;
c#脚本:
[XLua.CSharpCallLua]
public delegate double Add(double i,double j);
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
var add = luaenv.Global.Get<Add>("Add");
var result = add.Invoke(10, 15);
Debug.Log(result);
测试结果:
2、映射到LuaFunction
这种方式的优缺点刚好和第一种相反。
使用也简单,LuaFunction上有个变参的Call函数,可以传任意类型,任意个数的参数,返回值是object的数组,对应于lua的多返回值。
C#脚本:
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
var add = luaenv.Global.Get<LuaFunction>("Add");
var result = add.Call(10,15)[0];
Debug.Log(result);
测试结果:
访问全局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脚本:
myTable={
a=10,
b=20,
}
myTable.Multiply=function(i,j)
return i*j;
end;
function myTable.Add(i,j)
return i+j;
end;
C#脚本:
[XLua.CSharpCallLua]
public delegate double MyDel(double a, double b);
[XLua.CSharpCallLua]
public class CastClass
{
public int a;
public int b;
public MyDel Multiply;
public MyDel Add;
public void da()
{ }
}
[XLua.CSharpCallLua]
public struct CastStruct
{
public int a;
public int b;
public MyDel Multiply;
public MyDel Add;
}
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
var myClass = luaenv.Global.Get<CastClass>("myTable");
var myStruct = luaenv.Global.Get<CastStruct>("myTable");
Debug.Log(myClass.a + " " + myClass.b + " " + myClass.Multiply(10, 15) + " " + myClass.Add(10, 15));
Debug.Log(myStruct.a + " " + myStruct.b + " " + myStruct.Multiply(11, 16) + " " + myStruct.Add(10, 15));
测试结果:
2、映射到一个interface
这种方式依赖于生成代码(如果没生成代码会抛InvalidCastException异常),代码生成器会生成这个interface的实例,如果get一个属性,生成代码会get对应的table字段,如果set属性也会设置对应的字段。甚至可以通过interface的方法访问lua的函数。需要注意的是生成的实例相当于是lua表的引用。改变实例中属性的值,对应的lua表中的字段值也会变化。
Lua脚本:
myTable={
a=10,
b=20,
Multiply=function(self,i,j)
return i*j;
end;
Add=function(self,i,j)
return i+j;
end;
}
c#脚本:
[XLua.CSharpCallLua]
public interface CastIT
{
int a { set; get; }
int b { set; get; }
double Multiply(double i, double j);
double Add(double i, double j);
}
void Start()
{
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
var myIT = luaenv.Global.Get<CastIT>("myTable");
Debug.Log(myIT.a + " " + myIT.b + " " + myIT.Multiply(11, 16) + " " + myIT.Add(10, 15));
测试结果:
3、更轻量级的by value方式:映射到Dictionary<>,List<>
不想定义class或者interface的话,可以考虑用这个,前提table下key和value的类型都是一致的。
4、另外一种by ref方式:映射到LuaTable类
这种方式好处是不需要生成代码,但也有一些问题,比如慢,比方式2要慢一个数量级,比如没有类型检查。
四、使用建议
1、访问lua全局数据,特别是table以及function,代价比较大,建议尽量少做,比如在初始化时把要调用的lua function获取一次(映射到delegate)后,保存下来,后续直接调用该delegate即可。table也类似。
2、如果lua测的实现的部分都以delegate和interface的方式提供,使用方可以完全和xLua解耦:由一个专门的模块负责xlua的初始化以及delegate、interface的映射,然后把这些delegate和interface设置到要用到它们的地方。
Lua调用C#
- lua里头没有new关键字;
- 所有C#相关的都放到CS下,包括构造函数,静态成员属性、方法;
如果有多个构造函数呢?放心,xlua支持重载,比如你要调用GameObject的带一个string参数的构造函数,这么写:
local newGameObj2 = CS.UnityEngine.GameObject('helloworld')
实例;
Lua脚本:
myTable={
obj,
Clone=function()
obj=CS.UnityEngine.GameObject.CreatePrimitive(CS.UnityEngine.PrimitiveType.Cube);
return obj;
end;
Rotate=function()
rotate=obj.transform.eulerAngles;
obj.transform.eulerAngles = rotate+CS.UnityEngine.Vector3(1,0,0);
end;
}
c#脚本:
[XLua.CSharpCallLua]
public interface MyClass
{
GameObject Clone();
void Rotate();
}
MyClass instance;
void Start()
{
LuaEnv luaenv = new LuaEnv();
luaenv.DoString("require 'HotFix'");
instance = luaenv.Global.Get<MyClass>("myTable");
GameObject obj = instance.Clone();
Debug.Log(obj.name);
}
public int max(int a, int b)
{
return a;
}
// Update is called once per frame
void Update()
{
instance.Rotate();
}
测试结果:
项目运行后,在场景中创造了一个立方体,并持续旋转。