LibCats

插件

· 作者 JGJ52

我的插件库(非常专业)

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

最新 1.3.8 · 1.21.11 · Paper

一键开服(送7天)

LibCats

Time

简介

使用此插件,您可以更轻松地进行 GUI(图形用户界面)、命令(含子命令)的开发,以及处理除 config.yml 之外的 YAML 文件。
此外,您可以更便捷地使用 Paper Registry 中的相关功能。
您还可以监听玩家即将发送的下一条消息,以便获取他们的输入。

自行构建

git clone https://github.com/JGJ52/LibCats.git
cd LibCats
./gradlew build

在项目中引入

<repositories>
    <repository>
        <id>jgj52-repo</id>
        <url>https://maven.jgj52.hu/repository/maven-releases/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>hu.jgj52</groupId>
        <artifactId>LibCats</artifactId>
        <version>1.3.7</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

GUIs

import hu.jgj52.libCats.Types.GUI;
import net.kyori.adventure.text.Component;
import org.bukkit.entity.Player;
import org.bukkit.event.inventory.InventoryClickEvent;
import org.bukkit.event.inventory.InventoryCloseEvent;
import org.bukkit.event.inventory.InventoryDragEvent;
import org.bukkit.event.player.PlayerDropItemEvent;
import org.bukkit.event.player.PlayerInteractEvent;
import org.bukkit.event.player.PlayerMoveEvent;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;

import java.util.List;

class YourGUI extends GUI {
    @Override
    public void init(Player player) {
        // 当 GUI 打开时执行此方法。在此处设置你的物品
        // 你可以通过以下方式设置:
        gui.setItem(0, new ItemStack(Material.APPLE));
    }

    @Override
    public void onClick(InventoryClickEvent event) {
        // 当玩家在库存中点击时调用此方法
    }

    @Override
    public int getSize() {
        return 27; // GUI 的大小
    }

    @Override
    public JavaPlugin getPlugin() {
        return YourPlugin.getInstance();
    }

    // 以上是必须重写的方法,否则无法正常工作
    // 以下是可选方法

    @Override
    public @NotNull Inventory getInventory() {
        return super.getInventory(); // 这是 Bukkit 库存实现的覆盖方法。
        // 我不知道该怎么称呼它。
        // 如果你不知道这是什么或它的用途,你可以忽略它而不进行重写。
    }

    @Override
    public String getMessage(String msg) {
        return super.getMessage(msg); // 基本上等同于
        getPlugin().getConfig().getString("guis." + getClass().getSimpleName() /* 此处为 YourGUI */ + "." + msg);
        // 如果你不想从那里获取消息,可以重写此方法
        // 如果你将所有消息硬编码,可以忽略此方法
    }

    @Override
    public Component getComponent(String msg) {
        return super.getComponent(msg);
        // 本质上与 getMessage(msg) 相同,但此方法会使用 MiniMessage 反序列化并将其转换为 Component
        // 如果你更改了 getMessage 获取消息的来源,此方法也会随之改变
    }

    @Override
    public Component getComponent(String msg, boolean notItalic) {
        return super.getComponent(msg, notItalic); // 这会调用 getComponent(msg),但如果 notItalic 为 true,则添加一个装饰属性表示:非斜体
        // 用于从物品中获取名称很有用
    }

    @Override
    public List<String> getMessageList(String msg) {
        return super.getMessageList(msg); // 与 getMessage 相同,但此方法从配置文件中获取字符串列表,而不仅仅是单个字符串。更改 getMessage 不会改变此方法的来源
    }

    @Override
    public List<Component> getComponentList(String msg) {
        return super.getComponentList(msg); // 与 getComponent 相同,但配合 getMessageList 使用
    }

    @Override
    public List<Component> getComponentList(String msg, boolean notItalic) {
        return super.getComponentList(msg, notItalic); // 同上,但是是列表形式
    }

