Xlua学习笔记

最新推荐文章于 2023-05-13 12:02:31 发布
最新推荐文章于 2023-05-13 12:02:31 发布
阅读量574 收藏 4
点赞数
分类专栏： 学习笔记 Lua 文章标签： unity3d lua
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40629631/article/details/107779354
版权

本篇笔记是记录"游戏热更新实战案例（基于xLua）"的学习笔记。
1、Xlua的环境搭建
1）导入Xlua插件
上Github上下载Xlua插件，将Xlua解压，将Asset下的所有文件拷贝到当前项目目录Asset下。拷贝与Asset同级目录下的Tools到该该项目中一样的位置。
2）unity菜单栏 File=》BuildSetting=》playsetting =》OtherSettings=》Scripting Define Symbols 输入HOTFIX_ENABLE
在这里插入图片描述
搭建功能就完成了。
3）复制相关DLL文件
在这里插入图片描述
PS：该捕鱼项目是2017的uinity版本，我用2018打开Xlua部署环境报错，用2017则无问题，原因可能是Xlua版本没有更新，大家学习的时候注意一下版本问题。

2、使用Xlua修复游戏中存在的BUG。
1）如何通过lua文件实现热更新？
首先创建一个调用脚本，挂在物体上，代码如下。这个是固定格式，相关API不明白的话可以自行查阅。


public class HotFixScript : MonoBehaviour {

    private LuaEnv luaEnv;

	void Start () {
        luaEnv = new LuaEnv();
        luaEnv.AddLoader(MyLoader);
        luaEnv.DoString("require'fish'");
	}
	
	void Update () {
		
	}

    private byte[] MyLoader(ref string filePath)
    {
        string absPath = @"C:\Users\Administrator\Desktop\XluaProjects\PlayerGamePackage\"+filePath+".lua.txt";
        return System.Text.Encoding.UTF8.GetBytes(File.ReadAllText(absPath));
    }
    //在OnDestroy前调用，释放已经注册的委托
    private void OnDisable()
    {
        luaEnv.DoString("require'fishDispose'");
    }

    private void OnDestroy()
    {
        luaEnv.Dispose();
    }
}

然后在绝对路径创建lua文件。
在这里插入图片描述
然后在可能会出现问题的类上打上[Hotfix]标签
在这里插入图片描述
在需要修改的函数方法上打上[LuaCallCSharp]标签
在这里插入图片描述
执行到这里的时候就会调用Lua脚本。

功能需求以及解决方法的相关代码。
1.1点击宝箱领取的金币钻石太拥挤，分散一点

