插件制作与发布

请插件制作者在制作插件时阅读该文档，以便学习如何制作插件以及了解规范。

插件发布规范

1. 不能引用模板自带的模块或数据或素材资源，请取消勾选该引用项。
2. 素材资源请保证建立在自己专用的文件夹下，命名遵循：自定义_{用户编号}，如 asset/image/kds_1/xxx.png 以便不会与其他插件或模板带有的素材冲突。
3. 包含【场景对象模型的部分属性】或【世界设定】或【玩家设定】时，尽可能使用复杂不容易重名的命名，如使用 变量名_{用户编号}，存在重名属性会无法安装该插件。
4. 有分类的内容，请制作到16分类-插件里，以便统一管理。
5. 脚本的类名尽可能使用复杂的命名，不容易重名的变量名称，如使用 类名_{用户编号}，如果存在同名类，可能造成冲突，导致游戏报错。
6. 脚本中对各种模块或数据的引用时，为确保能够找到用户安装后对应的编号，请参考附录：定义数据编号。

比如引用了5号界面，如果这个5号界面是你一起要打包装入插件里的话，则用户安装后会插入到一个空位置上，编号会发生变更。可能变为10了
如果这个5号界面并没有打包进插件里的话，系统并不会替换该编号，仍然使用用户当前工程下的5号界面。

制作内容插件

插件可以包含以下内容，点击后跳转到相关文档中查看如何制作。

发布插件

打开发布插件界面

菜单-插件系统-发布插件

添加管理插件内容元素

选择添加插件内容元素即可添加对应的元素（仅限于当前工程存在的）。

对于手动关联的可以使用鼠标右键进行删除，自动关联的可通过勾选项决定是否打包，

比如模板自带的数据、素材等需要取消勾选，参考【插件发布规范】。

请检查打包的资源，确保发布时正确包含仅插件相关的内容。

关于预览插件效果

勾选预览插件效果会将会把当前工程的游戏一起上传作为演示效果。

更新插件

如果是更新插件而非新发布插件的话请在插件名称右边选择该插件。

适用范围

我发布的插件管理

在菜单-插件系统-插件管理中可以查看【我的插件】、【审核中】、【已通过】、【未通过】的插件。

其中未通过目前可以通过鼠标悬停查看审核失败理由。

附录

定义数据编号

在打包进插件的脚本中任意地方按照规范定义变量名，其他地方调用即可。

符合变量名命名规则即可（必须带有类型和赋值，值必须是常数）。

比如调用5号界面，定义一个类的静态变量：static PLUGIN_GUI_自定义命名:number = 5，

这样在安装插件时系统能够找到并替换成正确的编号。

以下为各处地方定义的示例：

// 定义在类中的静态变量
static PLUGIN_GUI_自定义命名:number = 5;

// 定义在类中的实例属性
private PLUGIN_GUI_自定义命名:number = 5;
public PLUGIN_GUI_自定义命名:number = 5;
protected PLUGIN_GUI_自定义命名:number = 5;

// 定义外部的全局变量或者内部局部变量
var PLUGIN_GUI_自定义命名:number = 5;
let PLUGIN_GUI_自定义命名:number = 5;

插件元素的自动关联项参考表

重写已经有的函数

制作插件时可能涉及到需要扩展原有脚本的需求。通过重写函数，

重写类的静态方法，假设名为ABC的类中的myFunc方法：

// 记录原函数
var oldAbcMyFunc = ABC.myFunc;
// 重写该函数
ABC.myFunc = function(){
  // 执行旧的函数，作用域和参数保证是当前调用的，可以任意修改调用的顺序，或者不执行该行时表示不执行任何旧逻辑
  oldAbcMyFunc.apply(this,arguments);
  // 执行新的逻辑....
  XXXXXXXXXXXX
}

重写类的实例方法，假设名为ABC的类中有myFunc的实例方法：

// 记录原函数
var oldAbcMyFunc = ABC.prototype.myFunc;
// 重写该函数
ABC.prototype.myFunc = function(){
  // 执行旧的函数，作用域和参数保证是当前调用的，可以任意修改调用的顺序，或者不执行该行时表示不执行任何旧逻辑
  oldAbcMyFunc.apply(this,arguments);
  // 执行新的逻辑....
  XXXXXXXXXXXX
}