Merge pull request #3232 from svr333/FixCategoryNaming

Rename category -> itemGroup

Author: TheBusyBiscuit

src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/GPSNetwork.java

@@ -158,7 +158,7 @@ public void openTransmitterControlPanel(@Nonnull Player p) {
         menu.addItem(4, new CustomItemStack(SlimefunItems.GPS_CONTROL_PANEL, "&7Network Info", "", "&8\u21E8 &7Status: " + (complexity > 0 ? "&2&lONLINE" : "&4&lOFFLINE"), "&8\u21E8 &7Complexity: &f" + complexity));
         menu.addMenuClickHandler(4, ChestMenuUtils.getEmptyClickHandler());
 
-        menu.addItem(6, new CustomItemStack(HeadTexture.GLOBE_OVERWORLD.getAsItemStack(), "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.waypoints"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-category")));
+        menu.addItem(6, new CustomItemStack(HeadTexture.GLOBE_OVERWORLD.getAsItemStack(), "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.waypoints"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
         menu.addMenuClickHandler(6, (pl, slot, item, action) -> {
             openWaypointControlPanel(pl);
             return false;
@@ -221,7 +221,7 @@ public void openWaypointControlPanel(@Nonnull Player p) {
                 menu.addItem(slot, ChestMenuUtils.getBackground(), ChestMenuUtils.getEmptyClickHandler());
             }
 
-            menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER, "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.transmitters"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-category")));
+            menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER, "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.transmitters"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
             menu.addMenuClickHandler(2, (pl, slot, item, action) -> {
                 openTransmitterControlPanel(pl);
                 return false;

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/ItemGroup.java

@@ -202,7 +202,7 @@ public void remove(@Nonnull SlimefunItem item) {
     @Nonnull
     public ItemStack getItem(@Nonnull Player p) {
         return new CustomItemStack(item, meta -> {
-            String name = Slimefun.getLocalization().getCategoryName(p, getKey());
+            String name = Slimefun.getLocalization().getItemGroupName(p, getKey());
 
             if (name == null) {
                 name = item.getItemMeta().getDisplayName();
@@ -214,7 +214,7 @@ public ItemStack getItem(@Nonnull Player p) {
                 meta.setDisplayName(ChatColor.YELLOW + name);
             }
 
-            meta.setLore(Arrays.asList("", ChatColor.GRAY + "\u21E8 " + ChatColor.GREEN + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-category")));
+            meta.setLore(Arrays.asList("", ChatColor.GRAY + "\u21E8 " + ChatColor.GREEN + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
         });
     }
 
@@ -240,7 +240,7 @@ public String getUnlocalizedName() {
      */
     @Nonnull
     public String getDisplayName(@Nonnull Player p) {
-        String localized = Slimefun.getLocalization().getCategoryName(p, getKey());
+        String localized = Slimefun.getLocalization().getItemGroupName(p, getKey());
 
         if (localized != null) {
             return localized;

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/SlimefunItem.java

@@ -500,7 +500,7 @@ public void register(@Nonnull SlimefunAddon addon) {
      * <strong>This method is for internal purposes, like {@link ItemGroup} registration only</strong>
      */
     private final void onEnable() {
-        // Register the Category too if it hasn't been registered yet
+        // Register the ItemGroup too if it hasn't been registered yet
         if (!itemGroup.isRegistered()) {
             itemGroup.register(addon);
         }
@@ -671,16 +671,16 @@ public void setRecipeType(@Nonnull RecipeType type) {
     /**
      * This sets the {@link ItemGroup} in which this {@link SlimefunItem} will be displayed.
      * 
-     * @param category
+     * @param itemGroup
      *            The new {@link ItemGroup}
      */
-    public void setItemGroup(@Nonnull ItemGroup category) {
-        Validate.notNull(category, "The Category is not allowed to be null!");
+    public void setItemGroup(@Nonnull ItemGroup itemGroup) {
+        Validate.notNull(itemGroup, "The ItemGroup is not allowed to be null!");
 
         this.itemGroup.remove(this);
-        category.add(this);
+        itemGroup.add(this);
 
-        this.itemGroup = category;
+        this.itemGroup = itemGroup;
     }
 
     /**

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/FlexItemGroup.java

@@ -38,7 +38,7 @@ protected FlexItemGroup(NamespacedKey key, ItemStack item, int tier) {
 
     /**
      * This method returns whether this {@link FlexItemGroup} is visible under the given context.
-     * Implementing this method gives full flexibility over who can see the Category when and where.
+     * Implementing this method gives full flexibility over who can see the ItemGroup when and where.
      * 
      * @param p
      *            The {@link Player} who opened his {@link SlimefunGuide}
@@ -78,22 +78,22 @@ public final boolean isHidden(@Nonnull Player p) {
 
     @Override
     public final void add(@Nonnull SlimefunItem item) {
-        throw new UnsupportedOperationException("You cannot add items to a FlexCategory!");
+        throw new UnsupportedOperationException("You cannot add items to a FlexItemGroup!");
     }
 
     @Override
     public final @Nonnull List<SlimefunItem> getItems() {
-        throw new UnsupportedOperationException("A FlexCategory has no items!");
+        throw new UnsupportedOperationException("A FlexItemGroup has no items!");
     }
 
     @Override
     public final boolean contains(SlimefunItem item) {
-        throw new UnsupportedOperationException("A FlexCategory has no items!");
+        throw new UnsupportedOperationException("A FlexItemGroup has no items!");
     }
 
     @Override
     public final void remove(@Nonnull SlimefunItem item) {
-        throw new UnsupportedOperationException("A FlexCategory has no items, so there is nothing remove!");
+        throw new UnsupportedOperationException("A FlexItemGroup has no items, so there is nothing remove!");
     }
 
 }

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/LockedItemGroup.java

@@ -87,9 +87,9 @@ public void register(@Nonnull SlimefunAddon addon) {
             }
         }
 
-        for (ItemGroup category : Slimefun.getRegistry().getAllItemGroups()) {
-            if (namespacedKeys.remove(category.getKey())) {
-                addParent(category);
+        for (ItemGroup itemGroup : Slimefun.getRegistry().getAllItemGroups()) {
+            if (namespacedKeys.remove(itemGroup.getKey())) {
+                addParent(itemGroup);
             }
         }
 

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/NestedItemGroup.java

@@ -102,10 +102,10 @@ private void openGuide(Player p, PlayerProfile profile, SlimefunGuideMode mode,
         while (target < (subGroups.size() - 1) && index < GROUP_SIZE + 9) {
             target++;
 
-            SubItemGroup category = subGroups.get(target);
-            menu.addItem(index, category.getItem(p));
+            SubItemGroup itemGroup = subGroups.get(target);
+            menu.addItem(index, itemGroup.getItem(p));
             menu.addMenuClickHandler(index, (pl, slot, item, action) -> {
-                SlimefunGuide.openCategory(profile, category, mode, 1);
+                SlimefunGuide.openItemGroup(profile, itemGroup, mode, 1);
                 return false;
             });
 

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/groups/SeasonalItemGroup.java

@@ -57,7 +57,7 @@ public SeasonalItemGroup(NamespacedKey key, Month month, int tier, ItemStack ite
 
     @Override
     public boolean isHidden(@Nonnull Player p) {
-        // Hide this Category if the month differs
+        // Hide this ItemGroup if the month differs
         if (month != LocalDate.now().getMonth()) {
             return true;
         }

src/main/java/io/github/thebusybiscuit/slimefun4/api/researches/Research.java

@@ -199,24 +199,24 @@ public List<SlimefunItem> getAffectedItems() {
      *            The {@link PlayerProfile} of that {@link Player}.
      * @param sfItem
      *            The {@link SlimefunItem} on which the {@link Player} clicked.
-     * @param category
+     * @param itemGroup
      *            The {@link ItemGroup} where the {@link Player} was.
      * @param page
      *            The page number of where the {@link Player} was in the {@link ItemGroup};
      *
      */
     @ParametersAreNonnullByDefault
-    public void unlockFromGuide(SlimefunGuideImplementation guide, Player player, PlayerProfile profile, SlimefunItem sfItem, ItemGroup category, int page) {
+    public void unlockFromGuide(SlimefunGuideImplementation guide, Player player, PlayerProfile profile, SlimefunItem sfItem, ItemGroup itemGroup, int page) {
         if (!Slimefun.getRegistry().getCurrentlyResearchingPlayers().contains(player.getUniqueId())) {
             if (profile.hasUnlocked(this)) {
-                guide.openItemGroup(profile, category, page);
+                guide.openItemGroup(profile, itemGroup, page);
             } else {
                 PlayerPreResearchEvent event = new PlayerPreResearchEvent(player, this, sfItem);
                 Bukkit.getPluginManager().callEvent(event);
 
                 if (!event.isCancelled()) {
                     if (this.canUnlock(player)) {
-                        guide.unlockItem(player, sfItem, pl -> guide.openItemGroup(profile, category, page));
+                        guide.unlockItem(player, sfItem, pl -> guide.openItemGroup(profile, itemGroup, page));
                     } else {
                         Slimefun.getLocalization().sendMessage(player, "messages.not-enough-xp", true);
                     }

src/main/java/io/github/thebusybiscuit/slimefun4/core/guide/GuideHistory.java

@@ -74,13 +74,13 @@ public int getMainMenuPage() {
      * Should the {@link ItemGroup} already be the last element in this {@link GuideHistory},
      * then the entry will be overridden with the new page.
      * 
-     * @param category
+     * @param itemGroup
      *            The {@link ItemGroup} that should be added to this {@link GuideHistory}
      * @param page
      *            The current page of the {@link ItemGroup} that should be stored
      */
-    public void add(@Nonnull ItemGroup category, int page) {
-        refresh(category, page);
+    public void add(@Nonnull ItemGroup itemGroup, int page) {
+        refresh(itemGroup, page);
     }
 
     /**

src/main/java/io/github/thebusybiscuit/slimefun4/core/guide/SlimefunGuide.java

@@ -82,8 +82,8 @@ public static void openMainMenu(PlayerProfile profile, SlimefunGuideMode mode, i
     }
 
     @ParametersAreNonnullByDefault
-    public static void openCategory(PlayerProfile profile, ItemGroup category, SlimefunGuideMode mode, int selectedPage) {
-        Slimefun.getRegistry().getSlimefunGuide(mode).openItemGroup(profile, category, selectedPage);
+    public static void openItemGroup(PlayerProfile profile, ItemGroup itemGroup, SlimefunGuideMode mode, int selectedPage) {
+        Slimefun.getRegistry().getSlimefunGuide(mode).openItemGroup(profile, itemGroup, selectedPage);
     }
 
     @ParametersAreNonnullByDefault