代码示例

本页面提供常见场景的完整代码示例。

经验奖励插件

创建一个根据击杀给予通行证经验的简单插件：

package com.example.arcpassaddon;

import com.kitemc.arcpass.api.ArcPassAPI;
import com.kitemc.arcpass.api.ArcPassProvider;
import org.bukkit.entity.EntityType;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.EntityDeathEvent;
import org.bukkit.plugin.java.JavaPlugin;

import java.util.HashMap;
import java.util.Map;

public class MobExpAddon extends JavaPlugin implements Listener {

    private ArcPassAPI arcPassAPI;
    private final Map<EntityType, Long> expValues = new HashMap<>();

    @Override
    public void onEnable() {
        // 检查 ArcPass
        if (getServer().getPluginManager().getPlugin("ArcPass") == null) {
            getLogger().severe("ArcPass 未安装！插件将禁用");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }

        // 延迟获取 API
        getServer().getScheduler().runTaskLater(this, () -> {
            arcPassAPI = ArcPassProvider.get();
            getLogger().info("ArcPass API 已连接");
        }, 1L);

        // 配置经验值
        setupExpValues();

        // 注册事件
        getServer().getPluginManager().registerEvents(this, this);
    }

    private void setupExpValues() {
        expValues.put(EntityType.ZOMBIE, 5L);
        expValues.put(EntityType.SKELETON, 5L);
        expValues.put(EntityType.CREEPER, 10L);
        expValues.put(EntityType.SPIDER, 5L);
        expValues.put(EntityType.ENDERMAN, 15L);
        expValues.put(EntityType.BLAZE, 20L);
        expValues.put(EntityType.WITHER_SKELETON, 25L);
        expValues.put(EntityType.ENDER_DRAGON, 500L);
        expValues.put(EntityType.WITHER, 300L);
    }

    @EventHandler
    public void onMobKill(EntityDeathEvent event) {
        if (arcPassAPI == null) return;

        Player killer = event.getEntity().getKiller();
        if (killer == null) return;

        EntityType type = event.getEntityType();
        Long exp = expValues.get(type);

        if (exp != null && exp > 0) {
            arcPassAPI.addExperience(killer.getUniqueId(), exp)
                .thenAccept(total -> {
                    // 可选：发送 ActionBar 提示
                    getServer().getScheduler().runTask(this, () -> {
                        killer.sendActionBar("§a+" + exp + " 通行证经验");
                    });
                });
        }
    }
}

自定义任务触发器

创建支持 ArcPass 自定义任务的小游戏插件：

package com.example.minigame;

import com.kitemc.arcpass.api.ArcPassAPI;
import com.kitemc.arcpass.api.ArcPassProvider;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;

public class MiniGamePlugin extends JavaPlugin {

    private ArcPassAPI arcPassAPI;

    @Override
    public void onEnable() {
        // 初始化 ArcPass API
        if (getServer().getPluginManager().getPlugin("ArcPass") != null) {
            getServer().getScheduler().runTaskLater(this, () -> {
                arcPassAPI = ArcPassProvider.get();
            }, 1L);
        }
    }

    /**
     * 当玩家赢得游戏时调用
     */
    public void onPlayerWin(Player player, String gameType) {
        // 发放游戏奖励
        giveGameRewards(player);

        // 触发 ArcPass 自定义任务
        if (arcPassAPI != null) {
            // 触发通用游戏胜利事件
            arcPassAPI.triggerCustomEvent(
                player.getUniqueId(),
                "minigame_win",
                gameType
            );

            // 触发特定游戏胜利事件
            arcPassAPI.triggerCustomEvent(
                player.getUniqueId(),
                "minigame_win_" + gameType.toLowerCase(),
                null
            );
        }
    }

    /**
     * 当玩家完成游戏（无论输赢）时调用
     */
    public void onGameComplete(Player player, String gameType, int score) {
        if (arcPassAPI != null) {
            // 触发游戏完成事件，附带分数数据
            arcPassAPI.triggerCustomEvent(
                player.getUniqueId(),
                "minigame_complete",
                new GameData(gameType, score)
            );
        }
    }

    private record GameData(String gameType, int score) {}
}

