Solar2D编辑器

Solar2D编辑器（即之前的Corona Editor）是官方的Solar2D插件用于Sublime Text。通过向Sublime Text添加功能，旨在简化应用程序构建过程，提高开发者的工作效率。

Sublime Text版本

要使用Solar2D编辑器，需要安装Sublime Text 3。

安装说明

1. 如果您还没有安装，请使用以下步骤通过 工具 > 命令面板… > 安装包控制 安装 Sublime Text 包控制 插件。
2. 在安装完成后，在 Sublime Text 中选择： 工具 > 命令面板… > 包控制：安装包
3. 在搜索栏中输入 Corona Editor，单击将其安装
4. 重新启动 Sublime Text 以查看新功能

如果您想帮助测试最新的Solar2D编辑器开发版本，您可以按照以下步骤配置 包控制 以获取它，而不是官方发布版本：

1. 在 Sublime Text 中选择： 工具 > 命令面板… > 包控制：移除包 并卸载任何已安装的 Corona Editor 版本
2. 选择： 工具 > 命令面板… > 包控制：添加存储库
3. 输入 https://github.com/coronalabs/CoronaSDK-SublimeText
4. 选择： 工具 > 命令面板… > 包控制：安装包
5. 在搜索栏中输入 CoronaSDK-SublimeText（或在某些机器上，Corona Editor - Daily Build），单击将其安装
6. 重新启动 Sublime Text 或重新打开任何 .lua 文件以查看新功能

或者，如果您熟悉手动安装Sublime Text插件且希望运行最新开发版本，您可以从以下网址下载插件：https://github.com/coronalabs/CoronaSDK-SublimeText/archive/master.zip

如果您从GitHub安装了最新的版本，请使用GitHub上的问题页面报告任何问题： https://github.com/coronalabs/CoronaSDK-SublimeText/issues

使用插件

重启 Sublime Text 后，您将在 Solar2D 编辑器 菜单和编辑Solar2D .lua文件时的上下文菜单中发现几个新功能。插件的大部分功能依赖于当前的 语法 设置，因此在编辑文件时，您应该使用 视图 > 语法 > Lua (Solar2D) 命令来设置文件的正确语法。如果您在一个编辑器打开.lua文件时，也可能希望更改 Sublime Text 的默认设置，通过选择 视图 > 语法 > 将所有当前扩展名打开为… > Lua (Solar2D) 实现。

如果您已正确设置语法选项，您将在 Sublime Text 窗口的右下角看到它显示。

有几个可以用于微调插件行为的 Sublime Text 用户首选项可以设置。有关设置用户首选项的信息，请参阅此处 https://text.sublime.net.cn/docs/3/settings.html。

调试器

调试器允许代码以单步执行，检查变量并设置断点。您可以通过项目中的任何文件使用 Solar2D 编辑器 菜单来运行调试器，并且它会自动找到 main.lua。在编辑器中右键单击代码行并从上下文菜单中选择 切换断点 以打开或关闭断点。从上下文菜单中选择变量的名称，然后选择 检查变量 来查看其值。

以下键也可以控制调试器

替代 Sublime Text 的 构建 命令的一个更简单的选项是 Solar2D 编辑器 菜单中的 运行项目 命令（或 Super+F10）。它没有构建系统所有的功能，但快速且简单。它还可以在您不使用 Sublime Text 项目的情况下更好地找到项目的 main.lua。在编辑器中打开.lua文件时，Super+B（通常绑定到 构建 命令）现在绑定到 运行项目 命令用于Solar2D Lua文件。

在macOS上，如果您在 /Applications 中不更改默认名称安装Solar2D，它将使用最高编号的（最新）构建来运行项目（要更改此行为，请参阅下面的 corona_sdk_simulator_path）。

首选项

• corona_sdk_simulator_path（默认：系统相关）

  将此设置为您的Solar2D模拟器的路径，如果它没有安装到操作系统的默认位置（请记住在Windows路径中使用双反斜杠）。您还可以在各个项目的 build.settings 文件中设置此选项，以自定义每个项目使用的Solar2D模拟器的版本（请注意，与 Sublime Text 首选项文件的JSON语法不同，build.settings 文件的Lua语法中，首选项的名称不需要加引号）。

• corona_sdk_simulator_show_console（默认：false）

  将此设置为true，以在运行项目时（使用 Super+F10 或 Super+B）显示Solar2D模拟器控制台。

当前需要注意的问题

• 如果您执行了项目但是没有遇到断点，您将不得不停止并重新启动以恢复控制（特别是，在您已知正在执行的代码行上设置断点不会停止程序）。
• 通过“内部位置”进行单步执行很麻烦。
• 在main.lua的第一行设置了一个隐式的断点，所以要想触碰到自己设置的第一行断点，需要先运行一次启动调试器并在第一行停下，然后再次运行，直到触碰到自己设置的断点。
• 如果在当前标签下，使用 Sublime Text 的 视图 > 布局 命令来创建行和列，调试器将不会创建其自己的面板，其功能将受到限制。

