Added schematic descriptions Finishes #125

Added `cost-modifier` econ config option
Updated bStats

Author: Mohron

.idea/runConfigurations/SpongeForge.xml

@@ -1,5 +1,12 @@
 # Change Log 
 
+# Beta 30 - Grief Defender Port
+**REQUIRED: Sponge API 7.1 (SF 3682+); Grief Defender 1.12.2-4.3.0.622+; Permissions Plugin (ie. LuckPerms)**
+**OPTIONAL: Nucleus 1.9.0-S7.1+**
+- Added economy `cost-modifier` config to adjust the currency cost of `/is expand` relative to it's block cost
+- Added new schematic features:
+  - `/is schematic setdescription <schematic> <name>` - set an in-game description for a schematic that supports formatting code & newlines (`/n`)
+- Updated bStats to version 1.7
 
 # Beta 29.1 - Grief Defender Port
 **REQUIRED: Sponge API 7.1 (SF 3682+); Grief Defender 1.12.2-4.3.0.622+; Permissions Plugin (ie. LuckPerms)**

CHANGELOG.md

@@ -43,10 +43,6 @@ repositories {
         name = "LuckPerms"
         url = "https://repo.lucko.me/"
     }
-    maven {
-        name = "bStats"
-        url = "http://repo.bstats.org/content/repositories/releases/"
-    }
     maven {
         name = "Aikar"
         url = "https://repo.aikar.co/content/groups/aikar/"

build.gradle

@@ -1,13 +1,13 @@
 ## Version
 major=0
-minor=29
-patch=1
+minor=30
+patch=0
 api=S7.1
-suffix=GRIEF-DEFENDER-PR2
+suffix=GRIEF-DEFENDER
 ## Dependencies
 spongeapi=7.1.0
 spongeforge=1.12.2-2768-7.1.4
 forge=14.23.5.2768
 griefdefender=1.0.0
 nucleus=1.9.0-S7.1
-bstats=1.4
+bstats=1.7

gradle.properties

@@ -118,7 +118,6 @@ public class SkyClaims {
   @Inject
   private Game game;
 
-  @Inject
   private Metrics2 metrics;
 
   @Inject
@@ -142,6 +141,11 @@ public class SkyClaims {
 
   private static final String ISLAND_CLEANUP = "skyclaims.island.cleanup";
 
+  @Inject
+  public SkyClaims(Metrics2.Factory metricsFactory) {
+    metrics = metricsFactory.make(96);
+  }
+
   public static SkyClaims getInstance() {
     return instance;
   }

src/main/java/net/mohron/skyclaims/SkyClaims.java

@@ -229,17 +229,20 @@ protected void listSchematics(Player player, Function<IslandSchematic, Consumer<
 
     if (PLUGIN.getConfig().getMiscConfig().isTextSchematicList()) {
       List<Text> schematicText = schematics.stream()
-          .map(s -> s.getText().toBuilder().onClick(TextActions.executeCallback(mapper.apply(s))).build())
+          .map(s -> s.getText().toBuilder()
+              .onHover(TextActions.showItem(s.getItemStackRepresentation().createSnapshot()))
+              .onClick(TextActions.executeCallback(mapper.apply(s)))
+              .build())
           .collect(Collectors.toList());
 
       PaginationList.builder()
           .title(Text.of(TextColors.AQUA, "Schematics"))
           .padding(Text.of(TextColors.AQUA, TextStyles.STRIKETHROUGH, "-"))
           .contents(schematicText)
           .sendTo(player);
+    } else {
+      player.openInventory(SchematicUI.of(schematics, mapper));
     }
-
-    player.openInventory(SchematicUI.of(schematics, mapper));
   }
 
   protected void clearIslandMemberInventories(Island island, String keepPlayerInv, String keepEnderChestInv) {

src/main/java/net/mohron/skyclaims/command/CommandBase.java

@@ -45,6 +45,7 @@ public static void register() {
         .child(CommandSchematicInfo.commandSpec, "info")
         .child(CommandSchematicList.commandSpec, "list")
         .child(CommandSchematicSetBiome.commandSpec, "setbiome")
+        .child(CommandSchematicSetDescription.commandSpec, "setdescription")
         .child(CommandSchematicSetHeight.commandSpec, "setheight")
         .child(CommandSchematicSetIcon.commandSpec, "seticon")
         .child(CommandSchematicSetName.commandSpec, "setname")
@@ -70,6 +71,7 @@ private static void registerSubCommands() {
     CommandSchematicInfo.register();
     CommandSchematicList.register();
     CommandSchematicSetBiome.register();
+    CommandSchematicSetDescription.register();
     CommandSchematicSetHeight.register();
     CommandSchematicSetIcon.register();
     CommandSchematicSetName.register();

src/main/java/net/mohron/skyclaims/command/schematic/CommandSchematic.java

@@ -113,6 +113,7 @@ private List<Text> getDetails(IslandSchematic schematic) {
     contents.add(Text.of(TextColors.YELLOW, "Author", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getAuthor()));
     contents.add(Text.of(TextColors.YELLOW, "Date", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getDate()));
     contents.add(Text.of(TextColors.YELLOW, "Filename", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getName()));
+    contents.add(Text.of(TextColors.YELLOW, "Description", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getDescriptionText()));
     contents.add(Text.of(TextColors.YELLOW, "Biome", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getBiomeType().map(CatalogType::getName).orElse("none")));
     contents.add(Text.of(TextColors.YELLOW, "Height", TextColors.WHITE, " : ", TextColors.LIGHT_PURPLE, schematic.getHeight().map(Text::of).orElse(NONE)));
     contents.add(Text.of(TextColors.YELLOW, "Icon", TextColors.WHITE, " : ", TextColors.GRAY, schematic.getIcon().map(i -> Text.of(i).toText()).orElse(NONE)));

src/main/java/net/mohron/skyclaims/command/schematic/CommandSchematicInfo.java

@@ -0,0 +1,81 @@
+/*
+ * SkyClaims - A Skyblock plugin made for Sponge
+ * Copyright (C) 2017 Mohron
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * SkyClaims is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with SkyClaims.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.mohron.skyclaims.command.schematic;
+
+import net.mohron.skyclaims.command.CommandBase;
+import net.mohron.skyclaims.command.argument.Arguments;
+import net.mohron.skyclaims.permissions.Permissions;
+import net.mohron.skyclaims.schematic.IslandSchematic;
+import org.spongepowered.api.command.CommandException;
+import org.spongepowered.api.command.CommandResult;
+import org.spongepowered.api.command.CommandSource;
+import org.spongepowered.api.command.args.CommandContext;
+import org.spongepowered.api.command.args.GenericArguments;
+import org.spongepowered.api.command.spec.CommandSpec;
+import org.spongepowered.api.text.Text;
+import org.spongepowered.api.text.format.TextColors;
+
+public class CommandSchematicSetDescription extends CommandBase {
+
+  public static final String HELP_TEXT = "used to set the name for a schematic";
+  private static final Text SCHEMATIC = Text.of("schematic");
+  private static final Text DESCRIPTION = Text.of("description");
+
+  public static CommandSpec commandSpec = CommandSpec.builder()
+      .permission(Permissions.COMMAND_SCHEMATIC_SET_NAME)
+      .description(Text.of(HELP_TEXT))
+      .arguments(
+          Arguments.schematic(SCHEMATIC),
+          GenericArguments.optional(GenericArguments.remainingRawJoinedStrings(DESCRIPTION))
+      )
+      .executor(new CommandSchematicSetDescription())
+      .build();
+
+  public static void register() {
+    try {
+      PLUGIN.getGame().getCommandManager().register(PLUGIN, commandSpec);
+      PLUGIN.getLogger().debug("Registered command: CommandSchematicSetDescription");
+    } catch (UnsupportedOperationException e) {
+      PLUGIN.getLogger().error("Failed to register command: CommandSchematicSetDescription", e);
+    }
+  }
+
+  @Override
+  public CommandResult execute(CommandSource src, CommandContext args) throws CommandException {
+    IslandSchematic schematic = args.<IslandSchematic>getOne(SCHEMATIC)
+        .orElseThrow(() -> new CommandException(Text.of(TextColors.RED, "You must provide a schematic to use this command!")));
+    String description = args.<String>getOne(DESCRIPTION).orElse(null);
+
+    if (description != null) {
+      schematic.setDescription(description.replace("\\n", "\n"));
+    } else {
+      schematic.setDescription(null);
+    }
+
+    if (PLUGIN.getSchematicManager().save(schematic)) {
+      src.sendMessage(Text.of(
+          TextColors.GREEN, "Successfully updated schematic description to", TextColors.WHITE, ":", Text.NEW_LINE,
+          TextColors.RESET, schematic.getDescriptionText()
+      ));
+      return CommandResult.success();
+    } else {
+      throw new CommandException(Text.of(TextColors.RED, "Failed to update schematic."));
+    }
+  }
+}

src/main/java/net/mohron/skyclaims/command/schematic/CommandSchematicSetDescription.java

@@ -138,7 +138,7 @@ private Consumer<CommandSource> expandIsland(Island island, Claim claim, int blo
         ));
         return;
       }
-      int cost = getCost(blocks, claim);
+      double cost = getCost(blocks, claim);
 
       // Attempt to charge the required currency to the island owner.
       if (charge(island, cost)) {
@@ -170,12 +170,14 @@ private boolean exceedsMaxSize(Island island, Claim claim, int blocks) {
     return claim.getWidth() + blocks * 2 > Options.getMaxSize(island.getOwnerUniqueId()) * 2;
   }
 
-  private int getCost(int blocks, Claim claim) {
-    return (int) Math.pow(claim.getWidth() + blocks, 2)
-        * (GriefDefender.getCore().getClaimBlockSystem() == ClaimBlockSystem.VOLUME ? 256 : 1) - claim.getClaimBlocks();
+  private double getCost(int blocks, Claim claim) {
+    final int claimSystemModifier = GriefDefender.getCore().getClaimBlockSystem() == ClaimBlockSystem.VOLUME ? 256 : 1;
+    final double newBlocks = Math.pow(claim.getWidth() + blocks, 2) * claimSystemModifier - claim.getClaimBlocks();
+
+    return Math.round(newBlocks * PLUGIN.getConfig().getEconomyConfig().getCostModifier() * 100) / 100.0;
   }
 
-  private boolean charge(Island island, int cost) {
+  private boolean charge(Island island, double cost) {
     EconomyConfig config = PLUGIN.getConfig().getEconomyConfig();
     Optional<EconomyService> economyService = Sponge.getServiceManager().provide(EconomyService.class);
 
@@ -200,7 +202,7 @@ private boolean charge(Island island, int cost) {
       if (data.isPresent()) {
         if (data.get().getRemainingClaimBlocks() >= cost) {
           // Use the Owner's claim blocks to expand the island
-          data.get().setBonusClaimBlocks(data.get().getBonusClaimBlocks() - cost);
+          data.get().setBonusClaimBlocks(data.get().getBonusClaimBlocks() - (int) Math.round(cost));
           return true;
         }
         return false;