插件脚本规格

Basics

• 作为脚本的 .js 文件应该放到 js/plugins 目录下。
• 编辑器会在 js/plugins.js 文件中列出被启用的脚本以及该脚本的设置参数。
• 为了防止变量命名的冲突，脚本将被封装成一个立即执行函数。
• 字符编码使用 UTF-8 。

函数重定义

• 在重定义函数前，出于保险，请先将它们保存到一个变量中。
• 为了防止脚本冲突，请不要大幅修改原始函数。

设置参数

• 脚本的说明以及其需要在编辑器中显示的设置参数可以在脚本开头以 “/*:” 开始的注释中设置。

  @plugindesc	脚本的简单说明。
  @author	脚本的作者。
  @param	参数的名称。
  @desc	参数的说明。
  @default	参数的默认值。
  @help	脚本的详细说明。

• 使用 PluginManager.parameters() 来获取用户在编辑器中设置的参数。
• 所有的参数值都为字符串，因此在必要时请进行数据类型的转换。

元数据

数据库中 [Note（备注）] 区域填写的特殊内容可以作为附加数据被脚本所读取。

<name:data>

通过上面这种方式书写的备注将自动储存到变量 “meta” 中。
例如，在上面这个例子里，下面这个条件式成立（objects 代表当前读取的数据）。

object.meta.name === 'data'

插件指令（Plugin Command）

事件指令中的 插件指令（Plugin Command） 用于方便的执行插件中的某些操作。若要使用插件指令，请这样重定义 Game_Interpreter 中的 pluginCommand 函数。

    var _Game_Interpreter_pluginCommand =
            Game_Interpreter.prototype.pluginCommand;
    Game_Interpreter.prototype.pluginCommand = function(command, args) {
        _Game_Interpreter_pluginCommand.call(this, command, args);
        // 在这里插入额外的内容
    };

用户通过插件指令输入的内容将作为名为 command 和 args 的参数传入该函数，command 是一个字符串，args 则是一个由字符串组成的数组。例如，当用户输入“MyPlugin clear”时，下面的语句将会执行。

        if (command === 'MyPlugin' && args[0] === 'clear') {
        }

和脚本的设置参数一样，由于传入的参数都是字符串，需要时请进行转换。

多语言支持

在注释开头插入“/*:”加上下面的语言代码可以将注释内容标注为相应的语言。例如，将代码标注为日语的注释就是：“/*:ja”。被标注为对应语言的代码只会在对应语言版本的RM编辑器中生效。未标注语言的部分（通常为英语）则作为默认语言显示。