对应的 ArcPass 任务配置：

# quests/daily/minigame.yml

win_any_game:
  type: daily
  display-name: "&e小游戏冠军"
  description:
    - "&7赢得任意一场小游戏"
  icon: GOLDEN_APPLE
  experience-reward: 30
  objectives:
    - type: custom
      event: minigame_win
      amount: 1

win_bedwars_3:
  type: weekly
  display-name: "&c起床战争大师"
  description:
    - "&7赢得 3 场起床战争"
  icon: RED_BED
  experience-reward: 100
  objectives:
    - type: custom
      event: minigame_win_bedwars
      amount: 3

等级里程碑奖励

监听升级事件，在特定等级给予额外奖励：

package com.example.milestone;

import com.kitemc.arcpass.api.event.PlayerLevelUpEvent;
import org.bukkit.Bukkit;
import org.bukkit.Sound;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.plugin.java.JavaPlugin;

import java.util.HashMap;
import java.util.Map;

public class MilestonePlugin extends JavaPlugin implements Listener {

    // 里程碑等级及其奖励命令
    private final Map<Integer, String[]> milestones = new HashMap<>();

    @Override
    public void onEnable() {
        setupMilestones();
        getServer().getPluginManager().registerEvents(this, this);
    }

    private void setupMilestones() {
        milestones.put(10, new String[]{
            "give %player% diamond 5",
            "eco give %player% 1000"
        });
        milestones.put(25, new String[]{
            "give %player% diamond 10",
            "eco give %player% 5000",
            "lp user %player% permission set vip.trial true 7d"
        });
        milestones.put(50, new String[]{
            "give %player% diamond 20",
            "eco give %player% 10000",
            "crate give %player% legendary 1"
        });
        milestones.put(100, new String[]{
            "give %player% nether_star 1",
            "eco give %player% 50000",
            "lp user %player% parent add elite"
        });
    }

    @EventHandler
    public void onLevelUp(PlayerLevelUpEvent event) {
        int newLevel = event.getNewLevel();

        // 检查是否达到里程碑
        String[] rewards = milestones.get(newLevel);
        if (rewards == null) return;

        Player player = Bukkit.getPlayer(event.getPlayerId());
        if (player == null) return;

        // 执行奖励命令
        for (String command : rewards) {
            String finalCommand = command.replace("%player%", player.getName());
            Bukkit.dispatchCommand(Bukkit.getConsoleSender(), finalCommand);
        }

        // 特殊效果
        player.playSound(player.getLocation(), Sound.UI_TOAST_CHALLENGE_COMPLETE, 1.0f, 1.0f);
        Bukkit.broadcastMessage("");
        Bukkit.broadcastMessage("§6§l★ §e" + player.getName() + " §6达成通行证 §e" + newLevel + " 级§6里程碑！ §l★");
        Bukkit.broadcastMessage("");
    }
}

双倍经验活动

使用事件修改经验奖励：

package com.example.doubleexp;

import com.kitemc.arcpass.api.event.QuestCompleteEvent;
import org.bukkit.Bukkit;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.plugin.java.JavaPlugin;

public class DoubleExpPlugin extends JavaPlugin implements Listener {

    private boolean doubleExpActive = false;
    private long doubleExpEndTime = 0;

    @Override
    public void onEnable() {
        getServer().getPluginManager().registerEvents(this, this);
    }

    @Override
    public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
        if (!command.getName().equalsIgnoreCase("doubleexp")) return false;
        if (!sender.hasPermission("doubleexp.admin")) {
            sender.sendMessage("§c你没有权限执行此命令");
            return true;
        }

        if (args.length == 0) {
            sender.sendMessage("§e用法: /doubleexp <start|stop|status> [分钟]");
            return true;
        }

