Ravenscript IDEA
提示
下文中的“插件”指RSIDEA这个项目本身，“前置扩展”与“前置Framework”均代指Luals、EmmyLua这样的IDE扩展
描述
RSIDEA是一个帮助modder编写RS脚本的插件，依赖于前端Framework，它可以给modder带来完整的snippet自动补全以及基本类型检查且附带RS官方文档，帮助modder缩短coding用时，减少lua语法错误
特性
✅ 基本完整、简单易用的snippet&type checking
✅ 基本完全还原RS官方文档
✅ 加入RavenM扩展api
✅ 用户annotation支持
✅ 本体与前置Frameworks在开发支持期内
✅ 多IDE兼容
✅ self指针与register(behaviour注册、local常量注入与同步)
❌ 不存在的const / var / static 辨别（前置扩展不支持我也没办法安装
本插件支持Luals与Emmylua（仅兼容）两个前置扩展，即支持VSCode、Neovim、JetBrains IDEA至少四个IDEA（当然如果你会写LSP还能自行支持更多），此处推荐使用Luals
快速安装(仅VSCode)
首先安装Luals for vscode的扩展
完成后,打开一个文件夹或工作区，打开任意一个Lua文件，右键单击选择“Lua: 打开插件管理器”或Ctrl+P打开命令面板输入“>lua.addon_manager.open”
等待插件管理器从Github拉取完插件（可能需要本机安装了git,必须可以访问Github，然后在插件列表找到”Ravenscript IDEA”并启用（Enable），然后尽情享用我们带给你的snippet体验吧~
本地安装
如果你使用的是其他的IDE或你无法使用插件管理器时你才应选择此方式
无法访问github就参考资源镜像
以任何一种方法下载到本项目的git源码到本地的一个文件夹，然后在IDE的前置扩展配置里增加这个文件夹作为外部库即可
例如使用ghproxy.net下载本项目源码（即https://github.com/RavenfieldCommunity/ravenscriptidea/archive/main.zip），解压到本地文件夹如D:\Program\RSIDEA,然后在VSCode的设置的Lua.userThirdParty添加上面你解压的文件夹路径
用法
由于前置扩展与我的开发经验不成熟，因此您在早期开发rs脚本时需遵循以下步骤
更新插件
打开插件管理器即可自动更新, 若出现Update按钮请也一并点击
将鼠标放在代码中的behaviour()上即可检查更新与访问插件管理器
启用RavenM扩展支持
在启用本插件时一并启用Ravenscript IDEA with RavenM
关联文件类型 (不需要)
在新版的RFTools（而非旧的RavenfieldToolPack）中无需配置拓展名关联，Unity可以自动将lua文件识别为TextAsset文件
若你使用的是旧的RavenfieldToolPack，那你就在IDE里把txt扩展名的文件跟Lua语言关联起来，这样才能使用Lua扩展开发rs
请自行上网查找，如VSCode中txt文件关联Lua
用法示例
有时扩展不能自动判断一个变量的类型，需要手动定义，下方示例中的---@type GameObject就是声明这个变量a的类型是GameObject（仅做IDE层面的辅助变量类型判断，在实际运行中不具备任何功能）：
---@type GameObject
a = self.targets.canvas或直接
a = self.targets["canvas"]
a = self.targets[1]当你添加一个事件监听时，扩展不能自动辨别回传参数的类型，，需要手动定义，下方示例中的---@param value int就是声明这个参数value的类型是int（仅做IDE层面的辅助变量类型判断，在实际运行中不具备任何功能）：
---@param value int
function test: OnValueChanged(value)
end---@return bool声明这个function的返回值是bool（仅做IDE层面的辅助变量类型判断，在实际运行中不具备任何功能）：
---@return bool
function test: Calc()
end鸣谢&贡献项目
我估计没有外部贡献者，所以还没打算写贡献指南呢...如果你想帮助我们贡献项目，你可以给我们提issue、留下评论在本站评论区或Steam评论区，我会加紧时间赶写贡献文档，或吸取你的建议修bug和完善插件
❤捐助
欢迎在Steam工坊给我们一个赞和订阅，让我们看到你们的对这个项目的认可，让更多人知道这个插件！