Libb

插件

· 作者 MrJetby

用于 Minecraft 图形界面、命令和操作的简易实用工具

0 本站下载 0 关注 更新于 4 个月前

最新 1.2.3 · 26.2 · Bukkit / Paper

一键开服(送7天)

Libb

一个用于便捷、轻松创建 Minecraft 插件的库。



依赖项
PlaceholderAPI
Java 21 或更高版本
Paper 或其分支版本
Minecraft 1.20 或更高版本

GUI(图形用户界面)

示例

public class GuiTest extends AdvancedGui {
    public GuiTest() {
        super("Gui title");
        setItem("example", ItemWrapper.builder(Material.STONE)
                .slots(1, 5, 7)
                .displayName(Component.text("This is the name dude"))
                .onClick(event -> {
                    event.setCancelled(true);
                    player.sendMessage("Clicked on slot: " + event.getSlot());
                })
                .build());
    }
}

要为玩家打开 GUI,请调用 open():

new GuiTest().open(player);

ParsedGui — 基于配置的 GUI

ParsedGui 允许你在 YAML 配置文件中定义整个库存 GUI —— 包括物品、槽位、点击动作、打开/关闭钩子以及占位符 —— 无需编写样板代码。


YAML 结构

id: my_gui
title: "<gold>My Shop"
size: 54          # 必须是 9 的倍数

on_open:          # 可选 — GUI 打开时运行的操作列表
  - "[sound] UI_BUTTON_CLICK;1;1"

on_close:         # 可选 — GUI 关闭时运行的操作列表
  - "[message] <gray>Closed the shop."

Items:
  my_item:
    material: DIAMOND
    slot: 13                    # 单个槽位
    display_name: "<aqua>Buy Diamond"
    lore:
      - ""
      - " <gray>Click to purchase"
      - ""
    on_click:
      any:                      # 在所有点击类型下触发
        - "[sound] UI_BUTTON_CLICK;1;1"
        - "[player] buy diamond"
      left:                     # 仅在左键点击时触发
        - "[message] <green>Left clicked!"
      shift_left:
        - "[message] <yellow>Shift+Left!"

支持的点击类型: any(任意)、left(左键)、shift_left(Shift+左键)、right(右键)、shift_right(Shift+右键)、middle(中键)、drop(丢弃)、control_drop(Ctrl+丢弃)、double(双击)

槽位格式:

slot: 13              # 单个槽位
slots:
  - '0-8'             # 范围
  - '45-53'           # 另一个范围
  - '27'              # 列表中的单个槽位

从代码中打开

// 从 FileConfiguration 加载:
FileConfiguration config = YamlConfiguration.loadConfiguration(file);
new ParsedGui(player, config, myPlugin).open(player);

// 从预解析的 Gui 记录对象加载(针对大量玩家更高效):
Gui gui = ...; // 在启动时解析一次
new ParsedGui(player, gui, myPlugin).open(player);

运行时占位符

使用 setReplace() 在运行时向显示名称、描述文本和操作行中注入值。 请在调用 open() 之前 调用它 —— 物品是在打开时才构建的。

ParsedGui gui = new ParsedGui(player, config, myPlugin);
gui.setReplace("%price%", "500")
   .setReplace("%item_name%", "Diamond Sword");
gui.open(player);

在 YAML 中:

display_name: "<white>Price: <green>$%price%"
lore:
  - " <gray>Item: <white>%item_name%"

PlaceholderAPI 占位符 (%papi_placeholder%) 会自动应用 —— 无需额外设置。


从代码注册点击处理器

通过 YAML 部分键名注册 Java 端的点击逻辑。 这将在 YAML 中定义的 on_click 之外 额外运行。

ParsedGui gui = new ParsedGui(player, config, myPlugin);

gui.addClickHandler("my_item", event -> {
    Player clicker = (Player) event.getWhoClicked();
    clicker.sendMessage("You clicked my_item!");
    gui.refresh();
});

gui.open(player);

通过 ActionContext 将 GUI 传递给动作

当玩家点击物品时,ParsedGui 会自动将其自身放入 ActionContext 中。 在自定义动作内部你可以检索它:

ActionRegistry.register("myplugin", "my_action", (ctx, text) -> {
    ParsedGui gui = ctx.get(ParsedGui.class);
    if (gui == null) return;

    // 执行某些操作,然后刷新
    gui.refresh();
});

在配置中:

on_click:
  any:
    - "[myplugin:my_action]"

槽位优先级与 view_requirements

多个物品可以 targeting 同一个槽位。拥有最低 priority 值且其所有 view_requirements 均满足的物品将胜出。 这对于条件性物品很有用 —— 例如,在玩家资金不足时显示锁定版本。

Items:
  buy_locked:
    material: RED_STAINED_GLASS_PANE
    slot: 13
    priority: 1
    display_name: "<red>Not enough money"
    view_requirements:
      - "%vault_eco_balance% < 100"   # 当余额 < 100 时显示

  buy_unlocked:
    material: EMERALD
    slot: 13
    priority: 2                        # 回退选项 —— 当锁定物品的条件不满足时显示
    display_name: "<green>Buy"

view_requirements 支持 ==、!=、>=、<=、>、< 运算符,适用于数字和字符串。 PlaceholderAPI 占位符会在比较之前解析。


刷新 GUI

调用 refresh() 以清除并重建所有物品 —— 重新评估 view_requirements 并重新应用所有占位符。

