游戏中调用LUA脚本的开发及调试 - 版本历史

2024年3月26日 (二) 07:08 Skyswordkill

2024-03-26T07:08:44Z

Skyswordkill：/* 安装LUA脚本开发IDE工具 */

2024-03-26T07:08:00Z

安装LUA脚本开发IDE工具

Skyswordkill：/* 安装LUA脚本开发IDE工具 */

2024-03-26T06:58:58Z

安装LUA脚本开发IDE工具

Skyswordkill：/* 使用插件设置表挂载Lua逻辑 */

2022-06-03T10:29:03Z

使用插件设置表挂载Lua逻辑

Skyswordkill：/* 使用插件设置表挂载Lua逻辑 */

2022-06-03T10:26:09Z

使用插件设置表挂载Lua逻辑

2022年6月3日 (五) 09:47 Skyswordkill

2022-06-03T09:47:09Z

Kevintien86：/* 如何在MOD中运行及调试脚本 */

2020-06-02T07:09:55Z

如何在MOD中运行及调试脚本

Kevintien86：/* 如何在MOD中运行及调试脚本 */

2020-04-30T03:50:35Z

如何在MOD中运行及调试脚本

Kevintien86：/* 如何在MOD中运行及调试脚本 */

2020-04-30T03:50:29Z

如何在MOD中运行及调试脚本

Kevintien86：/* 安装LUA脚本开发IDE工具 */

2020-04-30T03:19:19Z

安装LUA脚本开发IDE工具

@@ 第22行： / 第22行： @@
    [[文件:Imgpic 3.png|735x735像素]]
    [[文件:Imgpic 4.png|568x568像素]]
 *如果想要调试功能能正常运行，则VsCode必须以工作区的方式打开。
@@ 第43行： / 第48行： @@
    [[文件:Lua Img 4.png|489x340像素]]
 <br />

@@ 第5行： / 第5行： @@
 *在VSCode插件栏中选择Emmylua并下载
-   [[文件:Emmylua.png|595x595像素]]
+   [[文件:Emmylua.png|700x410像素]]
 *由于xlua的lua文件格式是.lua.txt的，所以vscode默认情况下并不能将其识别为lua文件，需要我们通过settings来完成
@@ 第23行： / 第23行： @@
    [[文件:Imgpic 4.png|568x568像素]]
-*在调试选项中选择生成launch.json，然后选择LuaPanda；
+*如果想要调试功能能正常运行，则VsCode必须以工作区的方式打开。
-注意：如果没有看到luapanda，需要重启一下VsCode，或者将其它调试器关掉后重启；
+打开后，我们需要保存工作区，从VsCode顶部 文件-将工作区另存为 把工作区设置储存为一个文件。此时VsCode顶部应当显示：
-生成了如下三种配置，这里我们需要注意的设置就是luaFileExtension选项，我们需要配置成我们xlua的格式，也就是".lua.txt"；
+  [[文件:Lua Img 1.png|338*42像素]]
-   [[文件:Imgpic 5.png|678x678像素]]
 === 如何在MOD中运行及调试脚本 ===

@@ 第1行： / 第1行： @@
 ===安装LUA脚本开发IDE工具===
-开发者可以使用任何趁手的工具来编写LUA脚本。这里我们为了调试方便所以采用了VsCode + LuaPanda插件来编辑LUA脚本，并能实现断点调试、变量监控等功能
+开发者可以使用任何趁手的工具来编写LUA脚本。目前推荐使用VsCode + Emmylua插件来编辑LUA脚本，并能实现断点调试、变量监控等功能
 *安装微软VsCode开发工具。VSCode下载地址：https://code.visualstudio.com/
-*在VSCode插件栏中选择LuaPanda并下载
+*在VSCode插件栏中选择Emmylua并下载
-   [[文件:Img 1.png|884x884像素]]
+   [[文件:Emmylua.png|595x595像素]]
 *由于xlua的lua文件格式是.lua.txt的，所以vscode默认情况下并不能将其识别为lua文件，需要我们通过settings来完成

