快速开始

最后更新于2022年05月19日 | 历史记录

此页面内容对应于LuaInMinecraftBukkit插件的最新版本(及以上版本)(version: 1.4), 历史文档可以插件此页面的历史记录

准备条件有:

• 简单熟悉lua 5.2.X语法(默认模式)

或者

• 简单熟悉lua 5.4语法(native模式)

第一步 创建脚本插件文件夹

在Bukkit服务器的plugins/LuaInMinecraftBukkit目录下, 有一个名为plugins的目录, 这个目录就是用来装lua脚本插件的目录.

我们进入plugins/LuaInMinecraftBukkit/plugins目录中, 创建一个MyLuaPlugin文件夹, 这个文件夹就成了一个脚本插件文件夹.

第二步 创建 lua_plugin.yml

在MyLuaPlugin文件夹中创建一个lua_plugin.yml文件, 用来告诉插件这里有一个脚本插件, 在其中写入.

# 展示用的名字
displayName: 我的Lua插件
# 脚本插件id, 建议插件id与目录名保持一致, 并且只使用26个英文字母组成
id: MyLuaPlugin
# 作者
author: SmileYik
# 脚本版本
version: 1.0
# 强制依赖插件, 是一个列表
# 其中列表里是其他依赖脚本插件的脚本插件id
dependents: []
# 非强制依赖插件, 是一个列表
# 其中列表里是其他依赖脚本插件的脚本插件id
softDependents: []
# 模式有两种, 在填写过程中注意首字母大写
# 一种是 Inside(默认模式)
# 另外一种是 Outside(Native模式)
#
mode: Inside

插件总是会在加载脚本前去查询lua_plugin.yml文件以获取脚本插件信息.

第三步 创建 main.lua

插件总是从main.lua脚本开始, 为了让插件能够运行我们写的脚本插件, 我们在MyLuaPlugin文件夹内创建一个main.lua文件

并且在其中写入如下文本:

-- 获取日志实例
local logger = self:getLogger()

command = {}
listener = {}

-- 当脚本插件被启用时会执行这个方法
function onEnable()
    logger:info("我被启用了!!!!")
    -- 注册一个指令, 第一个参数为: 注册的指令
    --             第二个参数为: 函数路径
    luaBukkit.command:registerCommand(
        "test", "MyLuaPlugin.command.dispatch"
    )
    -- 注册一个事件, 第一个参数为: 事件类型
    --             第二个参数为: 函数路径
    --             第三个参数为: 事件优先级
    luaBukkit.event:register(
        "PlayerJoinEvent", "MyLuaPlugin.listener.onPlayerJoin", 2
    )
end

-- 当脚本插件被结束时会执行这个方法
function onDisable()
    logger:info("我被卸载了!")
end

function listener.onPlayerJoin(event)
    local playername = event:getPlayer():getName()
    event:setJoinMessage(playername .. "加入了服务器哦~")
    event:getPlayer():sendMessage("你好啊" .. playername)
end

function command.dispatch(isPlayer, sender, args)
    if (args[2] == "openInventory" and isPlayer) then
        local inv = luaBukkit.server:createInventory(NIL, 27, "我是你的第一个窗口~")
        sender:openInventory(inv)
        logger:info("执行完毕")
        return
    end
    sender:sendMessage("指令错误!")
end

logger:info("加载完毕!")

现在, 你的LuaInMinecraftBukkit的插件配置目录的结构应该是这样子的:

.
└── plugins
    └── MyLuaPlugin
        ├── lua_plugin.yml
        └── main.lua

2 directories, 2 files

脚本解析 (可以跳过)

跳过

上面我们写了一个main.lua文件, 文件中装有我们的lua脚本. 首先看第一句.

local logger = self:getLogger()

self是一个指向Java插件中的LuaPlugin类的引用, 而:符号就相当于是在c语言中解引用的过程, self:getLogger() 连起来一起就变成了执行self引用指向的对象的getLogger() 方法. 所以这一句就是在本身的LuaPlugin类的实例中获取 一个Logger实例, 没错, 这个Logger就是java编写bukkit插件 时获取的那个Logger实例是同一个类. 至此, 你应该了解到了lua脚本 中能够直接访问到java的对象实例的方法, 而在脚本下文中的

• configPath 对应着Java中 File 类实例对象引用
• logger 对应着Java中 Logger 类实例对象引用
• luaBukkit.event 对应的是 EventRegister 类实例对象引用
• luaBukkit.command 对应的是 CommandRegister 类实例对象引用
• luaBukkit.server 对应的是java中Bukkit.getServer()返回的服务器实例对象的引用

等等等等

接着下面定义了一个全局的onEnable函数. 插件在加载脚本过程中 总是会先将脚本文件中的文本重头至尾解析一边, 解析完成之后再去 调用脚本中的全局的onEnable函数. onDisable函数同理, 当脚本 需要被卸载时, 脚本中的onDisable函数就会被插件调用.

listener表内有一个onPlayerJoin函数, 这个函数将传递给插件插件管理 当注册的事件发生时(这里是玩家加入服务器时间), 插件将会把该事件的实例对象的 引用(在这个例子中是PlayerJoinServer实例对象引用)

command表内有一个dispatch方法, 它被以下语句注册并传送给插件.

luaBukkit.command:registerCommand(
    "test", "MyLuaPlugin.command.dispatch"
)

插件将在所注册的指令(这个例子中是test)被使用时,把3给参数传递给所指定的脚本函数中.

当注册的指令被执行时, 插件将会传送三个参数给脚本, 如下表(按照顺序排列):

形参	值	说明
形参1	isPlayer	是否为玩家发出, 这是一个bool类型
形参2	sender	发送指令的实体, 这里可能是玩家也可能是控制台实例对象的引用
形参3	args	玩家发送的指令, 是一个字符串列表, 第一个元素对应的值代表这个脚本所注册的指令(在这个例子中args[1]的值是test)

第四步 启用脚本

脚本已经编好了但是还没有被运行, 运行可以有以下方法.

选项1: 重启服务器以启动脚本

这个方法很简单, 只需要重新启动Bukkit服务器就可以加载脚本了.

选项2: 热加载

确保没有一个相同脚本插件ID的脚本插件已被加载!

在控制台中输入指令/lua load MyLuaPlugin即可加载(注意大小写)

第五步 上mc看效果了

可以自己试一下效果.

• 登陆事件演示

• 指令演示(指令: "/luap test openInventory")