gui.refresh();

通常在游戏状态更改后的点击处理器中调用:

gui.addClickHandler("toggle", event -> {
    toggleSomething(player);
    gui.refresh();
});

扩展 ParsedGui

你可以继承 ParsedGui 来添加自定义库存槽位、重写渲染逻辑等。

⚠️ super(viewer, config, plugin) 在构造期间内部调用了 buildItems() —— 此时你的子类字段尚未初始化。请用空值检查守卫重写 buildItems():

public class MyGui extends ParsedGui {

    private final MyPlugin plugin;

    public MyGui(Player viewer, FileConfiguration config, MyPlugin plugin) {
        super(viewer, config, plugin);
        this.plugin = plugin;
        // 在此处进行初始化
    }

    @Override
    public void buildItems(List<Item> items) {
        if (plugin == null) {          // 守卫检查:在字段初始化之前从 super() 调用
            super.buildItems(items);
            return;
        }
        // 你的自定义逻辑,然后:
        super.buildItems(items);
    }

    @Override
    public void refresh() {
        // 在重建物品前更新替换变量
        setReplace("%score%", String.valueOf(getScore()));
        super.refresh();
    }
}

Actions(动作)

Actions 是基于配置的、针对玩家执行的命令。每个动作是一个格式为 [key] text 的字符串。

内置动作

Key Description
[message] 向玩家发送消息
[broadcast_message] 向所有玩家广播消息
[console] 从控制台运行命令
[player] 以玩家身份运行命令
[effect] 施加药水效果
[action_bar] 发送动作栏消息
[broadcast_action_bar] 向所有玩家广播动作栏消息
[title] 向玩家发送标题
[broadcast_title] 向所有玩家广播标题
[sound] 为玩家播放声音
[broadcast_sound] 为所有玩家播放声音
[open] 打开 GUI

用法

简单执行:

ActionExecute.run(ActionContext.of(player), "[message] Hello!");

在上下文中包含额外对象:

ActionExecute.run(
    ActionContext.of(player).with(entity),
    "[myplugin:give_diamond] 64"
);

通过 .with() 添加的额外对象可以在处理器中使用 ctx.get(YourClass.class) 检索。


注册自定义动作

自定义动作在 onEnable 中注册,在 onDisable 中注销。

不同插件的动作可以共享相同的键而不会冲突——完整的键是 namespace:command:

# config.yml
actions:
  - "[plugina:spawn] text"      # 解析 plugina 的 spawn
  - "[pluginb:spawn] text"      # 解析 pluginb 的 spawn —— 无冲突
  - "[spawn] text"              # 解析第一个注册的

Lambda(简单情况)

@Override
public void onEnable() {
    ActionRegistry.register("myplugin", "give_diamond", (ctx, text) -> {
        Player player = ctx.getPlayer();
        if (player == null || text == null) return;

        int amount = Integer.parseInt(text);
        player.getInventory().addItem(new ItemStack(Material.DIAMOND, amount));
        player.sendMessage("You got " + amount + " diamonds!");
    });
}

@Override
public void onDisable() {
    ActionRegistry.unregisterAll("myplugin");
}

Class(推荐用于复杂逻辑)

在 onEnable 中注册:

@Override
public void onEnable() {
    ActionRegistry.register("myplugin", "give_diamond", new GiveDiamondAction());
}

@Override
public void onDisable() {
    ActionRegistry.unregisterAll("myplugin");
}

实现 Action:

public class GiveDiamondAction implements Action {

    @Override
    public void execute(@NotNull ActionContext ctx, @Nullable String text) {
        Player player = ctx.getPlayer();
        if (player == null || text == null) return;

        // 解析文本参数
        int amount = Integer.parseInt(text);
        player.getInventory().addItem(new ItemStack(Material.DIAMOND, amount));
        player.sendMessage("You got " + amount + " diamonds!");

        // 从上下文中检索自定义对象 —— 如果未提供则为 null
        Entity entity = ctx.get(Entity.class);
        if (entity == null) return;

        entity.teleport(player.getLocation());
        ActionExecute.run(
            ActionContext.of(player),
            "[message] <red>Entity has been teleported to you"
        );
    }
}

ActionContext

ActionContext 是一个类型安全的容器,用于传递给动作的对象。对象按类存储和检索——无需字符串键。

// 放入对象
ActionContext ctx = ActionContext.of(player)
        .with(entity)       // 按 entity.getClass() 存储
        .with(myGui);       // 按 myGui.getClass() 存储

// 取出对象(在处理器内部)
Entity entity = ctx.get(Entity.class);      // 如果未提供则为 null
Entity entity = ctx.require(Entity.class);  // 如果未提供则抛出异常

如果你想将对象存储在接口下而不是其具体类下:

ctx.with(MyInterface.class, myObject);
// 检索方式:
ctx.get(MyInterface.class);

API

MAVEN
<repository>
  <id>JetbyMC</id>
  <url>https://api.jetby.org/</url>
</repository>
<dependency>
  <groupId>me.jetby.libb</groupId>
  <artifactId>api</artifactId>
  <version>VERSION</version>
  <scope>provided</scope>
</dependency>
GRADLE
repositories {
    maven {
        url "https://api.jetby.org/"
        name "JetbyMC"
    }
}
dependencies {
    compileOnly "me.jetby.libb:api:VERSION"
}

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源