ministudio README

描述

• 专为MiniStudio设计的扩展。支持节点显示、多种语言编写、API补全等功能。帮助开发者提高MiniStudio代码编辑效率！

快速使用

• 1.打开[MiniStudio]

• 2.点击左上角[文件]

• 3.点击[打开脚本文件夹]

• 4.将文件夹[game]拖入VS code的文件视图

• 5.输入快捷键[Ctrl+Shift+E]（Windows 和 Linux）[Cmd+Shift+E]（macOS）

• 6.打开[GAME]选项，开始编辑你的代码吧！

节点视图树

• 继承MiniStudio的节点显示方式

• 自动或手动显示节点类型图标

由于VSCode无法检测MiniStudio的节点类型，开发者可手动设置节点图标显示，提高节点可读性，不影响MiniStudio内节点

引用其他文件

• 在节点视图树中，为每个代码节点提供了引用其他文件选项

• 引用其他现有的代码文件，例如JSON库，无需手动复制，提高开发效率与可扩展性

• 实时引用同步，节点视图树可直接编辑引用的文件，并实时同步至源文件

语言功能

Lua

• 代码示例

  --获取API自动补全，需要且必须通过以上格式才能获得补全支持。如果没有提示补全API，请重VScode
  local result=SandboxNode.New(Node)
  local result=game.getService(Service)
  --在game.WorkSpace创建UIButton节点
  local buttom = SandboxNode.New("UIButton", game.WorkSpace)
  --输入button后会补全提示Title
  button.Title = "Button"
  
  --获取FriendsService服务
  local friendsService=game:GetService("FriendsService")
  --输入friendsService后会补全提示GetSize
  local size=friendsService.GetSize()
  

TypeScript

• 扩展设置中将编程语言改为[ts]将启用TypeScript编辑

• 资源管理器Game视图树-TypeScriptToLua，自动执行 ts 至 lua 的转换

• TypeScriptToLua使用规范

• 虽然[ts]具有许多优点，但在MiniStudio环境上也存在一些缺点：开发人员需要具备[ts]和lua能力、运行错误无法显示[ts]代码中的行数、仅模块代码可使用[export]

• 代码示例

  节点结构
  game
  │ 
  ├── WorkSpace 
  │   └──ModuleScript 
  │ 
  └── StartPlayer 
      └── LocalScript <=当前代码节点 
          └── ModuleScript 
  

  //TypeScript代码
  //从根目录导入
  import {valueName} from "WorkSpace/ModeluScript"
  
  //从相对路径导入
  import {valueName} from "./StartPlayer/LocalScript/ModeluScript"
  
  //从相对路径导入 
  import*as valueName from "./StartPlayer/LocalScript/ModeluScript"
  
  console.log("Hello, World!")
  

  --TypeScriptToLua Lua代码
  --从根目录导入
  local ___ModeluScript = require(game.WorkSpace.ModeluScript)
  local valueName = ___ModeluScript.valueName
  
  --从相对路径导入
  local ___ModeluScript = require(script.StartPlayer.LocalScript.ModeluScript)
  local valueName = ___ModeluScript.valueName
  
  --从相对路径导入
  local valueName = require(script.StartPlayer.LocalScript.ModeluScript)
  
  print("Hello, World!")
  

扩展设置

• MiniStudio扩展支持开发者可以根据个人喜好自定义一些设置，输入快捷键[Ctrl+,]（Windows 和 Linux）[Cmd+,]（macOS）后搜索“MiniStudio”更改设置

• 选择编程语言：设置后自动配置节点视图树，可直接编辑代码，部分代码需要转lua才能运行测试

• 限制目录下启用扩展

注意事项

• 修改文件：删除、创建、重命名文件需要在MiniStudio进行，直接修改文件不仅无效，还可能导致其他错误

更新计划

• MiniStudio扩展在不断地更新与优化，为广大开发者带来刚好的体验

• 1.Lua枚举和数据的API补全提示

• 3.Camera图标

• 4.SpawnLocation1图标

• 5.Terrain图标

• 6.StarterPack图标

贡献者

Mickey

• 联系方式：190575170@qq.com
• 迷你账号：558426242
• 桌面应用扩展开发、概念艺术复制

司空新柔

• 提供文档API-类复制版

小黑

• 提供面向全球的文档网址

牛排果酱

• 迷你账号：730566566
• 提出制作扩展开发建议：[实在不行自己去手搓一个吧!]
• 提供文档API-枚举复制版

paduma

• 提供TypeScript帮助与指导

技术引用

迷你创想

• MiniStudio官方网址

• MiniStudio Official Website

TypeScriptToLua

• TypeScriptToLua

• 在使用该扩展的任何问题，请联系Mickey。如果可以，希望能注明来意，祝您愉快！