--1.1点击宝箱领取的金币钻石太拥挤，分散一点
--常用的变量可以定义一个局部变量去接收
--[[
Lua调用C#中的类要添加前缀CS.
C#中调用自身对象是this.XXX
但是lua中需要加上self.
此处想调用自身的金币， C#完整代码是this.gold，但是在lua中要写全，为self.gold。--]]
local UnityEngine = CS.UnityEngine
--标准格式，第一个参数是C#中打上标签的类（即你想修改的类，第二个参数是要修改的方法，第三个参数是自身）
--此处金币拥挤，我们只需查看代码，将相关间隔的相关代码数值增大即可。
xlua.hotfix(CS.Treasour,'CreatePrize',function(self)
	for i=0,4,1 do
		local go = UnityEngine.GameObject.Instantiate(self.gold,self.transform.position + UnityEngine.Vector3(-10+i*40,0,0),self.transform.rotation)
		go.transform.SetParent(go.transform,self.cavas)
		local go1 = UnityEngine.GameObject.Instantiate(self.diamands,self.transform.position + UnityEngine.Vector3(0,40,0)+ UnityEngine.Vector3(-10+i*40,0,0),self.transform.rotation)
		go1.transform.SetParent(go1.transform,self.cavas)
	end
end)

在这里插入图片描述
lua中代码将30改为40，即可完成这个初步的简单任务。

1.1玩家金币钻石不够时没有相关处理
这个问题处理起来有个小坑，C#代码中调用了私有变量，lua中直接调用会报错，需要加上相关代码，如下。
另外lua中调用自身的方法为XX.Func(self) 或者XX:Func()

--如果想访问私有变量需要加上下面这一行代码，此处bullectAudio是私有变量
xlua.private_accessible(CS.Gun) 
xlua.hotfix(CS.Gun,'Attack',function(self)
	if UnityEngine.Input.GetMouseButtonDown(0) then	

		if UnityEngine.EventSystems.EventSystem.current:IsPointerOverGameObject() then
			return
		end

		if self.gold<1+(self.gunLevel-1)*2 or self.gold==0 then
			return
		end

		self.bullectAudio.clip = self.bullectAudios[self.gunLevel-1]
		--self.bullectAudio.Play(self) 两种调用自身方法的形式
		self.bullectAudio:Play()
			
			if self.Butterfly then
				UnityEngine.GameObject.Instantiate(self.Bullects[self.gunLevel-1],self.attackPos.position,self.attackPos.rotation*UnityEngine.Quaternion.Euler(0,0,20))
				UnityEngine.GameObject.Instantiate(self.Bullects[self.gunLevel-1],self.attackPos.position,self.attackPos.rotation*UnityEngine.Quaternion.Euler(0,0,-20))
			end

			UnityEngine.GameObject.Instantiate(self.Bullects[self.gunLevel-1],self.attackPos.position,self.attackPos.rotation)

			if not self.canShootForFree then
				self:GoldChange(-1-(self.gunLevel-1)*2)
			end
			self.attackCD =0
			self.attack = false
		end
end)

–1.2 技能扣除钻石太多
解决方法，一样查看相关代码，然后修改
在这里插入图片描述
发现代码写在Start中，这里要注意，我们调用luaEnv的脚本要写在Awake中，补丁需要在代码前执行。写在Start顺序可能会出问题从而导致无效。

xlua.private_accessible(CS.Fire)
xlua.hotfix(CS.Fire,'Start',function(self)
	self.reduceDiamands = 8
end)

–1.2boss撞击玩家数值变动一样且不是减少是增加
依旧和之前一样，找到相关代码，用lua修改
在这里插入图片描述
但这次使用更简便的方法，不需要重写全部，而是在执行完之后再执行我们的lua代码
需要注意，util的这个文件要和当前的lua脚本在同级目录下，这个文件可以下xlua文件下种搜索到。复制过来粘贴即可。注销委托的时候格式与之前一样，依旧是xlua.hotfix(CS.Boss,‘Start’,nil)

local util = require 'util'
xlua.private_accessible(CS.Boss)
util.hotfix_ex(CS.Boss,'Start',function(self)
	self:Start()
	self.m_reduceGold = self.m_reduceGold-10;
end)

–1.3 boss撞击玩家当钻石金币不够时产生负数
这个与之前有点区别，需要传参，改动方法如下
在这里插入图片描述

util.hotfix_ex(CS.Gun,'GoldChange',function(self,number)
	self:GoldChange(number)
	if self.gold <-number then
		self.gold = 0
		return	
	end
end)

–1.4捕鱼概率修改
捕鱼代码中用到了GetComponent方法，但是lua中不支持泛型，好在C#中也支持参数为string的GetComponent方法，穿的参数改为string类型即可。

itemGo:GetComponent('Gold').bossPrize = true

–1.4游戏操作方式更改
无新的知识点，lua重写代码即可。

–2.0新增海浪
这个比较麻烦，首先需要一个预制体，其次这个预制体上还要有脚本代码。解决方法，先创建一个空的脚本，里面有几个常用的空方法，挂在预制体上，然后打包成AssetBundle文件上传至服务器，加载的时候可以先从服务器下载到本地指定位置，然后再读取。

//空的C#脚本，留给lua脚本实现
[Hotfix]
public class HotFixEmpty : MonoBehaviour {

	// Use this for initialization
	void Start () {
		
	}
	
	// Update is called once per frame
	void Update () {
		
	}
    private void BehaviourMethod()
    {

    }

    private void OnTriggerEnter(Collider other)
    {
        
    }

}

--2.0新增海浪
--lua脚本实现功能。
xlua.private_accessible(CS.HotFixEmpty)
xlua.hotfix(CS.HotFixEmpty,'Start',function(self)
	self:Invoke('BehaviourMethod',8)
end)

xlua.hotfix(CS.HotFixEmpty,'Update',function(self)
	self.transform:Translate(-self.transform.right*4*UnityEngine.Time.deltaTime,UnityEngine.Space.World)
end)

xlua.hotfix(CS.HotFixEmpty,'OnTriggerEnter',function(self,other)
	if other.tag~='Untagged' and other.tag~='Wall' then
	UnityEngine.Object.Destroy(other.gameObject)
	end
end)

xlua.hotfix(CS.HotFixEmpty,'BehaviourMethod',function(self)
	CS.Gun.Instance.level = CS.Gun.Instance.level + 1
	if CS.Gun.Instance.level == 4 then
		CS.Gun.Instance.level = 1
	end
	canCreateNewFish = true
	CS.Gun.Instance.changeAudio = true
	UnityEngine.Object.Destroy(self.gameObject)
end)

总结：使用Xlua时需要注意的坑。
1、普通成员方法与静态成员方法调用的区别。
静态成员方法直接XX.Function()即可。有参数直接写在括号里 XX.Function(a,b…)
普通成员方法调用格式为 XX.Function(self)有参数写在self后面 XX.Function(self，a,b)
或者XX:Function()有参数直接写在括号里XX:Function(a,b)
2、lua中不存在new，如果C#脚本中存在new，直接无视即可。
3、lua中不支持泛型，如果C#中用到了泛型，请替代为string参数，或者单独写一个方法获取值，lua调用方法获得返回值
4、过于复杂的代码建议C#实现，lua直接调用即可，虽然lua也能实现，但是比较麻烦且性能消耗不如C#，例如

[LuaCallCSharp]
    public void LoadResource(string resName,string filePath)
    {
        StartCoroutine(LoadResourceCorotine(resName, filePath));
    }

    IEnumerator LoadResourceCorotine(string resName, string filePath)
    {
        UnityWebRequest request= UnityWebRequest.GetAssetBundle(@"http://localhost/AssetBundles/" + filePath);
        yield return request.SendWebRequest();
        //AssetBundle ab = AssetBundle.LoadFromFile(@"C:\Users\Administrator\Desktop\XluaProjects\FishingJoy\AssetBundles\" + filePath);
        AssetBundle ab =(request.downloadHandler as DownloadHandlerAssetBundle).assetBundle;
        GameObject gameObject = ab.LoadAsset<GameObject>(resName);
        prefabDict.Add(resName, gameObject);
    }

xlua.hotfix(CS.CreateFish,'Start',function(self)
	self.hotFixScript:LoadResource('level3fish3','gameobject\\enemy.ab')
	self.hotFixScript:LoadResource('SeaWave','gameobject\\wave.ab')
end)

这里lua调用起来就很方便。
5、lua主要是用来修复紧急BUG，不建议做大改动，例如2.0版本开发的海浪功能，先把资源打包好上传到服务器，代码全部是lua写，开发效率较低。
如果预制体上挂有脚本，本地一定要先有脚本在解压，不然AssetBundle解压出来没有脚本则会丢失，无法完成相应的功能。

资源图片较多，文件较大，想看源码的建议移步siki学院搜索热更新

听雨眠丨
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
XLua学习
a977621265的博客
04-09 945
所有的lua代码都是在lua虚拟机上跑的，一个LuaEnv实例对应一个lua虚拟机。 出于开销考虑，官方建议全局唯一： XLua.LuaEnv luaenv = new XLua.LuaEnv(); 一、lua文件的执行和加载 LoadString：加载一个代码块，但不执行，返回类型可以指定为一个delegate或者一个LuaFunction T LoadString(stri...
XLua学习分享，插件下载，直接复制到Unity项目
03-30
Xlua快速下载通道。分享学习
XLua热更新 - 学习笔记
06-06
一些简单的学习笔记和资源
Xlua学习
diqu0694的博客
08-09 146
1.Xlua中在哪添加新的搜索路径，如何自定义搜索脚本路径 2.util.lua脚本的路径 3.脚本最后的return含义：返回到之前require这个lua脚本的地方，一般用一个变量来接，返回的一般是一个表。 4.如何打印已经加载过的表(require列表) for k,v in pairs(package.loaded) do prin...
xLua学习
liuhongze98的博客
10-10 1014
什么是冷更新 开发者将测试好的代码，发布到应用商店的审核平台，平台方会进行稳定性及性能 测试。测试成功后，用户即可在AppStore看到应用的更新信息，用户点击应用更 新后，需要先关闭应用，再进行更新。 什么是热更新 广义：无需关闭应用，不停机状态下修复漏洞，更新资源等，重点是更新逻辑代码。 狭义定义（ iOS热更新）：无需将代码重新打包提交至AppStore，即可更新客户端 的执行代码，即不用下载app而自动更新程序。 现状：苹果禁止了C#的部分反射操作，禁止JIT（即时.
xLua学习(一)
qq_36386954的博客
03-21 2179
xLua作为企鹅这个大厂开源出来的unity热更新技术，从面世就受到了广泛的关注，他的“开发使用C#，运行使用C#，有bug了下发Lua补丁替代”让我很感兴趣。非常适合比如已经开发大半使用C#开发的项目，若改为tolua等热更技术，费时又费力，而xLua则可以很好地打上标记，便可以在之后的项目中实现热更。这也是我看好xLua的原因。于是，就从零开始一点点踩坑吧。 这是我C#中的一个类型： us
XLuaS.zip Xlua学习工程 c#与xlua 相互调用
10-06
xlua 学习工程
xLua框架源码
09-16
xLua源码，使用方法 将Assets文件夹导入工程测试 详细请看文件中ReadMe.md
mac M1 xlua 重新编译的 xlua bundle
最新发布
04-10
xlua 在 mac M1 芯片的机器上报错,重新编译后可以使用
Unity-XLua快速学习
再学一个就睡的博客
04-11 588
Unity-XLua使用Lua文件加载执行字符串加载Lua文件自定义LoaderC#访问Lua获取一个全局基本数据类型访问一个全局的table映射到普通class或struct映射到一个interface更轻量级的by value方式：映射到Dictionary<>，List<>另外一种by ref方式：映射到LuaTable类访问一个全局的function映射到delegate映射到LuaFunctionLua调用C#new C#对象访问C#静态属性，方法访问C#成员属性，方法 X
XLUA学习--C#访问Lua全局函数
qq_25023405的博客
04-01 908
上一篇讲到了通过接口的形式，可以访问表内部的函数，那如果这个方法是一个全局的函数，就是这篇博客要讲解的。 先上Lua中的代码。 function TestOne() print('no parm') end function TestTwo(a,b) print(a,b) end function TestThree(a,b) return a+b end function Tes...
XLua学习心得
U3D开发
07-09 360
一、XLua简介 XLua作为腾讯近年来一大开源贡献，受到了业界的广泛好评。除了常规的Lua绑定植物，最重要的就是代码热补丁。 官网： https://github.com/Tencent/xLua 配置文档： https://github.com/Tencent/xLua/blob/master/Assets/XLua/Doc/hotfix.md 官方FAQ： https://github.c...
xLua学习总结（一）---环境配置
l17768346260的博客
12-19 364
游戏上线后，经常会发现需要修复的bug，以及节日期间会有新的活动上线，由于C#编写的程序在unity打包后会编译成dll文件，修改C#代码后只能编译后重新打包，然而让玩家重新下载安装包是不现实的。因此，游戏热更新是必须的。 使用unity开发的游戏，游戏资源的更新可以使用下载新的Assetbundle方式，游戏内代码bug的修复，可以下载新的lua代码，来覆盖原先的逻辑，腾讯退出的xLua热更新...
xLua学习案例
qq_43027280的博客
05-31 391
xLua使用案例 需引用命名空间XLua 简单案例1 在c#中直接调用lua代码 LuaEnv luaEnv = null; private void Start() { //创建lua的运行环境 为防止内存大量消耗 建议全局里只存在一个实例 luaEnv = new LuaEnv(); //需要传递一个字符串 内容为...
初识xLua(二)
好的都要记下来
02-16 527
标签 [Hotfix] 给要修改的类，所打上的标签 [LuaCallCSharp] 给要修改的 C# 方法，所打上的标签 [CSharpCallLua] 给要调用到 lua 方法的，或者是要从 lua 映射过来的方法，所打上的标签 修改一个方法 例如，要修改下面的这个方法，这个方法在 Treasour 这个类中 [LuaCallCSharp] private void Cre...
Xlua学习笔记：调用C#脚本里的类的私有属性
chh19941125的专栏
11-05 767
一个类的私有属性可以访问要在Lua中添加 xlua.private_accessible(CS.DeffendBoss)
XLua脚本中调用C#脚本类中的私有成员以及静态和非静态成员方法
weixin_42186644的博客
12-29 2200
1.xlua框架，访问C#脚本中类的私有成员变量，在访问的方法前添加如下代码即可 xlua.private_accessible(CS.C#类名) 2访问静态成员方法 xlua.hotfix(CS.类名,‘修补的C#中的方法名’,function(self) - -lua文件中对C#里面的方法进行实现 self.静态成员方法 self:非静态成员方法 end ...
xlua 热更新原理及实现思路
Speculator_m的博客
05-13 1181
本人刚刚接触编程的菜鸟，很少写过文章，在这里记录学习笔记并跟大家分享学习经验，如有不对的地方，愿不吝赐教。unity C#代码，在运行的时候，先把所有代码(框架+逻辑)都加载到内存，然后执行代码，所以代码加载完成，就无法再改了, 所以普通的C#代码，无法做代码热更新。
unity使用xlua
05-30
使用XLua可以在Unity中实现Lua脚本的编写，同时也可以让Lua脚本与C#代码进行交互。 以下是基本的使用步骤： 1. 下载XLua插件并导入到Unity中。 2. 在Unity中创建一个新的Lua文件，编写Lua脚本代码。 3. 在C#代码中使用XLua的API来加载并运行Lua脚本，例如： ``` using XLua; public class LuaManager : MonoBehaviour { private LuaEnv luaEnv; void Awake() { luaEnv = new LuaEnv(); luaEnv.DoString("require 'main'"); // 加载并执行Lua脚本 } void Update() { luaEnv.Tick(); // 更新Lua环境 } void OnDestroy() { luaEnv.Dispose(); // 释放Lua环境 } } ``` 在上面的例子中，`Awake()`方法中创建了一个Lua环境，然后通过`DoString()`方法加载并执行了Lua脚本。`Update()`方法中每帧都调用了`Tick()`方法来更新Lua环境，`OnDestroy()`方法中释放了Lua环境。需要注意的是，在实际的项目中，可能需要更加复杂的逻辑和管理方式来处理Lua脚本的加载和运行。 4. 在Lua脚本中使用XLua提供的API来调用C#代码或者导出Lua模块，例如： ``` -- 导出一个Lua模块 local module = {} module.foo = function() print("Hello from Lua!") end return module -- 调用C#代码 local gameObject = CS.UnityEngine.GameObject("LuaObject") local transform = gameObject.transform transform.position = CS.UnityEngine.Vector3(1, 2, 3) ``` 在上面的例子中，导出了一个名为`module`的Lua模块，并定义了其中的一个函数`foo()`。同时，也调用了C#代码的API来创建了一个新的GameObject，并修改了它的Transform组件的位置。 XLua还提供了其他的功能，例如自定义导出规则、GC优化等。在使用XLua之前，建议先了解一些基本的Lua语法和C#与Lua交互的机制，以便更好地使用XLua。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值