本帖最后由 longlongz 于 2018-11-20 04:13 编辑
BossShopPro
Item Comparison | 物品对比
字数统计: 2744字


如何接入API
首先你需要添加BossShopPro.jar 到你的Libraries里.
你可以使用下方方法来获取:
  1. import org.black_ixx.bossshop.BossShop;
  2. import org.black_ixx.bossshop.api.BossShopAPI;
  3. import org.bukkit.Bukkit;
  4. import org.bukkit.plugin.Plugin;

  6. public class BSPHook {

  8.     private BossShop bs; //BossShopPro 插件实例

  10.     public BSPHook(){
  11.         Plugin plugin = Bukkit.getPluginManager().getPlugin("BossShopPro"); //获取BossShopPro 插件

  13.        if(plugin==null){ //Not installed?
  14.            System.out.print("[BSP Hook] BossShopPro was not found... you can download it here: https://www.spigotmc.org/resources/25699/");
  15.             return;
  16.         }

  18.         bs = (BossShop) plugin; //Success :)

  20.     }


  23.     public BossShopAPI getBSPAPI(){
  24.         return bs.getAPI(); //Returns BossShopPro API
  25.     }

  27. }
复制代码


打开一个商店
  1. public boolean openShop(Player p, String shop_name){

  3.         BSShop shop = bs.getAPI().getShop(shop_name);
  4.        if(shop==null){
  5.            p.sendMessage(ChatColor.RED+"Shop "+shop_name+" not found...");
  6.             return false;
  7.         }

  9.        bs.getAPI().openShop(p, shop);

  11.         return true;
  12.     }
复制代码

检查一个物品是否属于BossShopPro
  1.    //例子:物品事件
  2.        if(bs.getAPI().isValidShop(event.getInventory())){
  3.             //商店物品动作
  4.         }else{
  5.             //其余
  6.         }
复制代码

将一个商店物品添加到商店中
  1.         //创建一个自定义BSBuy (商店物品)
  2.                 BSBuy buy = bs.getAPI().createBSBuy(BSRewardType.Shop, BSPriceType.Nothing, "item_shop", null, null, 1, "OpenShop.Item_Shop");

  4.                 //获取商店信息
  5.                 BSShop shop = bs.getAPI().getShop("menu");

  7.                 //将物品添加到商店
  8.                ItemStack menu_item = [...]
  9.                bs.getAPI().addItemToShop(menu_item, buy, shop);
复制代码

注册一个自定义点数插件
你的插件必须要在BossShopPro之前载入
Plugin.yml
  1. loadbefore: [BossShop]
复制代码

拓展BSPointsPlugin class
  1. [暂无]
复制代码

然后onEnable，示例你的class，然后注册使用方法
  1. new Points().register();
复制代码

如何创建一个附属插件
首先添加BossShopPro.jar 到你的libraries里。正常来说Bukkit插件的main class需要拓展org.bukkit.plugin.java.JavaPlugin,然而当你创建一个BossShopPro 附属插件时你需要导入以下的拓展之一:
· org.black_ixx.bossshop.api.BossShopAddon – 简易版附属
· org.black_ixx.bossshop.api.BossShopAddonConfigurable – 提供额外的对config文件的帮助，会在"plugins/BossShopPro/Addons/<名称>/" 中创建文件
  1. import org.black_ixx.bossshop.api.BSAddonStorage;
  2. import org.black_ixx.bossshop.api.BossShopAddon;
  3. import org.bukkit.command.CommandSender;

  5. public class BSPAddon extends BossShopAddon{

  7.     @Override
  8.     public String getAddonName() {
  9.         return "ExampleAddon"; //在这里放你想要的附属插件名字
  10.     }
  11.     @Override
  12.     public String getRequiredBossShopVersion() {
  13.         return "1.1.7"; //这里放你的插件所支持的最老版本的BSP插件build版本(只需要数字和点；不需要"v"前缀)
  14.     }

  16.     @Override
  17.     public void enableAddon() {
  18.         //这个方法在附属插件加载后执行(会在BossShopPro被加载时执行；商店，商店物品，奖励类型等还暂时缺失)

  20.         //使用的方法：创建自定义储存文件到附属插件文件夹内
  21.         //这些储存文件类型暂时被限制到一组方法之中并无法直接获得Bukkit FileConfiguration 例子的权限,
  22.         //因为在未来会有其他新的储存类型可能会被告知
  23.         //下方的例子显示了你可以操作的部分。当然，储存class组不止是有下方例子的选项
  24.        BSAddonStorage storage = this.createStorage(this, "StorageFileName"); //创建并装载一个储存文件

  26.        storage.set("Number", 2); //设置一个整数数值
  27.        storage.set("Text", "This is some text"); //设置一个字符数值

  29.         int number = storage.getInt("Value", -1); //读取数值(如果没有找到数值, 基础数值“-1”会被返回)
  30.         String text = storage.getString("Text", null); //读取数值，自失败的情况下返回无数值

  32.         storage.save(); //储存文件
  33.        storage.saveAsync(); //异步存储文件
  34.     }

  36.     @Override
  37.     public void disableAddon() {
  38.         //当附加插件被禁用时执行
  39.     }

  41.     @Override
  42.     public void bossShopFinishedLoading() {
  43.         //当BSP被完全执行时执行(包括但不限于商店，商品和奖励类型)
  44.     }

  46.     @Override
  47.     public void bossShopReloaded(CommandSender sender) {
  48.         //当BSP被手动重新装载之后执行("/bossshop reload")
  49.     }


  52. }
