componentscript-helper
协助进行componentscript开发的扩展
运行项目
环境要求：
- VSCode > 1.70
- Node.js > 20
插件使用
注意事项
- 只支持单工作区
- 项目目录结构需要为
- 脚本发布是发布 dist目录下的 play.lua或 play.min.lua 文件
功能说明
扩展启动
在扩展安装成功后，在Output中看到如下提示，代表插件已经初始化
- 输出切换为 componentscript
- Output中提示
- componentscript-helper扩展开始启动
- interllisense加载成功/interllisense加载失败(没有找到定义文件)
- componentscript-helper扩展启动成功
生成模板工程
应对空工程提供的自动目录创建和自动模板入口文件创建，包含GameEntry中的默认方法
- 在Output 界面点击 ...
- 选择 生成模板工程
- 如果workspace无法生成模板工程，不会自动生成
- 自动检查是否有安装 sumneko.lua 扩展
开启联动环境
通信前需要开启联动环境后，才能与项目进行通信
- 在Output 界面点击 ...
- 选择 开启联动环境 后，在OutPut中看到如下提示，代表开启联动环境成功
- 开启联动环境成功，端口：2356 （端口为后续通信端口 起始默认端口为 2356）
- 开启联动环境失败提示
- 开启联动环境 出现问题：后为问题具体信息
- 是否在下次激活时，尝试绑定下一个端口 对话确认
- 确认 下次激活时尝试绑定 默认端口+1 例如：2357
- 取消 保持
结束联动环境
通信或遇到问题可以主动结束联动环境
- 在Output 界面点击 ...
- 选择 结束联动环境 后，在OutPut中看到如下提示，代表结束联动环境成功
联动环境注意事项
- **当前扩展只支持单个项目连接（握手成功的项目保持）**
- **结束联动环境后，需要重新开启联动环境并握手，才可进行后续通信**
合成游戏脚本
由于限制了脚本只能由单个文件构成，所以提供了基于GameEntry入口文件的脚本合成能力，可能存在风险，可以在合成后观察 dist/play.lua 确认，推荐使用其他合成工具进行合成
- 在Explorer 下，右键点击 src/GameEntry.lua文件
- 选择 脚本合成
- 自动清理dist目录并生成
- play.lua
- play.min.lua （紧缩版，使用 luamin ）
- V1版本
- 纯合并脚本
- 合并文件中的如有重名定义，合并的代码存在问题
- V2版本
** 注意 此操作会自动删除 dist目录，请自行做好 dist 目录备份和管理工作**
内部使用(联想生成)
- 生成规则
- 自动识别 __cname = 后声明 为类名
- 自动识别 "方法说明" 部分 为函数提示
- 自动识别 函数名
- 自动识别 参数
- 注意事项
- 需要通过 __cname = "System" 进行类注册
- 类名不可重复
- 在需要生成联想的文件中的function上添加 -- HELPER-API-OUT: "方法说明" 注释
- 注释与function中间不能隔行
- 修改 intellisense_gen.js 中的路径和文件名（本地路径）
- 执行命令 npm Geninterllisense
- 在 res/interllisense 目录下，以 __cname 类名为 文件名保存 json文件
| |