@@ 第146行： / 第146行： @@
 tagCamp: 类型HanFramework.GameCampRtData，当前进行逻辑判断的阵营
-curDay: 游戏当前天数
+curDay: 类型int，游戏当前天数
 只有参与游戏斗争的已激活阵营才会执行阵营逻辑

@@ 第44行： / 第44行： @@
 === 使用插件设置表挂载Lua逻辑 ===
-当需要将自定义的Lua逻辑挂载到游戏中时，可以通过插件设置表来实现。
+当需要将自定义的Lua逻辑挂载到游戏中时，可以通过插件设置表来实现。通过指定要挂载的逻辑，并绑定挂载的函数后，游戏会在对应逻辑执行时，自动执行挂载逻辑。
 推荐使用该方式新增Lua逻辑，以避免Lua脚本的冲突
-在插件设置表中可配置的Lua挂载逻辑如下：
+在插件设置表中可配置的Lua挂载逻辑如下
 {| class="wikitable"
 |+
@@ 第59行： / 第60行： @@
 |on_game_start
 |脚本名#函数名
-|<syntaxhighlight lang="lua">
+|<syntaxhighlight lang="lua" >
 function onGameStart()
      -- 进入游戏时进行的操作
@@ 第65行： / 第66行： @@
 </syntaxhighlight>
 |进入游戏或载入游戏后运行
 |}

@@ 第30行： / 第30行： @@
    [[文件:Imgpic 5.png|678x678像素]]
-===如何在MOD中运行及调试脚本===
+=== 如何在MOD中运行及调试脚本 ===
 游戏中的Lua脚本代码最终必须映射到资源目录“Asset\BuildSource\LuaScripts\”下来运行。运行时可以使用 RUN_SCRIPT 或者 RUN_SCRIPT_FUNC 来调用脚本或者脚本中的函数（具体见通用剧情事件指令说明）。
@@ 第42行： / 第42行： @@
 <br />
 === 如何重写游戏核心逻辑脚本 ===
@@ 第135行： / 第159行： @@
 返回值：查询结果整形数字
 |}

