Script

Load JavaScript plugin in bukkit server. Release under GPLv2.

示例

一个最简单的有功能的脚本如下例，它将给登陆的玩家发送信息。description对象定义了脚本的基本属性（非必须）。对象中的handle字段定义了脚本监听的事件。

var description = {
    "author":"mengcraft.com",
    "name":"Hello",
    "version":"1.0",
    "handle":"playerjoinevent"
}

var handle = function handle(event) {
    var p = event.player
    p.sendMessage("hello, " + p.name)
}

加载

插件在启动时自动加载插件根目录下文件名匹配*.js的脚本，不匹配或位于子目录的脚本请使用指令/script load <文件名> [arg]加载。脚本文件名后的字符作为全局变量arg传入脚本中，类型为string[]。自动加载的脚本arg始终为未定义。

if (arg) {
    loader.sendMessage(arg.join(" "));
}

单次脚本

如果脚本没有添加指令、事件监听和任务调度等行为，那么该脚本为单次脚本。单次脚本执行后不驻留，因此可以通过指令反复加载。

事件

这里有另一种更加灵活的方式监听一个事件，并且你可以随时添加或者去除一个或者多个监听器。事件名默认小写化处理。

var description = {
    "author":"mengcraft.com",
    "name":"Hello",
    "version":"1.0",
}

var listener = plugin.addListener("playerjoinevent", function(event) {...})

listener.remove()

第三方插件中的事件需要在监听前进行注册操作。事件名冲突时请使用插件名作为前置命名空间。

plugin.mapping.init("AnyPlugin")

plugin.addListener("playerjoinevent", function(event) {
    plugin.logger.info("build-in event fire")
})

plugin.addListener("anyplugin:playerjoinevent", function(event) {
    plugin.logger.info("AnyPlugin's event fire")
})

第三个参数可用于指定监听器优先级。该参数默认值为-1，取值范围为[byte.min, byte.max]。

plugin.addListener("playerjoinevent", function(event) {}, 100)

你可以按正则过滤事件，注意事件名使用小写字母。

plugin.mapping.filter("any(.*)event").forEach(function (name) {
    plugin.addListener(name, function (evt) {...})
})

请注意脚本处理事件继承与插件有所区别。例如，插件中监听EntityDamageEvent会将该类的子类一并监听，而脚本的监听器对此做了额外处理以确保不会监听到子类。

玩家权限

可以在脚本中给予玩家权限。权限仅在玩家本次在线过程中有效，脚本（插件）卸载时不会自动移除权限。

var p = plugin.addPermission(plugin.getPlayer("md_5"), "script.admin")
// do any here
p.remove()

指令

你可以添加一个或者多个指令。以下代码同时添加/echo和/script:echo指令。回调函数的第一个参数是指令执行者，第二个参数是指令参数，类型为Array。

plugin.addExecutor("echo", function(sender, i) {
    if (Array.isArray(i)) sender.sendMessage(i.join(" "))
})

可以直接指定执行指令所需的权限。

plugin.addExecutor("echo", "echo.use", function(sender, i) {...})

理所当然的，添加的指令随时可以撤销。

var exec = plugin.addExecutor(...)
exec.remove()

加载资源

脚本中可以使用require函数加载资源文件。如果将要被加载的文件是一个js文件，那么该文件会被解释并返回它的exports字段。如果将要被加载的文件是json文件，那么将返回它被解析后的内容。除此之外的情况将返回文件的引用。

# lib/math.js
exports.min = function min(i, j) {
    return i < j ? i : j;
}

# main.js
var math = plugin.require("lib/math.js")
math.min(0, 1) // Returns 0

var config = plugin.require("config.json")
var name = config.player.name

服务

加载服务是可能的，并且比Java插件中的做法更为简单。但是你无法在脚本中提供一个服务。

var economy = plugin.getService("Economy")
var p = plugin.getPlayer("him")
if (economy && p) {
    economy.depositPlayer(p, 100)
    p.sendMessage("you receive 100 dollar")
    plugin.getAll().forEach(function(player) {
        player.sendMessage("lucky! " + p.name + " receive 100 dollar");
    })
}

广播

广播消息将发送给当前在线的所有玩家。消息支持任意多行，默认将替换&为颜色代码。

plugin.broadcast("&1这是第一行消息",
    "&2这是第二行消息",
    "&3这是第三行消息")