    @Override
    public String getMsg(String msg) {
        return super.getMsg(msg); // 这从以下位置获取
        getPlugin().getConfig().get("messages." + msg);
        // 但与 getMessage 相同
    }

    @Override
    public Component getComp(String msg) {
        return super.getComp(msg); // 与 getComponent 相同,但使用 getMsg
    }

    @Override
    public Component getComp(String msg, boolean notItalic) {
        return super.getComp(msg, notItalic); // 同上
    }

    @Override
    public List<String> getMsgList(String msg) {
        return super.getMsgList(msg); // 同上
    }

    @Override
    public List<Component> getCompList(String msg) {
        return super.getCompList(msg); // 同上
    }

    @Override
    public List<Component> getCompList(String msg, boolean notItalic) {
        return super.getCompList(msg, notItalic); // 同上
    }

    @Override
    public boolean defaultInit() {
        return super.defaultInit(); // 如果为 true,则在两侧放置黑色玻璃板,在其他地方放置灰色玻璃板。默认为 true
    }

    @Override
    public void firstInit(Player player) {
        super.firstInit(player); // 这仅在第一次运行 init() 时执行
    }

    @Override
    public void onBottomClick(InventoryClickEvent event) {
        // 与 onClick 相同,但现在玩家点击的是其自己的库存,而不是 GUI
    }

    @Override
    public void onClose(InventoryCloseEvent event) {
        // 当 GUI 被关闭时
    }

    @Override
    public void onDrop(PlayerDropItemEvent event) {
        // 当玩家在 GUI 中丢弃物品时
    }

    @Override
    public void onMove(PlayerMoveEvent event) {
        // 当玩家在 GUI 中移动时
    }

