v9.1.0

Author: CryptoMorin

README.md

@@ -45,6 +45,16 @@ another class ([ParticleDisplay](src/main/java/com/cryptomorin/xseries/particles
 </dependency>
 ```
 
+Gradle
+```kotlin
+repositories {
+  mavenCentral()
+}
+dependencies {
+  implementation("com.github.cryptomorin:XSeries:version") { isTransitive = false }
+}
+```
+
 You shouldn't worry if the reflection or other classes are going to use your memory with heavy useless static cache.
 As long as you don't use them anywhere in your code, they won't initialize.
 The memory usage of these utilities are extremely enhanced.
@@ -92,6 +102,20 @@ To shade the library, add the following under your maven plugins:
 </plugin>
 ```
 
+Gradle
+```kotlin
+plugins {
+    java
+    id("com.github.johnrengelman.shadow") version ("7.1.2")
+}
+
+tasks {
+    named<com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar>("shadowJar") {
+        relocate("com.cryptomorin.xseries", "my.plugin.utils")
+    }
+}
+```
+
 ### Contributing
 
 There's always room for improvement. If you know better ways of doing things, I really appreciate it if you can share it with me,

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.cryptomorin</groupId>
     <artifactId>XSeries</artifactId>
-    <version>9.0.0</version>
+    <version>9.1.0</version>
 
     <name>XSeries</name>
     <description>A set of utilities for Minecraft plugins</description>

src/main/java/com/cryptomorin/xseries/NoteBlockMusic.java

@@ -665,7 +665,7 @@ public Instruction(int restatement, int restatementFermata, int fermata) {
         public abstract void play(Player player, Supplier<Location> location);
 
         public long getEstimatedLength() {
-            return restatement * restatementFermata;
+            return (long) restatement * restatementFermata;
         }
     }
 
@@ -727,7 +727,7 @@ public void addInstruction(Instruction instruction) {
 
         @Override
         public long getEstimatedLength() {
-            long result = restatement * restatementFermata;
+            long result = (long) restatement * restatementFermata;
             for (Instruction instruction : instructions) result += instruction.getEstimatedLength();
             return result;
         }

src/main/java/com/cryptomorin/xseries/XItemStack.java

@@ -73,7 +73,7 @@
  * ItemStack: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemStack.html
  *
  * @author Crypto Morin
- * @version 7.2.0.1
+ * @version 7.3.0
  * @see XMaterial
  * @see XPotion
  * @see SkullUtils
@@ -83,6 +83,11 @@
 public final class XItemStack {
     public static final ItemFlag[] ITEM_FLAGS = ItemFlag.values();
 
+    /**
+     * Because item metas cannot be applied to AIR apparently.
+     */
+    private static final XMaterial DEFAULT_MATERIAL = XMaterial.NETHER_PORTAL;
+
     private XItemStack() {}
 
     /**
@@ -182,7 +187,8 @@ public static void serialize(@Nonnull ItemStack item, @Nonnull ConfigurationSect
                 config.set(entry, enchant.getValue());
             }
         } else if (meta instanceof SkullMeta) {
-            config.set("skull", SkullUtils.getSkinValue(meta));
+            String skull = SkullUtils.getSkinValue(meta);
+            if (skull != null) config.set("skull", skull);
         } else if (meta instanceof BannerMeta) {
             BannerMeta banner = (BannerMeta) meta;
             ConfigurationSection patterns = config.createSection("patterns");
@@ -341,6 +347,10 @@ public static void serialize(@Nonnull ItemStack item, @Nonnull ConfigurationSect
         }
     }
 
+    public static boolean isDefaultItem(ItemStack item) {
+        return DEFAULT_MATERIAL.isSimilar(item);
+    }
+
     /**
      * Writes an ItemStack properties into a {@code Map}.
      *
@@ -365,7 +375,7 @@ public static Map<String, Object> serialize(@Nonnull ItemStack item) {
      */
     @Nonnull
     public static ItemStack deserialize(@Nonnull ConfigurationSection config) {
-        return edit(new ItemStack(Material.AIR), config, Function.identity(), null);
+        return edit(new ItemStack(DEFAULT_MATERIAL.parseMaterial()), config, Function.identity(), null);
     }
 
     private static List<String> splitNewLine(String str) {
@@ -414,7 +424,7 @@ public static ItemStack deserialize(@Nonnull ConfigurationSection config,
     public static ItemStack deserialize(@Nonnull ConfigurationSection config,
                                         @Nonnull Function<String, String> translator,
                                         @Nullable Consumer<Exception> restart) {
-        return edit(new ItemStack(Material.AIR), config, translator, restart);
+        return edit(new ItemStack(DEFAULT_MATERIAL.parseMaterial()), config, translator, restart);
     }
 
 
@@ -528,8 +538,18 @@ public static ItemStack edit(@Nonnull ItemStack item,
         int amount = config.getInt("amount");
         if (amount > 1) item.setAmount(amount);
 
-        ItemMeta meta = item.getItemMeta();
-        if (meta == null) return item;
+        ItemMeta meta;
+        { // For Java's stupid closure capture system.
+            ItemMeta tempMeta = item.getItemMeta();
+            if (tempMeta == null) {
+                // When AIR is null. Useful for when you just want to use the meta to save data and
+                // set the type later. A simple CraftMetaItem.
+                meta = Bukkit.getItemFactory().getItemMeta(XMaterial.STONE.parseMaterial());
+            } else {
+                meta = tempMeta;
+            }
+        }
+
 
         // Durability - Damage
         if (supports(13)) {
@@ -881,6 +901,11 @@ public static ItemStack edit(@Nonnull ItemStack item,
         if (!flags.isEmpty()) {
             for (String flag : flags) {
                 flag = flag.toUpperCase(Locale.ENGLISH);
+                if (flag.equals("ALL")) {
+                    meta.addItemFlags(ITEM_FLAGS);
+                    break;
+                }
+
                 ItemFlag itemFlag = Enums.getIfPresent(ItemFlag.class, flag).orNull();
                 if (itemFlag != null) meta.addItemFlags(itemFlag);
             }
@@ -1104,7 +1129,7 @@ public static List<ItemStack> addItems(@Nonnull Inventory inventory, boolean spl
                     if (++lastEmpty == invSize) lastEmpty = -1;
                 } else {
                     ItemStack partialItem = inventory.getItem(firstPartial);
-                    int maxAmount = partialItem.getMaxStackSize();
+                    int maxAmount = split ? partialItem.getMaxStackSize() : inventory.getMaxStackSize();
                     int partialAmount = partialItem.getAmount();
                     int amount = item.getAmount();
                     int sum = amount + partialAmount;

src/main/java/com/cryptomorin/xseries/XMaterial.java

@@ -61,7 +61,7 @@
  * <b>/give @p minecraft:dirt 1 10</b> where 1 is the item amount, and 10 is the data value. The material {@link #DIRT} with a data value of {@code 10} doesn't exist.
  *
  * @author Crypto Morin
- * @version 11.0.0
+ * @version 11.2.0
  * @see Material
  * @see ItemStack
  */
@@ -1009,36 +1009,36 @@ public enum XMaterial {
     POTATOES("POTATO"),
     POTION,
     POTTED_ACACIA_SAPLING(4, "FLOWER_POT"),
-    POTTED_ALLIUM(2, "RED_ROSE", "FLOWER_POT"),
+    POTTED_ALLIUM(2, "FLOWER_POT"),
     POTTED_AZALEA_BUSH,
-    POTTED_AZURE_BLUET(3, "RED_ROSE", "FLOWER_POT"),
+    POTTED_AZURE_BLUET(3, "FLOWER_POT"),
     POTTED_BAMBOO,
     POTTED_BIRCH_SAPLING(2, "FLOWER_POT"),
-    POTTED_BLUE_ORCHID(1, "RED_ROSE", "FLOWER_POT"),
+    POTTED_BLUE_ORCHID(1, "FLOWER_POT"),
     POTTED_BROWN_MUSHROOM("FLOWER_POT"),
     POTTED_CACTUS("FLOWER_POT"),
     POTTED_CORNFLOWER,
     POTTED_CRIMSON_FUNGUS,
     POTTED_CRIMSON_ROOTS,
-    POTTED_DANDELION("YELLOW_FLOWER", "FLOWER_POT"),
+    POTTED_DANDELION("FLOWER_POT"),
     POTTED_DARK_OAK_SAPLING(5, "FLOWER_POT"),
     POTTED_DEAD_BUSH("FLOWER_POT"),
-    POTTED_FERN(2, "LONG_GRASS", "FLOWER_POT"),
+    POTTED_FERN(2, "FLOWER_POT"),
     POTTED_FLOWERING_AZALEA_BUSH,
     POTTED_JUNGLE_SAPLING(3, "FLOWER_POT"),
     POTTED_LILY_OF_THE_VALLEY,
     POTTED_MANGROVE_PROPAGULE,
     POTTED_OAK_SAPLING("FLOWER_POT"),
-    POTTED_ORANGE_TULIP(5, "RED_ROSE", "FLOWER_POT"),
-    POTTED_OXEYE_DAISY(8, "RED_ROSE", "FLOWER_POT"),
-    POTTED_PINK_TULIP(7, "RED_ROSE", "FLOWER_POT"),
-    POTTED_POPPY("RED_ROSE", "FLOWER_POT"),
+    POTTED_ORANGE_TULIP(5, "FLOWER_POT"),
+    POTTED_OXEYE_DAISY(8, "FLOWER_POT"),
+    POTTED_PINK_TULIP(7, "FLOWER_POT"),
+    POTTED_POPPY("FLOWER_POT"),
     POTTED_RED_MUSHROOM("FLOWER_POT"),
-    POTTED_RED_TULIP(4, "RED_ROSE", "FLOWER_POT"),
+    POTTED_RED_TULIP(4, "FLOWER_POT"),
     POTTED_SPRUCE_SAPLING(1, "FLOWER_POT"),
     POTTED_WARPED_FUNGUS,
     POTTED_WARPED_ROOTS,
-    POTTED_WHITE_TULIP(6, "RED_ROSE", "FLOWER_POT"),
+    POTTED_WHITE_TULIP(6, "FLOWER_POT"),
     POTTED_WITHER_ROSE,
     POWDER_SNOW,
     POWDER_SNOW_BUCKET,
@@ -1127,6 +1127,10 @@ public enum XMaterial {
     RED_CARPET(14, "CARPET"),
     RED_CONCRETE(14, "CONCRETE"),
     RED_CONCRETE_POWDER(14, "CONCRETE_POWDER"),
+    /**
+     * 1.13 renamed to ROSE_RED
+     * 1.14 renamed to RED_DYE
+     */
     RED_DYE(1, "INK_SACK", "ROSE_RED"),
     RED_GLAZED_TERRACOTTA,
     RED_MUSHROOM,
@@ -1429,6 +1433,10 @@ public enum XMaterial {
     YELLOW_CARPET(4, "CARPET"),
     YELLOW_CONCRETE(4, "CONCRETE"),
     YELLOW_CONCRETE_POWDER(4, "CONCRETE_POWDER"),
+    /**
+     * 1.13 renamed to DANDELION_YELLOW
+     * 1.14 renamed to YELLOW_DYE
+     */
     YELLOW_DYE(11, "INK_SACK", "DANDELION_YELLOW"),
     YELLOW_GLAZED_TERRACOTTA,
     YELLOW_SHULKER_BOX,
@@ -1570,45 +1578,6 @@ public enum XMaterial {
 
     XMaterial(String... legacy) {this(0, legacy);}
 
-    /**
-     * Checks if the version is 1.13 Aquatic Update or higher.
-     * An invocation of this method yields the cached result from the expression:
-     * <p>
-     * <blockquote>
-     * {@link #supports(int) 13}}
-     * </blockquote>
-     *
-     * @return true if 1.13 or higher.
-     * @see #getVersion()
-     * @see #supports(int)
-     * @since 1.0.0
-     * @deprecated Use {@code XMaterial.supports(13)} instead. This method name can be confusing.
-     */
-    @Deprecated
-    public static boolean isNewVersion() {
-        return Data.ISFLAT;
-    }
-
-    /**
-     * This is just an extra method that can be used for many cases.
-     * It can be used in {@link org.bukkit.event.player.PlayerInteractEvent}
-     * or when accessing {@link org.bukkit.entity.Player#getMainHand()},
-     * or other compatibility related methods.
-     * <p>
-     * An invocation of this method yields exactly the same result as the expression:
-     * <p>
-     * <blockquote>
-     * !{@link #supports(int)} 9
-     * </blockquote>
-     *
-     * @since 2.0.0
-     * @deprecated Use {@code !XMaterial.supports(9)} instead.
-     */
-    @Deprecated
-    public static boolean isOneEight() {
-        return !supports(9);
-    }
-
     /**
      * Gets the XMaterial with this name similar to {@link #valueOf(String)}
      * without throwing an exception.
@@ -1757,11 +1726,15 @@ public static XMaterial matchXMaterial(@Nonnull ItemStack item) {
         }
 
         // Refer to the enum for info.
-        // Currently this is the only material with a non-zero data value
+        // Currently, these are the only materials with a non-zero data value
         // that has been renamed after the flattening update.
-        // If this happens to more materials in the future,
-        // I might have to change then system.
-        if (Data.ISFLAT && !supports(14) && material.equals("CACTUS_GREEN")) return GREEN_DYE;
+        // If this happens to more materials in the future, I might have to change the system.
+        if (supports(13) && !supports(14)) {
+            // https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/diff/src/main/java/org/bukkit/Material.java?until=67d908a9830c71267ee740f5bddd728ce9c64cc7
+            if (material.equals("CACTUS_GREEN")) return GREEN_DYE;
+            if (material.equals("ROSE_RED")) return RED_DYE;
+            if (material.equals("DANDELION_YELLOW")) return YELLOW_DYE;
+        }
 
         // Check FILLED_MAP enum for more info.
         // if (!Data.ISFLAT && item.hasItemMeta() && item.getItemMeta() instanceof org.bukkit.inventory.meta.MapMeta) return FILLED_MAP;
@@ -2162,7 +2135,8 @@ public boolean isSupported() {
      * @param alternateMaterial the material to get if this one is not supported.
      * @return this material or the {@code alternateMaterial} if not supported.
      */
-    public XMaterial or(XMaterial alternateMaterial) {
+    @Nullable
+    public XMaterial or(@Nullable XMaterial alternateMaterial) {
         return isSupported() ? this : alternateMaterial;
     }
 

src/main/java/com/cryptomorin/xseries/XSound.java

@@ -29,7 +29,7 @@
 import org.bukkit.Sound;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Player;
-import org.bukkit.plugin.java.JavaPlugin;
+import org.bukkit.plugin.Plugin;
 import org.bukkit.scheduler.BukkitRunnable;
 import org.bukkit.scheduler.BukkitTask;
 
@@ -55,7 +55,7 @@
  * play command: https://minecraft.gamepedia.com/Commands/play
  *
  * @author Crypto Morin
- * @version 8.0.0
+ * @version 8.0.1
  * @see Sound
  */
 public enum XSound {
@@ -1520,18 +1520,13 @@ public static CompletableFuture<Record> play(@Nonnull Player player, @Nullable S
      * @see #play(Location, String)
      * @since 3.0.0
      */
-    @Nonnull
-    public static CompletableFuture<Record> play(@Nonnull Location location, @Nullable String sound) {
+    @Nullable
+    public static Record play(@Nonnull Location location, @Nullable String sound) {
         Objects.requireNonNull(location, "Cannot play sound to null location");
-        return CompletableFuture.supplyAsync(() -> {
-            Record record = parse(sound);
-            if (record == null) return null;
-            record.atLocation(location).play();
-            return record;
-        }).exceptionally(x -> {
-            x.printStackTrace();
-            return null;
-        });
+        Record record = parse(sound);
+        if (record == null) return null;
+        record.atLocation(location).play();
+        return record;
     }
 
     private static List<String> split(@Nonnull String str, @SuppressWarnings("SameParameterValue") char separatorChar) {
@@ -1680,7 +1675,7 @@ public static void stopMusic(@Nonnull Player player) {
      * @since 2.0.0
      */
     @Nonnull
-    public static BukkitTask playAscendingNote(@Nonnull JavaPlugin plugin, @Nonnull Player player, @Nonnull Entity playTo, @Nonnull Instrument instrument,
+    public static BukkitTask playAscendingNote(@Nonnull Plugin plugin, @Nonnull Player player, @Nonnull Entity playTo, @Nonnull Instrument instrument,
                                                int ascendLevel, int delay) {
         Objects.requireNonNull(player, "Cannot play note from null player");
         Objects.requireNonNull(playTo, "Cannot play note to null entity");
@@ -1754,7 +1749,7 @@ public boolean isSupported() {
      * @since 2.0.0
      */
     @Nonnull
-    public BukkitTask playRepeatedly(@Nonnull JavaPlugin plugin, @Nonnull Entity entity, float volume, float pitch, int repeat, int delay) {
+    public BukkitTask playRepeatedly(@Nonnull Plugin plugin, @Nonnull Entity entity, float volume, float pitch, int repeat, int delay) {
         Objects.requireNonNull(plugin, "Cannot play repeating sound from null plugin");
         Objects.requireNonNull(entity, "Cannot play repeating sound at null location");