文件加載
例子:打印一個字符串
首先需要實例化一個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();
}
測試結果:
項目運行後,在場景中創造了一個立方體,並持續旋轉。