    @Override
    public void onInteract(PlayerInteractEvent event) {
        // 例如当 GUI 打开时,玩家对方块进行左键/右键点击时
    }

```java
@Override
    public void onDrag(InventoryDragEvent event) {
        // 当玩家拖拽物品时
        // 类似于 onClick,但并不完全相同
    }

    @Override
    public void onBottomDrag(InventoryDragEvent event) {
        // 与 onBottomClick 相同,但是针对拖拽操作
    }

    @Override
    public Component getName() {
        return super.getName(); // 默认情况下获取 getComponent("name");
    }
    
    public void voidd() {
        // 你可以使用以下方式打开此 GUI
        new YourGUI().open(player);
    }
}

命令

import hu.jgj52.libCats.Types.Command;
import hu.jgj52.libCats.Types.SubCommand;
import net.kyori.adventure.text.Component;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;
import java.util.function.Consumer;

class YourCommand extends Command {
    // 我假设你已经阅读过 GUI 部分
    @Override
    public JavaPlugin getPlugin() {
        return YourPlugin.getInstance();
    }

    @Override
    public String getName() {
        return "myCommand"; // 在游戏中你将使用 /myCommand 来执行此命令
    }

    @Override
    public List<SubCommand> getSubCommands() {
        return List.of(
                new YourSubCommand()
        );
    }

    @Override
    public Consumer<CommandSender> notPlayer() {
        return sender -> {
            // 如果设置了此项,非玩家无法执行此命令;当他们尝试执行时会触发此代码
            // 你可以在这里向他们发送“你好,你需要是玩家才能执行此命令”
        };
    }

    // 以下 6 个方法与 GUI 中的方法相同
    @Override
    public String getMsg(String msg) {
        return super.getMsg(msg);
    }

    @Override
    public List<Component> getCompList(String msg, boolean notItalic) {
        return super.getCompList(msg, notItalic);
    }

    @Override
    public List<Component> getCompList(String msg) {
        return super.getCompList(msg);
    }

    @Override
    public List<String> getMsgList(String msg) {
        return super.getMsgList(msg);
    }

    @Override
    public Component getComp(String msg, boolean notItalic) {
        return super.getComp(msg, notItalic);
    }

    @Override
    public Component getComp(String msg) {
        return super.getComp(msg);
    }

    @Override
    public String getPermission() {
        // 执行此命令所需的权限
        // 默认为
        return getPlugin().getName().toLowerCase() + ".command." + getName();
    }

    @Override
    public Consumer<CommandSender> noPermission() {
        return sender -> {
            // 如果设置了此项,没有 getPermission 中指定权限的玩家将无法执行此命令;当他们尝试执行时会触发此代码
        };
    }
@Override
    public boolean execute(@NotNull CommandSender sender, org.bukkit.command.@NotNull Command command, @NotNull String s, @NotNull String @NotNull [] args, @Nullable Player player) {
        // 当玩家不带参数执行命令时,会运行此方法。
        // 如果你设置了 notPlayer(),则 player 不会为 null
        // 你必须重写此方法
        return true;
    }
}
import hu.jgj52.libCats.Types.SubCommand;
import net.kyori.adventure.text.Component;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;

class YourSubCommand extends SubCommand {
    @Override
    public String getName() {
        return "hello"; // 结合之前的命令,这将成为 /myCommand hello
    }

    @Override
    public boolean execute(@NotNull CommandSender sender, @NotNull Command command, @NotNull String s, @NotNull String @NotNull [] args, @Nullable Player player) {
        // 当执行 "/myCommand hello" 时,也会运行此方法
        // 如果是 "/myCommand hello otherArg",这里也会运行,且 otherArg 是 args[1]
        return true;
    }
@Override
public List<String> complete(@NotNull CommandSender sender, @NotNull Command command, @NotNull String s, @NotNull String @NotNull [] args) {
    return List.of(); // "/myCommand hello <从这儿开始列出>"
}
@Override
    public boolean firstComplete(@NotNull CommandSender sender, @NotNull Command command, @NotNull String s, @NotNull String @NotNull [] args) {
        // 是否允许通过 /myCommand <fromHere> 进行补全(true)或不允许(false)
        // 如果为 false,则没有人可以运行该子命令
        return true;
    }

// 再次使用这个六边形 @Override public List<Component> getCompList(String msg, boolean notItalic) { return super.getCompList(msg, notItalic); }

@Override
public List<Component> getCompList(String msg) {
    return super.getCompList(msg);
}

@Override
public List<String> getMsgList(String msg) {
    return super.getMsgList(msg);
}

@Override
public Component getComp(String msg, boolean notItalic) {
    return super.getComp(msg, notItalic);
}

@Override
public Component getComp(String msg) {
    return super.getComp(msg);
}
@Override
public String getMsg(String msg) {
    return super.getMsg(msg);
}

@Override
public JavaPlugin getPlugin() {
    return YourPlugin.getInstance();
}
}

配置

import hu.jgj52.libCats.Types.Configuration;
import org.bukkit.plugin.java.JavaPlugin;

class YourConfiguration extends Configuration {
    @Override
    public JavaPlugin getPlugin() {
        return YourPlugin.getInstance();
    }
}
@Override
    public String getName() {
        return "messages"; // yml 文件的名称
    }
}

从名称获取注册表对象

import hu.jgj52.libCats.Utils.RegistryFromName;
import org.bukkit.enchantments.Enchantment;

class YourClass {
    public void run() {
        Enchantment sharpness = RegistryFromName.ENCHANTMENT("sharpness");
        List<Enchantment> all = RegistryFromName.ENCHANTMENT();
    }
}

聊天监听

import hu.jgj52.libCats.Listeners.ChatListener;

class YourClass {
    public void run() {
        // 当任意值符合条件时触发
        ChatListener.add(player, message -> {
            // 打印消息
            System.out.println(message);
            // 将消息发送回去,仅供娱乐
            player.sendMessage(message);
        });
        // 当等待特定值时
        // 例如 "done"
        ChatListener.add(player, "done", message -> {
            System.out.println(player.getName() + " said done!");
        });
    }
}

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源