Skip to content

Commit

Permalink
Improve item description management.
Browse files Browse the repository at this point in the history
  • Loading branch information
@BONNe
BONNe committed Jun 16, 2019
1 parent 68a26e4 commit 071c6ca
Show file tree
Hide file tree
Showing 5 changed files with 191 additions and 128 deletions.
200 changes: 145 additions & 55 deletions src/main/java/world/bentobox/challenges/panel/CommonGUI.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,19 @@

import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.entity.EntityType;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.BookMeta;
import org.bukkit.inventory.meta.EnchantmentStorageMeta;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.inventory.meta.KnowledgeBookMeta;
import org.bukkit.inventory.meta.LeatherArmorMeta;
import org.bukkit.inventory.meta.PotionMeta;
import org.bukkit.inventory.meta.SkullMeta;
import org.bukkit.inventory.meta.SpawnEggMeta;
import org.bukkit.inventory.meta.TropicalFishBucketMeta;
import org.bukkit.potion.PotionData;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
Expand Down Expand Up @@ -546,23 +555,7 @@ private List<String> getChallengeRewardItems(Challenge challenge, boolean isComp
result.add(this.user.getTranslation("challenges.gui.challenge-description.reward-items"));

Utils.groupEqualItems(rewardItems).forEach(itemStack ->
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
});
result.addAll(this.generateItemStackDescription(itemStack)));
}

// Add message about reward commands
Expand Down Expand Up @@ -630,26 +623,8 @@ private List<String> getChallengeRequiredItems(Challenge challenge)
{
result.add(this.user.getTranslation("challenges.gui.challenge-description.required-items"));

Utils.groupEqualItems(challenge.getRequiredItems()).forEach(itemStack -> {
result.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]",
entry.getKey().getKey().getKey(),
"[level]",
Integer.toString(entry.getValue())));
}
});
Utils.groupEqualItems(challenge.getRequiredItems()).forEach(itemStack ->
result.addAll(this.generateItemStackDescription(itemStack)));
}

if (challenge.getChallengeType().equals(Challenge.ChallengeType.ISLAND) &&
Expand Down Expand Up @@ -779,23 +754,7 @@ protected List<String> generateLevelDescription(ChallengeLevel level, Player use
result.add(this.user.getTranslation("challenges.gui.level-description.reward-items"));

Utils.groupEqualItems(level.getRewardItems()).forEach(itemStack ->
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
result.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
});
result.addAll(this.generateItemStackDescription(itemStack)));
}

// Add message about reward commands
Expand Down Expand Up @@ -825,5 +784,136 @@ protected List<String> generateLevelDescription(ChallengeLevel level, Player use

return result;
}


// ---------------------------------------------------------------------
// Section: ItemStack Description
// ---------------------------------------------------------------------