自动完成

自动完成适用于所有API调用和常量（正确处理命名中的点）。可以进行模糊匹配以增加找到所需项目的几率。自动完成取决于当前的 语法 设置，因此创建新文件时，应使用 视图 > 语法 > Lua (Solar2D) 命令来为新文件设置正确的语法。如果您正在编辑器中打开.lua文件，可能还想通过选择 视图 > 语法 > 以当前扩展名打开所有… > Lua (Solar2D) 来更改 Sublime Text 的.lua文件的默认设置。

首选项

• corona_sdk_completion（默认：True）

  如果您不喜欢Solar2D编辑器的自动完成功能，可以使用此首选项将其完全关闭。

• corona_sdk_use_fuzzy_completion（默认：True）

  关闭“模糊完成”，只基于已键入的字符作为前缀进行完成。

• corona_sdk_complete_periods（默认：True）

  Solar2D编辑器关闭了在Sublime Text中将点视为“单词分隔符”的特殊含义，以使Solar2D自动完成效果更好。如果您喜欢使用“Alt+箭头”等光标移动键在函数调用中移动到点，可能想关闭此选项。关闭此选项的最明显效果是，在您键入一个点之后，所有自动完成选项都会消失，直到您键入另一个字符。

• corona_sdk_use_docset（默认：public）

  选择您想要使用的自动完成集。可以是 public（默认）、legacy（已弃用）或 daily（已弃用）之一。

• corona_completions_strip_white_space（默认：False）

  将设置为true，如果希望自动完成的项目包含最少空白。

当前需要注意的问题

• 完成弹出窗口中项目的顺序看起来有些奇怪，但这是由Sublime Text的“模糊”匹配导致的。

• 由于它们是自动生成的，一些自动完成可能由于嵌套可选参数而存在一些微小错误。

文档查找

通过将光标放在API调用上（或选择它）并按 F1 或从上下文菜单中选择 Solar2D Docs 来调用文档。Lua关键字将在Lua文档中进行查找。如果无法识别某个上下文，将启动对Solar2D文档的搜索。

当前需要注意的问题

• 请注意，右键单击项目不会将光标移到那里，因此您不能在不在插入点处的术语上右键单击，然后从上下文菜单中选择 Solar2D Docs，因为文本光标的位置决定了查找内容（先左键单击项目）。

片段

通过 Solar2D Editor > 片段 菜单，可以访问一组常用代码片段和模板。选择子菜单中的项目将在文件的当前插入点插入其代码。

在 Sublime Text 支持文件夹 Packages/User/Corona Editor/Snippets 中创建了一个默认的代码片段集。您可以创建自己的文件夹和文件以添加到默认集。文件应该是 Sublime Text 的 .sublime-snippet 文件或纯文本文件。纯文本文件的内容在选择时直接插入，除非它们与完成条目完全匹配，在这种情况下将查找完成条目，它们就像正常完成一样工作（您可以在参数之间按制表符键），从而提供一个制作难以记忆的API调用菜单的方法。

构建系统

Solar2D 编辑器 菜单中的 运行项目 命令（或 Super+B 或 Super+F10）是 Sublime Text 中 构建 命令的一个更简单的替代品（有关更多信息，请参阅上面的部分）。

语法高亮

使用 Solar2D 调用的 Lua 语法高亮已完成（选择 查看 > 语法 > Lua (Solar2D) 以启用此功能）。如果您在编辑器中打开 .lua 文件，也会修改 Sublime Text 的 .lua 文件默认设置为选择 查看 > 语法 > 将当前扩展名全部打开为… > Lua (Solar2D)。

其他

• 将 Sublime Text 的 转到任何地方… 功能列表的快捷键添加到上下文菜单中，作为 函数导航器…。这将列出当前文件中定义的函数，选择一个会带您到该函数的定义。
• Solar2D 编辑器 菜单有一个 显示/隐藏构建面板 命令来切换构建结果面板（显示模拟器的输出）的可见性。请注意，隐藏面板会清除其内容。

报告问题

您可以在 论坛 上找到有关 Solar2D 编辑器的讨论。

如果插件的一些方面表现不符合预期，请确保在报告问题时包括任何控制台输出。您可以使用 查看 > 显示控制台 查看控制台，并复制粘贴显示的信息。

已知问题

• 对于看起来像的函数定义，语法高亮不正确

local back=simplebutton.create("Back",function() menumanager.openMenu("main") end)

平台特定建议

Mac

您可能想设置 系统偏好设置 > 键盘 中的 使用所有 F1、F2 等键作为标准功能键 选项，以便更容易使用 F10 和 F11 对调试程序进行操作。或者，您可能想要重新分配驱动调试程序使用的键；有关如何进行此操作的信息可以在 https://text.sublime.net.cn/docs/key-bindings 找到。

感谢

非常感谢那些为使 Solar2D 编辑器更加完善提供反馈和建议的 Solar2D 用户。特别感谢 personalnadir、develephant、givemeyourgits 和 landoncope 为他们的贡献和帮助。