插件依赖

有些脚本语句的执行必须确保在一些插件加载之后，否则可能得到意料之外的结果。此时可以使用plugin#depend函数。

plugin.depend("Vault", function () {
    var eco = plugin.getService("Economy");
    plugin.addListener("playerjoinevent", function () {
        eco.depositPlayer(p, 100);
    })
})

在这个用例中，如果Vault插件已经加载那么回调函数将立即执行，否则将推迟到下tick执行，该行为视同任务调度。如果插件仍未加载，回调函数将被抛弃并在控制台输出一个警告信息。

也可以同时依赖多个插件。

plugin.depend(["Vault", "AnyPlugin"], function () {...});

你可以给该行为添加一个失败时执行的回调函数。

plugin.depend("Vault", function () {...})
    .onFail(function () {
        plugin.logger.info("Vault NOT found!");
        plugin.unload();
    });

交互

与其他脚本或者插件进行交互是不安全的，但你仍可以在必要时这么做。使用时请注意脚本或插件加载顺序，必要时使用plugin.depend函数。

var p = plugin.unsafe.getPlugin("PlayerPoints").getApi()
p.give(plugin.getPlayer("Him"), 100)

plugin.unsafe.getScript("other_script").plugin.unload()

任务调度

尝试在脚本加载6000tick后执行任务，你可以随时在任务未执行前取消它。

var task = plugin.runTask(function() {...}, 6000)
task.cancel()

或者调度一个在下tick执行，并且每1800tick循环执行的任务。

plugin.runTask(function() plugin.logger.info("hello, world"), 1, 1800)

或者在下tick执行一个任务。

plugin.runTask(function() plugin.logger.info("hello, world"))

异步的任务调度都是可行的，只需要在参数后传入true标识。

plugin.runTask(function() {...}, true)
plugin.runTask(function() {...}, 1, true)
plugin.runTask(function() {...}, 1, 1800, true)

后台指令

plugin.runCommand("kill him");

引用其他插件类

一些服务端架构方面的限制导致脚本中无法直接使用内置方法引用其他插件类，此时请使用这个方法获取。

var viaversion = plugin.loadType("us.myles.ViaVersion.api.Via");
var api = viaversion.static.getAPI();// 静态方法

卸载

脚本卸载时将移除所有的事件监听、指令和未完成的任务，请谨慎操作。

plugin.unload();

如果你定义了卸载钩子，卸载钩子将在脚本卸载完成时被执行。钩子中无法执行大部分plugin接口调用。

plugin.setUnloadHook(function() {...});
plugin.setUnloadHook(null);

Placeholder

如果服务器安装有PlaceholderAPI，那么可以很方便的注册placeholder以及格式化字符串。

var hook = plugin.addPlaceholder("sp", function (p, input) {
    // sp_any_world -> any|world
    return input[0] + "|" + input[1];
});
hook.remove();// remove it

var jeb = plugin.getPlayer("jeb");
jeb.sendMessage(plugin.format(jeb, "hello, %player_name%"))

Boss血条

该API只适用于1.9版本以上的服务端。文字中的%placeholder%将自动替换。

var norch = plugin.getPlayer("norch");
plugin.sendBossBar(norch, "hello, %player_name%", 100);// shown 100 tick(s)

亦支持传入任意血条样式描述。

plugin.sendBossBar(norch, "hello, %player_name%", {color: "red", style: 0, flag: ["darken_sky", "play_boss_music", "create_fog"]}, 100);

参数color的取值范围为["pink", "blue", "red", "green", "yellow", "purple", "white"]，参数style的取值范围为0-4。

插件指令

执行下列权限需要script.admin权限。

• /script list
  • 列出所有已加载的脚本名。
• /script load <文件名> [arg]
  • 加载指定文件名的脚本。文件名以插件数据目录为相对目录。
• /script unload <脚本名|file:文件名>
  • 卸载指定名的脚本。脚本名如未在description字段定义则为file:文件名。
  • 亦可直接使用file:文件名。
• /script reload
  • 所有已加载的脚本将被卸载，然后加载所有需要被自动加载的脚本。

注意

初次接触js脚本的童鞋注意，脚本可以正确调用Java中的重载方法，但是脚本无法声明重载函数，请务必注意。

Snapshots