/**
* This method generates decsription for given item stack object.
* @param itemStack Object which lore must be generated
* @return List with generated description
*/
protected List<String> generateItemStackDescription(ItemStack itemStack)
{
List<String> result = new ArrayList<>();

result.add(this.user.getTranslation("challenges.gui.item-description.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta())
{
ItemMeta meta = itemStack.getItemMeta();

if (meta.hasDisplayName())
{
result.add(this.user.getTranslation("challenges.gui.item-description.item-name",
"[name]", meta.getDisplayName()));
}

if (meta.hasLore())
{
result.add(this.user.getTranslation("challenges.gui.item-description.item-lore"));
result.addAll(meta.getLore());
}

if (meta instanceof BookMeta)
{
result.add(this.user.getTranslation("challenges.gui.item-description.book-meta",
"[author]", ((BookMeta) meta).getAuthor(),
"[title]", ((BookMeta) meta).getTitle()));
}
else if (meta instanceof EnchantmentStorageMeta)
{
((EnchantmentStorageMeta) meta).getStoredEnchants().forEach(((enchantment, level) -> {
result.add(this.user.getTranslation("challenges.gui.item-description.item-enchant",
"[enchant]", enchantment.getKey().getKey(), "[level]", Integer.toString(level)));
}));
}
else if (meta instanceof KnowledgeBookMeta)
{
result.add(this.user.getTranslation("challenges.gui.item-description.recipe-count",
"[count]", Integer.toString(((KnowledgeBookMeta) meta).getRecipes().size())));
}
else if (meta instanceof LeatherArmorMeta)
{
result.add(this.user.getTranslation("challenges.gui.item-description.armor-color",
"[color]", ((LeatherArmorMeta) meta).getColor().toString()));
}
else if (meta instanceof PotionMeta)
{
PotionData data = ((PotionMeta) meta).getBasePotionData();

if (data.isExtended() && data.isUpgraded())
{
result.add(this.user.getTranslation("challenges.gui.item-description.potion-type-extended-upgraded",
"[name]", data.getType().name()));
}
else if (data.isUpgraded())
{
result.add(this.user.getTranslation("challenges.gui.item-description.potion-type-upgraded",
"[name]", data.getType().name()));
}
else if (data.isExtended())
{
result.add(this.user.getTranslation("challenges.gui.item-description.potion-type-extended",
"[name]", data.getType().name()));
}
else
{
result.add(this.user.getTranslation("challenges.gui.item-description.potion-type",
"[name]", data.getType().name()));
}

if (((PotionMeta) meta).hasCustomEffects())
{
result.add(this.user.getTranslation("challenges.gui.item-description.custom-effects"));

((PotionMeta) meta).getCustomEffects().forEach(potionEffect ->
result.add(this.user.getTranslation("challenges.gui.item-description.potion-effect",
"[effect]", potionEffect.getType().getName(),
"[duration]", Integer.toString(potionEffect.getDuration()),
"[amplifier]", Integer.toString(potionEffect.getAmplifier()))));
}
}
else if (meta instanceof SkullMeta)
{
if (((SkullMeta) meta).getOwningPlayer() != null)
{
result.add(this.user.getTranslation("challenges.gui.item-description.skull-owner",
"[owner]", ((SkullMeta) meta).getOwningPlayer().getName()));
}
}
else if (meta instanceof SpawnEggMeta)
{
result.add(this.user.getTranslation("challenges.gui.item-description.egg-meta",
"[mob]", ((SpawnEggMeta) meta).getSpawnedType().name()));
}
else if (meta instanceof TropicalFishBucketMeta)
{
result.add(this.user.getTranslation("challenges.gui.item-description.fish-meta",
"[pattern]", ((TropicalFishBucketMeta) meta).getPattern().name(),
"[pattern-color]", ((TropicalFishBucketMeta) meta).getPatternColor().name(),
"[body-color]", ((TropicalFishBucketMeta) meta).getBodyColor().name()));
// parse ne
}

if (meta.hasEnchants())
{
itemStack.getEnchantments().forEach((enchantment, level) -> {
result.add(this.user.getTranslation("challenges.gui.item-description.item-enchant",
"[enchant]",
enchantment.getKey().getKey(),
"[level]",
Integer.toString(level)));
});
}
}

return result;
}
}

62 changes: 7 additions & 55 deletions src/main/java/world/bentobox/challenges/panel/admin/EditChallengeGUI.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.entity.EntityType;
import org.bukkit.inventory.ItemStack;
import java.util.*;
Expand All @@ -22,6 +21,7 @@
import world.bentobox.challenges.panel.util.SelectEnvironmentGUI;
import world.bentobox.challenges.panel.util.StringListGUI;
import world.bentobox.challenges.utils.GuiUtils;
import world.bentobox.challenges.utils.Utils;


/**
Expand Down Expand Up @@ -716,24 +716,8 @@ else if (this.challenge.getChallengeType().equals(Challenge.ChallengeType.OTHER)
description = new ArrayList<>(this.challenge.getRequiredItems().size() + 1);
description.add(this.user.getTranslation("challenges.gui.descriptions.admin.required-items"));

for (ItemStack itemStack : this.challenge.getRequiredItems())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
}
Utils.groupEqualItems(this.challenge.getRequiredItems()).forEach(itemStack ->
description.addAll(this.generateItemStackDescription(itemStack)));

icon = new ItemStack(Material.CHEST);
clickHandler = (panel, user, clickType, slot) -> {
Expand Down Expand Up @@ -919,24 +903,8 @@ else if (this.challenge.getChallengeType().equals(Challenge.ChallengeType.OTHER)
description = new ArrayList<>(this.challenge.getRewardItems().size() + 1);
description.add(this.user.getTranslation("challenges.gui.descriptions.admin.reward-items"));

for (ItemStack itemStack : this.challenge.getRewardItems())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
}
Utils.groupEqualItems(this.challenge.getRewardItems()).forEach(itemStack ->
description.addAll(this.generateItemStackDescription(itemStack)));

icon = new ItemStack(Material.CHEST);
clickHandler = (panel, user, clickType, slot) -> {
Expand Down Expand Up @@ -1109,24 +1077,8 @@ else if (this.challenge.getChallengeType().equals(Challenge.ChallengeType.OTHER)
description = new ArrayList<>(this.challenge.getRepeatItemReward().size() + 1);
description.add(this.user.getTranslation("challenges.gui.descriptions.admin.repeat-reward-items"));

for (ItemStack itemStack : this.challenge.getRepeatItemReward())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
}
Utils.groupEqualItems(this.challenge.getRepeatItemReward()).forEach(itemStack ->
description.addAll(this.generateItemStackDescription(itemStack)));

icon = new ItemStack(Material.TRAPPED_CHEST);
clickHandler = (panel, user, clickType, slot) -> {
Expand Down
21 changes: 3 additions & 18 deletions src/main/java/world/bentobox/challenges/panel/admin/EditLevelGUI.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import world.bentobox.challenges.panel.util.SelectChallengeGUI;
import world.bentobox.challenges.panel.util.StringListGUI;
import world.bentobox.challenges.utils.GuiUtils;
import world.bentobox.challenges.utils.Utils;


/**
Expand Down Expand Up @@ -519,24 +520,8 @@ private PanelItem createButton(Button button)
description = new ArrayList<>(this.challengeLevel.getRewardItems().size() + 1);
description.add(this.user.getTranslation("challenges.gui.descriptions.admin.reward-items"));

for (ItemStack itemStack : this.challengeLevel.getRewardItems())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item",
"[item]", itemStack.getType().name(),
"[count]", Integer.toString(itemStack.getAmount())));

if (itemStack.hasItemMeta() && itemStack.getEnchantments().isEmpty())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-meta",
"[meta]", itemStack.getItemMeta().toString()));
}

for (Map.Entry<Enchantment, Integer> entry : itemStack.getEnchantments().entrySet())
{
description.add(this.user.getTranslation("challenges.gui.descriptions.item-enchant",
"[enchant]", entry.getKey().getKey().getKey(), "[level]", Integer.toString(entry.getValue())));
}
}
Utils.groupEqualItems(this.challengeLevel.getRewardItems()).forEach(itemStack ->
description.addAll(this.generateItemStackDescription(itemStack)));

icon = new ItemStack(Material.CHEST);
clickHandler = (panel, user, clickType, slot) -> {
Expand Down
18 changes: 18 additions & 0 deletions src/main/resources/locales/en-US.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,24 @@ challenges:
money-reward: '&6Money reward: $[value]'
reward-items: '&6Reward Items:'
reward-commands: '&6Reward Commands:'
item-description:
item: '- [count] x [item]'
item-meta: ' ([meta])'
item-enchant: ' - [enchant] [level]'
item-name: ' [name]'
item-lore: ' Item Lore:'
book-meta: ' [title] by [author]'
recipe-count: ' [count] recipes'
armor-color: ' [color]'
potion-type-extended-upgraded: ' Extended and upgraded [name]'
potion-type-upgraded: ' Upgraded [name]'
potion-type-extended: ' Extended [name]'
potion-type: ' [name]'
custom-effects: ' Custom Effects:'
potion-effect: ' [effect] x [amplifier] for [duration]t'
skull-owner: ' [owner]'
egg-meta: ' [mob]'
fish-meta: ' [body-color] with [pattern-color] [pattern]'
titles:
# Title and subtitle my contain variable in [] that will be replaced with proper message from challenge object.
# [friendlyName] will be replaced with challenge friendly name.
Expand Down

0 comments on commit 071c6ca

Please sign in to comment.