复制代码
  1. import org.black_ixx.bossshop.api.BSAddonConfig;
  2. import org.black_ixx.bossshop.api.BossShopAddonConfigurable;
  3. import org.black_ixx.bossshop.managers.config.FileHandler;
  4. import org.bukkit.command.CommandSender;
  5. import org.bukkit.configuration.file.FileConfiguration;

  7. public class BSPAddonConfigurable extends BossShopAddonConfigurable{

  9.     @Override
  10.     public String getAddonName() {
  11.         return "ExampleAddonConfigurable"; //在这里选择附加插件的名字
  12.     }
  13.     @Override
  14.     public String getRequiredBossShopVersion() {
  15.         return "1.1.7"; //在这里放入最老能支持附加插件的BSP版本(只有数字和小数点; 没有"v" 前缀)
  16.     }

  18.     @Override
  19.     public void enableAddon() {
  20.         //当附加插件被允许时执行 当BSP核心被装载时发生, 商品，奖励类型和更多都处于缺失状态)

  22.         //设置文件方法A:
  23.        if(!getAddonConfig().getFile().exists()){
  24.             new FileHandler().copyFromJar(this, "config.yml"); //这个文件处理器允许复制并完成addon.jar 文件里的设置文件
  25.         }

  27.         //设置文件方法B:
  28.         getConfig().options().copyDefaults(true);
  29.        getConfig().addDefault("PointsPlugin", "TokenEnchant");
  30.        getConfig().addDefault("Message.NotEnoughPoints", "&cYou don't have enough Tokens!");
  31.        getConfig().addDefault("Placeholder.DisplayPoints", "%points2% Tokens");
  32.        getConfig().addDefault("PointsDisplay.Enabled", false);
  33.         saveConfig(); //从v1.2.1. 开始运作，在使用"getAddonConfig().save();"之前


  36.         //你可以访问文件设置，并为所欲为:
  37.        FileConfiguration config = getConfig();

  39.         //或者你可以访问 BSAddonConfig, 以提供更多的方法
  40.         BSAddonConfig addonconfig = getAddonConfig();
  41.        addonconfig.saveAsync(); //Saves file asynchronously
  42.        addonconfig.deleteAll("Key"); //删除全部"Key."打头的设置访问记录

  44.     }

  46.     @Override
  47.     public void disableAddon() {
  48.         //当附加插件被禁用时执行
  49.     }

  51.     @Override
  52.     public void bossShopFinishedLoading() {
  53.         /当BSP被完全装载执行
  54.     }

  56.     @Override
  57.     public void bossShopReloaded(CommandSender sender) {
  58.         //当BSP被手动重新装载时执行("/bossshop reload")
  59.     }

  61.     @Override
  62.     public boolean saveConfigOnDisable() {
  63.         return false; //如果设置为真，设置文件每次附加文件被禁用会重新保存    }


  66. }
复制代码

如何创建一个自定义奖励类型
首先你需要创建一个奖励class
  1. import java.util.List;

  3. import org.black_ixx.bossshop.core.BSBuy;
  4. import org.black_ixx.bossshop.core.rewards.BSRewardType;
  5. import org.black_ixx.bossshop.managers.ClassManager;
  6. import org.black_ixx.bossshop.managers.misc.InputReader;
  7. import org.black_ixx.bossshop.managers.misc.StringManipulationLib;
  8. import org.bukkit.entity.Player;
  9. import org.bukkit.event.inventory.ClickType;

  11. import net.milkbowl.vault.permission.Permission;

  13. public class BSRewardTypePermission extends BSRewardType{


  16.     public Object createObject(Object o, boolean force_final_state){ //force_final_state 总会是真，除非用BossShopProConfigure 访问
  17.         return InputReader.readStringList(o); //你可以把设置文件里的物品变成任何物品. 物品会被返回到这里.在以后会有用
  18.     }

  20.     public boolean validityCheck(String item_name, Object o){ //当"createObject" 被召唤之后执行. 在这里你可以查看物品的真实性.
  21.         if(o!=null){
  22.             return true;
  23.         }
  24.         ClassManager.manager.getBugFinder().severe("Was not able to create ShopItem "+item_name+"! The reward object needs to be a list of permissions (text lines).");
  25.         return false;
  26.     }

  28.     public void enableType(){ //如果你的奖励类型有任何特殊性质，在这里开启
  29.         ClassManager.manager.getSettings().setPermissionsEnabled(true);
  30.        ClassManager.manager.getSettings().setVaultEnabled(true);
  31.     }

  33.     @Override
  34. public boolean canBuy(Player p, BSBuy buy, boolean message_if_no_success, Object reward, ClickType clickType) { //在这里同意、拒绝玩家购买商品
  35.         for (String s : (List<String>) reward){
  36.             if (!p.hasPermission(s)) {
  37.                 return true; //玩家缺少权限？可以买！
  38.             }
  39.         }
  40.        if(message_if_no_success){
  41.            ClassManager.manager.getMessageHandler().sendMessage("Main.AlreadyBought", p); //如果玩家有以下全部的权限可以禁止玩家购买
  42.         }
  43.         return false;
  44.     }

  46.     @Override
  47.     public void giveReward(Player p, BSBuy buy, Object reward, ClickType clickType) { //如果所有都成功玩家在这里拿到奖励
  48.        List<String> permissions = (List<String>) reward;

  50.         Permission per = ClassManager.manager.getVaultHandler().getPermission();
  51.         for (String s : permissions) {
  52.            per.playerAdd(p, s);
  53.         }
  54.     }

  56.     @Override
  57.     public String getDisplayReward(Player p, BSBuy buy, Object reward, ClickType clickType) { //在这里定义"%reward%" 定位符怎么展示        List<String> permissions = (List<String>) reward;
  58.         String permissions_formatted = StringManipulationLib.formatList(permissions);
  59.         return ClassManager.manager.getMessageHandler().get("Display.Permission").replace("%permissions%", permissions_formatted);
  60.     }

  62.     @Override
  63.     public String[] createNames() { //在这里定义引导奖励的所有名称, 第一个入口是主要名称.
  64.         return new String[]{"permission", "permissions"};
  65.     }

  67.     @Override
  68.     public boolean mightNeedShopUpdate() { //在这里决定物品被购买之后商店是否刷新
  69.         return true;
  70.     }

  72.     //以下是可选择的:

  74.     @Override
  75.     public boolean logTransaction(){
  76.         return false; //默认设置为真. 如果你不希望购买被记录，把这个设置为假
  77.     }


  80. }
复制代码
如果你的奖励是数字类型的然后你想要完全支持所有BossShopPro 的功能项"ItemAll" pricetype, 则拓展BSRewardTypeNumber

  1. import org.black_ixx.bossshop.core.BSBuy;
  2. import org.black_ixx.bossshop.core.rewards.BSRewardTypeNumber;
  3. import org.black_ixx.bossshop.managers.ClassManager;
  4. import org.black_ixx.bossshop.managers.misc.InputReader;
  5. import org.bukkit.entity.Player;
  6. import org.bukkit.event.inventory.ClickType;


  9. public class BSRewardTypeExp extends BSRewardTypeNumber{


  12.     public Object createObject(Object o, boolean force_final_state){ //force_final_state 总会是真除非被BossShopProConfigure 工具访问
  13.         return InputReader.getInt(o, -1); //尝试读取设置内奖励的数字; 失败返回-1
  14.     }

  16.     public boolean validityCheck(String item_name, Object o){ //这个方法当"createObject" 被召唤时执行. 这里你可以查看物品真实性.
  17.        if((Integer)o!=-1){
  18.             return true;
  19.         }
  20.        ClassManager.manager.getBugFinder().severe("Was not able to create ShopItem "+item_name+"! The reward object needs to be a valid Integer number. Example: '7' or '12'.");
  21.         return false;
  22.     }

  24.     public void enableType(){ //你过你的奖励类型有任何特殊性质，在这里开启
  25.     }

  27.     @Override
  28.     public boolean canBuy(Player p, BSBuy buy, boolean message_if_no_success, Object reward, ClickType clickType) { //这里你可以同意、拒绝玩家购买
  29.         return true;
  30.     }

  32.     @Override
  33.     public void giveReward(Player p, BSBuy buy, Object reward, ClickType clickType) { //如果全部过程顺利玩家在这里拿到奖励
  34.         int exp = (int) ClassManager.manager.getMultiplierHandler().calculateRewardWithMultiplier(p, buy, clickType, ((Integer) reward), false); //如果你想要倍数被兼容的话，请使用倍数处理程序.重要: 在这种情况下你的pricetype必须和rewardtype一样
  35.        p.setLevel(p.getLevel() + exp);
  36.     }

  38.     @Override
  39.     public String getDisplayReward(Player p, BSBuy buy, Object reward, ClickType clickType) { //这里你决定了"%reward%" 占位符怎么展示这种奖励
  40.         int exp = (int) ClassManager.manager.getMultiplierHandler().calculateRewardWithMultiplier(p, buy, clickType, ((Integer) reward), true);
  41.         return ClassManager.manager.getMessageHandler().get("Display.Exp").replace("%levels%", String.valueOf(exp));
  42.     }

  44.     @Override
  45.     public String[] createNames() { //这里你决定所有指向奖励的名称，第一个入口是主要名称.
  46.         return new String[]{"exp", "xp", "level", "levels"};
  47.     }


  50.     @Override
  51.     public boolean mightNeedShopUpdate() { //这里你决定在奖励被购买之后商店是否刷新
  52.         return true;
  53.     }

  55.     @Override
  56.     public boolean isIntegerValue() { //这里你决定奖励要么是integer价格要么是double价格
  57.         return true;
  58.     }


  61. }
复制代码

自定义价格类型例子
  1. import org.black_ixx.bossshop.core.BSBuy;
  2. import org.black_ixx.bossshop.core.prices.BSPriceTypeNumber;
  3. import org.black_ixx.bossshop.managers.ClassManager;
  4. import org.black_ixx.bossshop.managers.misc.InputReader;
  5. import org.black_ixx.bossshop.misc.MathTools;
  6. import org.bukkit.entity.Player;
  7. import org.bukkit.event.inventory.ClickType;

  9. public class BSPriceTypeThirdCurrencyVariable extends BSPriceTypeNumber{

  11.     private CustomPoints cp;

  13.     public BSPriceTypeThirdCurrencyVariable(CustomPoints points){
  14.         this.cp = points;
  15.         updateNames(); //更新进入商店设置需要的名称从而使用这种价格类型: 现在自定义点数被设置为点数的名称(看#createNames())
  16.     }


  19.     /从设置接受价格物品并把它变成以后会用得到的物品
  20.     public Object createObject(Object o, boolean force_final_state){
  21.         return InputReader.getDouble(o, -1);
  22.     }

  24.     public boolean validityCheck(String item_name, Object o){ //验证价格物品
  25.        if((Double)o!=-1){
  26.             return true;
  27.         }
  28.         ClassManager.manager.getBugFinder().severe("Was not able to create ShopItem "+item_name+"! The price object needs to be a valid number. Example: '7' or '12'.");
  29.         return false;
  30.     }

  32.     public void enableType(){ //当价格类型在商店被使用时当BSP开始时执行一次
  33.     //可以被用来注册Vault的文件
  34.     }


  37.     @Override
  38.     public boolean hasPrice(Player p, BSBuy buy, Object price, ClickType clickType, int multiplier, boolean messageOnFailure) {
  39.         double points = ClassManager.manager.getMultiplierHandler().calculatePriceWithMultiplier(p, buy, clickType, (Double) price) * multiplier;
  40.         if (cp.getPointsManager().getPoints(p) < points) {
  41.             String message = cp.getMessageNotEnoughPoints();
  42.             if(message != null && messageOnFailure){
  43.                p.sendMessage(ClassManager.manager.getStringManager().transform(message, buy, buy.getShop(), null, p));
  44.             }
  45.             return false;
  46.         }
  47.         return true;
  48.     }

  50.     @Override
  51.     public String takePrice(Player p, BSBuy buy, Object price, ClickType clickType, int multiplier) {
  52.         double points = ClassManager.manager.getMultiplierHandler().calculatePriceWithMultiplier(p, buy, clickType, (Double) price) * multiplier;

  54.        cp.getPointsManager().takePoints(p, points);
  55.         return getDisplayBalance(p, buy, price, clickType);
  56.     }

  58.     @Override
  59.     public String getDisplayBalance(Player p, BSBuy buy, Object price, ClickType clickType) {
  60.         double balance_points = cp.getPointsManager().getPoints(p);
  61.         return cp.getPlaceholderPoints().replace("%"+cp.getName()+"%", MathTools.displayNumber(balance_points, cp.getSpecialDisplayFormatting(), !cp.getPointsManager().usesDoubleValues()));
  62.     }

  64.     @Override
  65.     public String getDisplayPrice(Player p, BSBuy buy, Object price, ClickType clickType) {
  66.         return ClassManager.manager.getMultiplierHandler().calculatePriceDisplayWithMultiplier(p, buy, clickType, (Double) price, cp.getPlaceholderPoints().replace("%"+cp.getName()+"%", "%number%"), cp.getSpecialDisplayFormatting(), true);
  67.     }


  70.     @Override
  71.     public String[] createNames() { //价格类型用户的名称可以被用于进入设置
  72.         if(cp == null){
  73.         return new String[]{"thirdcurrency", "points2", "point2"};
  74.         }else{
  75.             return new String[]{cp.getName()};
  76.         }
  77.     }

  79.     public boolean supportsMultipliers(){
  80.         return true; //makes RewardTypes like BuyAll possible
  81.     }

  83.     @Override
  84.     public boolean mightNeedShopUpdate() {
  85.         return true; //这个价格类型是否执行取决于是否更新(比如占位符的变化)
  86.     }

  88.     @Override
  89.     public boolean isIntegerValue() {
  90.         return false; //needs to be defined because the class extends BSPriceTypeNumber
  91.     }
复制代码

如何创建自己的物品数据(itemdata)部分

1.    伸展BossShopPro class "ItemDataPart"
2.    执行所有授予的方案all given methods
3.    创建一个监听器来监听"BSRegisterTypesEvent" 然后创建一个你的自定义ItemDataPart 的例子. 另外使用"register" 方法注册例子.

ItemDataPart例子
  1. public class ItemDataPartMaterial extends ItemDataPart{
  2.   public ItemStack transform(ItemStack item, String used_name, String argument)  {
  3.     short durability = 0;
  4.     Material m = Material.STONE;

  6.     if (argument.contains(":")) {
  7.       String[] parts = argument.split(":");
  8.       if (parts.length > 1) {
  9.         durability = (short)InputReader.getInt(parts[1].trim(), 0);
  10.       }
  11.       argument = parts[0].trim();
  12.     }

  14.     m = InputReader.readMaterial(argument);

  16.     if (m == null) {
  17.      ClassManager.manager.getBugFinder().severe("Mistake in Config: '" + argument + "' is not a valid '" + used_name + "'. Unable to find a fitting material.");
  18.       return item;
  19.     }

  21.     item.setType(m);
  22.    item.setDurability(durability);
  23.     return item;
  24.   }

  26.   public int getPriority()  {
  27.     return PRIORITY_MOST_EARLY;
  28.   }

  30.   public boolean removeSpaces()  {
  31.     return true;
  32.   }

  34.   public String[] createNames()  {
  35.     return new String[] { "type", "id", "material" };
  36.   }

  38.   public List<String> read(ItemStack i, List<String> output)  {
  39.    output.add("type:" + i.getType().name());
  40.     return output;
  41.   }

  43.   public boolean isSimilar(ItemStack shop_item, ItemStack player_item, BSBuy buy, Player p)  {
  44.     return shop_item.getType() == player_item.getType();
  45.   }
  46. }
复制代码


监听器例子
  1.   @EventHandler
  2.   public void onRegister(BSRegisterTypesEvent event)  {
  3.     new ItemDataPartMaterial().register();
  4.   }
复制代码