←上一版本		2020年6月2日 (二) 07:09的版本
第42行：		第42行：

	<br />		<br />
		+
		+	=== 如何重写游戏核心逻辑脚本 ===
		+	在0.7.4.1版本以后，我们逐渐将游戏的一些核心逻辑放到LUA脚本中，这样MOD制作者就可以改写自己的一些游戏核心逻辑（如外交、内政、好感度系统等）。后续还将陆续开放战斗数值结算等相关的核心逻辑接口，以给予MOD制作者更大的发挥创意的空间。
		+
		+	目前游戏内置的主要逻辑接口代码都写在位于映射路径“Asset\BuildSource\LuaScripts\GameLogics.lua.txt”的LUA脚本中（源代码可在游戏根目录下\ModSamples\LuaScripts\文件夹中找到），通过MOD设置中的override功能映射该路径就可以对指定的LUA脚本进行替换重写了。
		+
		+	GameLogics.lua.txt脚本中的主要代码接口有：
		+	{\| class="wikitable"
		+	\|+
		+	!接口方法
		+	!用途
		+	!参数说明
		+	\|-
		+	\|OnGameStart()
		+	\|每次进入游戏（或是载入游戏后）会调用此接口
		+	\|无参数
		+	\|-
		+	\|GetLuaStringVal(valKey, contextArgVal)
		+	\|[$lua_str:KEY$]查询指令对应的接口
		+	\|valKey：查询字段的KEY
		+	contextArgVal：查询指令调用时的环境变量参数
		+
		+	返回值：查询结果字符串
		+	\|-
		+	\|GetLuaIntVal(valKey, contextArgVal)
		+	\|[$lua_int:KEY$]查询指令对应的接口
		+	\|valKey：查询字段的KEY
		+	contextArgVal：查询指令调用时的环境变量参数
		+
		+	返回值：查询结果整形数字
		+	\|-
		+	\|SetRoleRep(opRole, targetType, tagID, opVal, isAdd, isNotify, isChainedMode)
		+	\|游戏内为角色改变对应声望的接口
		+	\|opRole：执行操作的角色对象
		+	targetType：操作对象类型 0：阵营 1：角色 2：地点
		+
		+	tagID：操作对象的ID
		+
		+	opVal：操作值
		+
		+	isAdd：是否改变模式，当为true时在原值上加减，否则为直接设置到目标值
		+
		+	isNotify：当涉及主角时是否进行信息播报
		+
		+	isChainedMode：是否进行链式操作（关联好感度的对象进行改变）
		+
		+	返回值：查询结果整形数字
		+	\|-
		+	\|GivePresentLogic(contextArgVal)
		+	\|给NPC送礼物涨好感度的逻辑接口
		+	\|contextArgVal：调用此逻辑时的环境变量参数
		+	返回值：无
		+	\|-
		+	\|OnCampDailyLogic(tagCamp, curDay)
		+	\|阵营每日逻辑（游戏中每天都会对所有阵营执行此逻辑接口）
		+	\|无参数和返回值
		+	\|-
		+	\|OnAIDecideDipEvent(execCamp, dipInfo)
		+	\|AI势力决定外交行为的判断(玩家处理外交行为逻辑通过处理 dip_event 触发器事件来决定)
		+	\|execCamp：当前执行此外交事件的阵营对象
		+	dipInfo：当前执行外交事件的详细信息，类型为DiplomaticEventInfo，其数据结构如下：
		+
		+	* public GameCampRtData fromCamp;
		+	* public GameCampRtData execCamp;
		+	* public int dipType;
		+	* public string tagRoleID;
		+	* public string argsVal;
		+	* public float resultRatio;
		+	* public bool isDecided;
		+
		+	返回值：无
		+	\|-
		+	\|OnDipEventCallback(dipResult, dipInfo)
		+	\|游戏中所有阵营执行外交事件处理结果接口
		+	\|dipResult：外交事件结果 true 同意 false 拒绝
		+	dipInfo：同上
		+
		+	返回值：无
		+	\|-
		+	\|SetCampRl(campID1, campID2, rlState, fvOpMode, fvOpVal, isNotify)
		+	\|游戏中所有操作阵营外交关系时执行的接口
		+	\|campID1：外交关系对象A
		+	campID2：外交关系对象B
		+
		+	rlState：欲改变至的外交状态 -1：不改变 0：中立 1：敌对 2：结盟
		+
		+	fvOpMode：外交好感度的操作方式：0:不改变 1：增加 2：设置到目标值
		+
		+	fvOpVal：外交好感度操作值
		+
		+	isNotify：当涉及玩家时是否进行信息播报
		+
		+	返回值：查询结果整形数字
		+	\|-
		+	\|
		+	\|
		+	\|
		+	\|}

@@ 第37行： / 第37行： @@
 编写脚本时，可以在脚本中加入下列代码来开启脚本调试功能，当调用该脚本后，就可以在VsCode中对该脚本中的任意代码位置打断点进行调试等操作了。
-require("LuaPanda").start("127.0.0.1",8818)
+  require("LuaPanda").start("127.0.0.1",8818)
 当调试结束后记得注释掉该行以提高游戏性能。
 <br />

←上一版本		2020年4月30日 (四) 03:50的版本
第31行：		第31行：

	===如何在MOD中运行及调试脚本===		===如何在MOD中运行及调试脚本===
−	~~目前游戏中~~	+	游戏中的Lua脚本代码最终必须映射到资源目录“Asset\BuildSource\LuaScripts\”下来运行。运行时可以使用 RUN_SCRIPT 或者 RUN_SCRIPT_FUNC 来调用脚本或者脚本中的函数（具体见通用剧情事件指令说明）。
		+
		+	如： RUN_SCRIPT_FUNC*test_script#TestFunc1
		+
		+	编写脚本时，可以在脚本中加入下列代码来开启脚本调试功能，当调用该脚本后，就可以在VsCode中对该脚本中的任意代码位置打断点进行调试等操作了。
		+
		+	require("LuaPanda").start("127.0.0.1",8818)
		+
		+	当调试结束后记得注释掉该行以提高游戏性能。
		+
		+	<br />