EditorPlugin Class

详细说明

EditorPlugin是所有插件的基类，所有插件都需要继承此类。

要开发Yayin Story Studio插件，您就必须实现此类，然后在您的项目中声明YSSPluginDllMain函数。这个 函数只做一件事情：新建您的插件类，并且返回它。

extern "C" YSSCore::Editor::EditorPlugin* YSSPluginDllMain() {
        return new YourPluginClass();
}

稍后，Yayin Story Studio将会调用您的插件的onPluginEnable()函数来启用插件。您应该在这个函数中 进行一些初始化工作，比如注册语言服务器、文件服务器、翻译器等。

您不应该在您的插件的构造函数中进行除了基本信息设置之外的任何其他工作，尤其是尝试和YSS或其他插件交互。 因为在构造插件的过程中，YSS尚未准备好全部的程序功能，您极有可能遭遇nullptr。

我们以YSS自带的ASEDevTool插件为例，向您展示插件的各个函数中应该做什么：

Plugin_ASEDevTool::Plugin_ASEDevTool() {
        setPluginVersion(Visindigo::General::Version(0, 1, 0));
        setPluginID("ASEDevTool");
        setPluginName("ASE Development Tool");
        setPluginAuthor({ "Gra_dus" });
}
void Plugin_ASEDevTool::onPluginEnable() {
        registerTranslator(new ASEDevTranslator());
        registerLangServer(new AStoryLanguageServer());
        registerFileServer(new AStoryFileServer());
        registerFileServer(new ASRuleFileServer());
}

void Plugin_ASEDevTool::onPluginDisbale() {
}

要使Yayin Story Studio能够找到您的插件，您还需要至少三步操作：

1. 在应用程序resources/plugins/目录下创建一个文件夹，命名任选，最好为您的插件ID。

2. 确保您编译得到的动态链接库文件的后缀名为.ysp（这是全平台统一的），并且放在您的插件文件夹中。

3. 在您的插件文件夹中新建一个与您插件文件同名的json文件，例如“yourplugin.ysp.json"，并做如下编辑：

{
        "ID": "YourPluginID",
        "Depend": [
                “PluginID1",
                “PluginID2"
        ]
}

Yayin Story Studio在启动时会首先搜索plugins文件夹下的所有ysp文件，并且依赖这个与其同名的JSON文件 分析插件的依赖信息并决定加载顺序。json文件中的ID必须和代码中实际设置的ID一致，否则Yayin Story Studio将无法 找到您的插件。Depend字段是一个字符串数组，表示您的插件依赖的其他插件的ID。Yayin Story Studio会在加载 插件时，先加载这些依赖的插件，然后再加载您的插件。

请注意，Yayin Story Studio无法处理循环依赖。当两个插件相互依赖时，将具有相同的优先等级，YSS无法确定其加载顺序。

如果您的插件不依赖其他插件，可以将Depend字段省略。

考虑到C++的内存使用极其自由，用户编写代码也极其自由，因此Visindigo不保证任何插件 逻辑的异常安全。任何执行插件函数过程中遭遇的异常都会导致Visindigo直接崩溃。