编辑器设置

如何设置带有自动补全、类型检查和 nanos world API 文档的 Visual Studio Code。

安装

1. 下载并安装 Visual Studio Code。
2. 安装 nanos world Lua 扩展。它还会安装它所依赖的 Lua 扩展（Lua 语言服务器）。
3. 在 VS Code 中使用 文件 -> 打开文件夹 打开你的包文件夹（或整个 Packages/ 文件夹）。
4. 打开任意 .lua 文件。该扩展会下载最新的 nanos world API 注释，并配置 Lua 语言服务器以使用它们。

就这些！现在所有类、方法、事件和枚举都支持自动补全，你可以将鼠标悬停在它们上面阅读其文档。

信息

这些注释由用于构建此文档的同一 API 文件自动生成，并在扩展启动时下载，因此需要互联网连接才能获取最新版本。

提示

为自己的代码添加注释

Lua 语言服务器理解 LuaCATS 注释。将它们添加到你的函数和类中，即可为你的代码提供自动补全和类型检查功能：

Server/Index.lua

---给玩家钱
---@param player Player  接收的玩家
---@param amount number  多少钱
---@return number        新的余额
function GiveMoney(player, amount)
    local new_balance = player:GetValue("money", 0) + amount
    player:SetValue("money", new_balance, true)
    return new_balance
end

对于继承的类，你可以将其声明为 nanos world 类的子类，这样就可以使用 nanos world 类的所有方法：

Shared/Index.lua

---@class Crate : Prop
Crate = Prop.Inherit("Crate")

我在哪个端上？

编辑器无法判断文件是在服务器还是客户端运行，因此会建议所有的方法。在 Shared/ 文件中编写代码时，务必检查此文档中方法和事件的主控。