cloudisdeep/y3-lualib

y3-lualib

这是Y3编辑器的Lua开发框架，旨在帮助 纯Lua开发者 更好的开发地图。 本项目希望可以和广大用户共同开发此框架，因此希望大家可以积极提出建议，包括框架设计也可以提出自己的想法一起讨论。

快速开始

自动初始化

• 使用Y3编辑器创建一张地图，
• 在VSCode中安装扩展 sumneko.y3-helper
• 在左侧边栏选择“Y3开发助手”，点击“初始化Y3库”

手动初始化

• 使用Y3编辑器创建一张地图，并打开地图目录（默认为 <地图工程>/maps/EntryMap）
• 然后将地图内的 script/y3 目录替换为此工程
• 你可以双击运行一下 script/y3/初始化配置.bat，他可以帮你配置插件环境与调试器
• 使用VSCode打开 script 文件夹

注意：如果你是用的编辑器是1.0版本，请将此项目的分支切换到 1.0

演示图

从演示图开始学习Lua!

界面

包含：

• 主控面板（头像、属性、技能、物品栏、血条、商店）
• 按住空格或点击头像将镜头聚焦在此单位身上

启用方法：

• 在Lua代码中加入 require "y3.演示.demo.界面"
• 在编辑器中点击 菜单栏 -> 插件 -> 插件商城，搜索 LuaLib，安装 LuaLib示例-界面（美术资源）

防守图

包含：

• 简单的5波怪物进攻
• 英雄死亡或场上的怪物超过30个后失败
• 消灭所有怪物后胜利

启用方法：

• 在Lua代码中加入 require "y3.演示.demo.防守图"
• 在编辑器中点击 菜单栏 -> 插件 -> 插件商城，搜索 LuaLib，安装 LuaLib示例-防守图（英雄、技能、怪物的物编数据）

练功房

包含：

• 英雄进入**区域后刷怪
• 怪物死亡后继续刷出下一波
• 英雄离开**区域5秒后怪物小时

启用方法：

• 在Lua代码中加入 require "y3.演示.demo.练功房"
• 在编辑器中点击 菜单栏 -> 插件 -> 插件商城，搜索 LuaLib，安装 LuaLib示例-练功房（英雄、技能、怪物的物编数据）

装备合成与商店购买

包含：

• 配置配方
• 拾取地上的物品后根据配方合成
• 在商店中购买物品，自动扣除已有的组件并扣除差价

启用方法：

• 创建的地图要使用 Y3 物编（用于演示用的物品）
• 在Lua代码中加入 require "y3.演示.demo.合成"
• 在编辑器中点击 菜单栏 -> 插件 -> 插件商城，搜索 LuaLib，安装 LuaLib示例-界面（用于显示商店）

Q&A

该框架的代码与“ECA转Lua”的代码有什么关系？

绝大部分的接口会保持兼容，但是对于纯Lua作者来说，很多功能有更好的实现方式。比如ECA中的动作“将整数加一”在“ECA转Lua”时会生成函数调用，但在此框架中该函数被移除了。 而触发器、事件等功能也会和ECA中的有较大差异，利用Lua的语言特性使用了更加方便Lua开发的形式。

我看很多函数都是简单的转发，是否可以直接调用CAPI？

尽量不要直接调用。因为目前已经有计划修改CAPI，直接调用CAPI可能会在未来产生兼容性问题。

ECA与Lua协同开发时，ECA如何调用Lua函数？

ECA可以直接执行Lua代码，你也可以参考此代码注册一个绑定函数供ECA调用。

在Lua中使用的模型与特效无法显示？

我们的模型资源是动态下载的，您需要显式申明你使用的模型。申明方式是在表格编辑器中新建一个表格，然后在里面填入你使用的模型或特效资源ID即可。这张表格无需在游戏中实际使用。

Y3的Lua虚拟机与官方实现有什么差异？能否使用一些不安全的函数？

Y3的Lua虚拟机进行过修改与定制，详细请参阅这篇文档。

如何使用日志

在代码中使用 log.info('日志内容') 写日志，在开发模式中日志会写到脚本目录的 log/lua_player01.log 中。在平台上运行时日志会写到地图目录的 custom/lua_player01.log 中。文件名后两位数字代表你在游戏中的玩家ID，在本地多开时会生成多个日志文件。在平台上运行时，完整的日志路径大概是 .../kkduizhan/Games/y3/2.0/game/LocalData/etc/maps/<加密地图名>/custom/lua_player01.log 。

如果你只是想快速的临时看一下，可以直接使用 print('内容') ，这些内容会直接在游戏内显示。上传地图前别忘了去掉 print 。

使用VSCode进行附加调试

1. VSCode在扩展市场中搜索安装插件 sumneko.y3-helper。
2. 点击左侧功能栏中的“Y3开发助手”视图
3. 点击视图中的“启动游戏并附加调试器”开始调试（快捷键：Shift+F5）

5月9号编辑器更新后，将不再兼容旧的 actboy168.lua-debug，请务必使用此方法进行调试。在没有更新之前，你可以继续使用之前的调试方法，或是在设置中将 Y3-Helper.DebuggerVersion 设置为 old。

已知问题

• 无法追踪一些内部函数的执行。

工程结构

📦 y3/
    ├── 📁 演示/
    ├── 📁 game/
    │    ├── 📜 const.lua
    │    ├── 📜 game.lua
    │    ├── 📜 helper.lua
    │    ├── 📜 py_converter.lua
    │    ├── 📜 py_event_subscribe.lua
    ├── 📂 meta/
    ├── 📂 object/
    │    ├── 📁 editable_object/
    │    ├── 📁 runtime_object/
    │    ├── 📁 scene_object/
    ├── 📂 tools/
    ├── 📂 tools/
    ├── 📜 debugger.lua
    └── 📜 init.lua

想要做的事情

见 开发计划

贡献者