        switch (args[0].toLowerCase()) {
            case "start" -> {
                int minutes = args.length > 1 ? Integer.parseInt(args[1]) : 60;
                startDoubleExp(minutes);
                sender.sendMessage("§a双倍经验活动已开启，持续 " + minutes + " 分钟");
            }
            case "stop" -> {
                stopDoubleExp();
                sender.sendMessage("§c双倍经验活动已停止");
            }
            case "status" -> {
                if (isDoubleExpActive()) {
                    long remaining = (doubleExpEndTime - System.currentTimeMillis()) / 1000 / 60;
                    sender.sendMessage("§a双倍经验进行中，剩余 " + remaining + " 分钟");
                } else {
                    sender.sendMessage("§7双倍经验未激活");
                }
            }
        }
        return true;
    }

    private void startDoubleExp(int minutes) {
        doubleExpActive = true;
        doubleExpEndTime = System.currentTimeMillis() + (minutes * 60 * 1000L);

        Bukkit.broadcastMessage("");
        Bukkit.broadcastMessage("§6§l★ 双倍通行证经验活动开始！ ★");
        Bukkit.broadcastMessage("§e持续时间: " + minutes + " 分钟");
        Bukkit.broadcastMessage("");

        // 定时结束
        getServer().getScheduler().runTaskLater(this, this::stopDoubleExp, minutes * 60 * 20L);
    }

    private void stopDoubleExp() {
        if (doubleExpActive) {
            doubleExpActive = false;
            Bukkit.broadcastMessage("§c§l★ 双倍通行证经验活动结束！ ★");
        }
    }

    public boolean isDoubleExpActive() {
        if (doubleExpActive && System.currentTimeMillis() > doubleExpEndTime) {
            doubleExpActive = false;
        }
        return doubleExpActive;
    }

    @EventHandler(priority = EventPriority.HIGH)
    public void onQuestComplete(QuestCompleteEvent event) {
        if (isDoubleExpActive()) {
            int originalExp = event.getExperienceReward();
            event.setExperienceReward(originalExp * 2);

            // 通知玩家
            getServer().getScheduler().runTask(this, () -> {
                var player = Bukkit.getPlayer(event.getPlayerId());
                if (player != null) {
                    player.sendMessage("§a§l[双倍经验] §e额外获得 +" + originalExp + " 经验！");
                }
            });
        }
    }
}

排行榜 NPC

使用 Citizens 创建显示排行榜的 NPC：

// 简化示例：使用全息图显示排行榜
package com.example.leaderboard;

import com.kitemc.arcpass.api.ArcPassAPI;
import com.kitemc.arcpass.api.ArcPassProvider;
import org.bukkit.Location;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitRunnable;

public class LeaderboardDisplay extends JavaPlugin {

    private ArcPassAPI arcPassAPI;
    private Location displayLocation;

    @Override
    public void onEnable() {
        // 初始化
        getServer().getScheduler().runTaskLater(this, () -> {
            if (getServer().getPluginManager().getPlugin("ArcPass") != null) {
                arcPassAPI = ArcPassProvider.get();
                startLeaderboardUpdate();
            }
        }, 1L);
    }

    private void startLeaderboardUpdate() {
        // 每 5 分钟更新排行榜显示
        new BukkitRunnable() {
            @Override
            public void run() {
                updateLeaderboardDisplay();
            }
        }.runTaskTimer(this, 0L, 6000L); // 5 分钟
    }

    private void updateLeaderboardDisplay() {
        // 这里可以集成 HolographicDisplays 或 DecentHolograms
        // 获取排行榜数据并更新全息图
        getLogger().info("正在更新排行榜显示...");
    }
}

最佳实践总结

始终检查 API 可用性 - 在使用 API 前检查是否为 null
使用异步操作 - 避免阻塞主线程
正确处理主线程回调 - 与玩家交互时回到主线程
添加错误处理 - 使用 .exceptionally() 处理异常
使用缓存数据时检查 null - getPlayerDataIfCached 可能返回 null
遵循事件优先级 - 根据需求选择合适的优先级

快速开始

安装配置

配置文件

使用指南

开发者 API

帮助

经验奖励插件

自定义任务触发器

等级里程碑奖励

双倍经验活动

排行榜 NPC

最佳实践总结

​经验奖励插件

​自定义任务触发器

​等级里程碑奖励

​双倍经验活动

​排行榜 NPC

​最佳实践总结

经验奖励插件

自定义任务触发器

等级里程碑奖励

双倍经验活动

排行榜 NPC

最佳实践总结