522 lines
15 KiB
Java
522 lines
15 KiB
Java
package world.bentobox.challenges.panel.user;
|
|
|
|
|
|
import java.util.List;
|
|
|
|
import org.bukkit.ChatColor;
|
|
import org.bukkit.Material;
|
|
import org.bukkit.World;
|
|
import org.bukkit.inventory.ItemStack;
|
|
|
|
import world.bentobox.bentobox.api.panels.PanelItem;
|
|
import world.bentobox.bentobox.api.panels.builders.PanelBuilder;
|
|
import world.bentobox.bentobox.api.panels.builders.PanelItemBuilder;
|
|
import world.bentobox.bentobox.api.user.User;
|
|
import world.bentobox.challenges.ChallengesAddon;
|
|
import world.bentobox.challenges.ChallengesManager;
|
|
import world.bentobox.challenges.config.SettingsUtils.VisibilityMode;
|
|
import world.bentobox.challenges.database.object.Challenge;
|
|
import world.bentobox.challenges.panel.CommonGUI;
|
|
import world.bentobox.challenges.tasks.TryToComplete;
|
|
import world.bentobox.challenges.utils.GuiUtils;
|
|
import world.bentobox.challenges.utils.LevelStatus;
|
|
|
|
|
|
/**
|
|
* This is UserGUI class. It contains everything necessary for user to use it.
|
|
*/
|
|
public class ChallengesGUI extends CommonGUI
|
|
{
|
|
// ---------------------------------------------------------------------
|
|
// Section: Constructors
|
|
// ---------------------------------------------------------------------
|
|
|
|
/**
|
|
* Default constructor that inits panels with minimal requirements, without parent panel.
|
|
*
|
|
* @param addon Addon where panel operates.
|
|
* @param world World from which panel was created.
|
|
* @param user User who created panel.
|
|
* @param topLabel Command top label which creates panel (f.e. island or ai)
|
|
* @param permissionPrefix Command permission prefix (f.e. bskyblock.)
|
|
*/
|
|
public ChallengesGUI(ChallengesAddon addon,
|
|
World world,
|
|
User user,
|
|
String topLabel,
|
|
String permissionPrefix)
|
|
{
|
|
super(addon, world, user, topLabel, permissionPrefix);
|
|
this.challengesManager = this.addon.getChallengesManager();
|
|
|
|
this.levelStatusList = this.challengesManager.getAllChallengeLevelStatus(this.user, this.world);
|
|
|
|
for (LevelStatus levelStatus : this.levelStatusList)
|
|
{
|
|
if (levelStatus.isUnlocked())
|
|
{
|
|
this.lastSelectedLevel = levelStatus;
|
|
}
|
|
else
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------
|
|
// Section: Methods
|
|
// ---------------------------------------------------------------------
|
|
|
|
|
|
/**
|
|
* This method builds all necessary elements in GUI panel.
|
|
*/
|
|
@Override
|
|
public void build()
|
|
{
|
|
// Do not open gui if there is no challenges.
|
|
if (!this.challengesManager.hasAnyChallengeData(this.world))
|
|
{
|
|
this.addon.logError("There are no challenges set up!");
|
|
this.user.sendMessage("challenges.errors.no-challenges");
|
|
return;
|
|
}
|
|
|
|
PanelBuilder panelBuilder = new PanelBuilder().user(this.user).
|
|
name(this.user.getTranslation("challenges.gui.title.challenges"));
|
|
|
|
// TODO: get last completed level.
|
|
|
|
int nextItemIndex = 0;
|
|
|
|
if (this.addon.getChallengesSettings().isFreeChallengesFirst())
|
|
{
|
|
this.addFreeChallenges(panelBuilder, nextItemIndex);
|
|
|
|
// Start new row for challenges.
|
|
if (panelBuilder.nextSlot() % 9 != 0)
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot() - panelBuilder.nextSlot() % 9 + 9;
|
|
}
|
|
else
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot();
|
|
}
|
|
}
|
|
|
|
this.addChallenges(panelBuilder, nextItemIndex);
|
|
|
|
// Start new row for levels.
|
|
// Start new row for challenges.
|
|
if (panelBuilder.nextSlot() % 9 != 0)
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot() - panelBuilder.nextSlot() % 9 + 9;
|
|
}
|
|
else
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot();
|
|
}
|
|
|
|
this.addChallengeLevels(panelBuilder, nextItemIndex);
|
|
|
|
if (!this.addon.getChallengesSettings().isFreeChallengesFirst())
|
|
{
|
|
// Start new row for free challenges.
|
|
if (panelBuilder.nextSlot() % 9 != 0)
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot() - panelBuilder.nextSlot() % 9 + 9;
|
|
}
|
|
else
|
|
{
|
|
nextItemIndex = panelBuilder.nextSlot();
|
|
}
|
|
|
|
this.addFreeChallenges(panelBuilder, nextItemIndex);
|
|
}
|
|
|
|
panelBuilder.build();
|
|
}
|
|
|
|
|
|
/**
|
|
* This method adds free challenges to panelBuilder.
|
|
* @param panelBuilder where free challenges must be added.
|
|
* @param firstItemIndex index of first element.
|
|
*/
|
|
private void addFreeChallenges(PanelBuilder panelBuilder, int firstItemIndex)
|
|
{
|
|
List<Challenge> freeChallenges = this.challengesManager.getFreeChallenges(this.world);
|
|
|
|
if (this.addon.getChallengesSettings().isRemoveCompleteOneTimeChallenges())
|
|
{
|
|
freeChallenges.removeIf(challenge -> !challenge.isRepeatable() &&
|
|
this.challengesManager.isChallengeComplete(this.user, this.world, challenge));
|
|
}
|
|
|
|
// Remove all undeployed challenges if VisibilityMode is set to Hidden.
|
|
if (this.addon.getChallengesSettings().getVisibilityMode().equals(VisibilityMode.HIDDEN))
|
|
{
|
|
freeChallenges.removeIf(challenge -> !challenge.isDeployed());
|
|
}
|
|
|
|
final int freeChallengesCount = freeChallenges.size();
|
|
|
|
if (freeChallengesCount > 18)
|
|
{
|
|
int index = firstItemIndex;
|
|
|
|
if (this.freeChallengeIndex > 0)
|
|
{
|
|
panelBuilder.item(index++, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.previous")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.freeChallengeIndex--;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
|
|
int currentIndex = this.freeChallengeIndex;
|
|
|
|
while (panelBuilder.nextSlot() != firstItemIndex + 18 && currentIndex < freeChallengesCount)
|
|
{
|
|
panelBuilder.item(index++, this.getChallengeButton(freeChallenges.get(currentIndex++)));
|
|
}
|
|
|
|
// Check if one challenge is left
|
|
if (currentIndex + 1 == freeChallengesCount)
|
|
{
|
|
panelBuilder.item(index, this.getChallengeButton(freeChallenges.get(currentIndex)));
|
|
}
|
|
else if (currentIndex < freeChallengesCount)
|
|
{
|
|
panelBuilder.item(index, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.next")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.freeChallengeIndex++;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (Challenge challenge : freeChallenges)
|
|
{
|
|
// there are no limitations. Just bunch insert.
|
|
panelBuilder.item(firstItemIndex++, this.getChallengeButton(challenge));
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* This method adds last selected level challenges to panelBuilder.
|
|
* @param panelBuilder where last selected level challenges must be added.
|
|
* @param firstItemIndex index of first element.
|
|
*/
|
|
private void addChallenges(PanelBuilder panelBuilder, int firstItemIndex)
|
|
{
|
|
if (this.lastSelectedLevel != null)
|
|
{
|
|
List<Challenge> challenges = this.challengesManager.getLevelChallenges(this.lastSelectedLevel.getLevel());
|
|
|
|
if (this.addon.getChallengesSettings().isRemoveCompleteOneTimeChallenges())
|
|
{
|
|
challenges.removeIf(challenge -> !challenge.isRepeatable() &&
|
|
this.challengesManager.isChallengeComplete(this.user, this.world, challenge));
|
|
}
|
|
|
|
// Remove all undeployed challenges if VisibilityMode is set to Hidden.
|
|
if (this.addon.getChallengesSettings().getVisibilityMode().equals(VisibilityMode.HIDDEN))
|
|
{
|
|
challenges.removeIf(challenge -> !challenge.isDeployed());
|
|
}
|
|
|
|
final int challengesCount = challenges.size();
|
|
|
|
if (challengesCount > 18)
|
|
{
|
|
int index = firstItemIndex;
|
|
|
|
if (this.pageIndex > 0)
|
|
{
|
|
panelBuilder.item(index++, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.previous")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.pageIndex--;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
|
|
int currentIndex = this.pageIndex;
|
|
|
|
while (panelBuilder.nextSlot() != firstItemIndex + 18 && currentIndex < challengesCount)
|
|
{
|
|
panelBuilder.item(index++, this.getChallengeButton(challenges.get(currentIndex++)));
|
|
}
|
|
|
|
// Check if one challenge is left
|
|
if (currentIndex + 1 == challengesCount)
|
|
{
|
|
panelBuilder.item(index, this.getChallengeButton(challenges.get(currentIndex)));
|
|
}
|
|
else if (currentIndex < challengesCount)
|
|
{
|
|
panelBuilder.item(index, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.next")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.pageIndex++;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (Challenge challenge : challenges)
|
|
{
|
|
// there are no limitations. Just bunch insert.
|
|
panelBuilder.item(firstItemIndex++, this.getChallengeButton(challenge));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* This method adds challenge levels to panelBuilder.
|
|
* @param panelBuilder where challenge levels must be added.
|
|
* @param firstItemIndex index of first element.
|
|
*/
|
|
private void addChallengeLevels(PanelBuilder panelBuilder, int firstItemIndex)
|
|
{
|
|
final int levelCounts = this.levelStatusList.size();
|
|
|
|
if (levelCounts > 9)
|
|
{
|
|
int index = firstItemIndex;
|
|
|
|
if (this.levelIndex > 0)
|
|
{
|
|
panelBuilder.item(index++, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.previous")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.levelIndex--;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
|
|
int currentIndex = this.levelIndex;
|
|
|
|
while (panelBuilder.nextSlot() != firstItemIndex + 9 && currentIndex < levelCounts)
|
|
{
|
|
panelBuilder.item(index++, this.getLevelButton(this.levelStatusList.get(currentIndex++)));
|
|
}
|
|
|
|
// Check if one challenge is left
|
|
if (currentIndex + 1 == levelCounts)
|
|
{
|
|
panelBuilder.item(index, this.getLevelButton(this.levelStatusList.get(currentIndex)));
|
|
}
|
|
else if (currentIndex < levelCounts)
|
|
{
|
|
panelBuilder.item(index, new PanelItemBuilder().
|
|
icon(Material.OAK_SIGN).
|
|
name(this.user.getTranslation("challenges.gui.buttons.next")).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
this.levelIndex++;
|
|
this.build();
|
|
return true;
|
|
}).build());
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (LevelStatus level : this.levelStatusList)
|
|
{
|
|
// there are no limitations. Just bunch insert.
|
|
panelBuilder.item(firstItemIndex++, this.getLevelButton(level));
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// ---------------------------------------------------------------------
|
|
// Section: Icon building
|
|
// ---------------------------------------------------------------------
|
|
|
|
|
|
/**
|
|
* This method creates given challenges icon that on press tries to complete it.
|
|
* @param challenge which icon must be constructed.
|
|
* @return PanelItem icon for challenge.
|
|
*/
|
|
private PanelItem getChallengeButton(Challenge challenge)
|
|
{
|
|
return new PanelItemBuilder().
|
|
icon(challenge.getIcon()).
|
|
name(challenge.getFriendlyName().isEmpty() ?
|
|
challenge.getUniqueId() :
|
|
ChatColor.translateAlternateColorCodes('&', challenge.getFriendlyName())).
|
|
description(GuiUtils.stringSplit(this.generateChallengeDescription(challenge, this.user.getPlayer()),
|
|
this.addon.getChallengesSettings().getLoreLineLength())).
|
|
clickHandler((panel, user1, clickType, slot) -> {
|
|
|
|
// Add ability to input how many repeats player should do.
|
|
// Do not open if challenge is not repeatable.
|
|
|
|
if (clickType.isRightClick() &&
|
|
challenge.isRepeatable() &&
|
|
this.user.hasPermission(this.permissionPrefix + "complete.multiple"))
|
|
{
|
|
new MultipleGUI(this.user,
|
|
this.addon.getChallengesSettings().getLoreLineLength(),
|
|
value -> {
|
|
TryToComplete.complete(this.addon,
|
|
this.user,
|
|
challenge,
|
|
this.world,
|
|
this.topLabel,
|
|
this.permissionPrefix,
|
|
value);
|
|
|
|
this.build();
|
|
});
|
|
}
|
|
else
|
|
{
|
|
if (TryToComplete.complete(this.addon,
|
|
this.user,
|
|
challenge,
|
|
this.world,
|
|
this.topLabel,
|
|
this.permissionPrefix))
|
|
{
|
|
panel.getInventory().setItem(slot, this.getChallengeButton(challenge).getItem());
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}).
|
|
glow(this.addon.getChallengesSettings().isAddCompletedGlow() &&
|
|
this.challengesManager.isChallengeComplete(this.user, this.world, challenge)).
|
|
build();
|
|
}
|
|
|
|
|
|
/**
|
|
* This method creates button for given level.
|
|
* @param level which button must be created.
|
|
* @return Button for given level.
|
|
*/
|
|
private PanelItem getLevelButton(LevelStatus level)
|
|
{
|
|
// Create a nice name for the level
|
|
String name = level.getLevel().getFriendlyName().isEmpty() ?
|
|
level.getLevel().getUniqueId() :
|
|
level.getLevel().getFriendlyName();
|
|
|
|
ItemStack icon;
|
|
List<String> description;
|
|
PanelItem.ClickHandler clickHandler;
|
|
boolean glow;
|
|
|
|
if (level == this.lastSelectedLevel)
|
|
{
|
|
icon = level.getLevel().getIcon();
|
|
description = GuiUtils.stringSplit(
|
|
this.generateLevelDescription(level.getLevel(), user.getPlayer()),
|
|
this.addon.getChallengesSettings().getLoreLineLength());
|
|
clickHandler = null;
|
|
glow = true;
|
|
}
|
|
else if (level.isUnlocked())
|
|
{
|
|
icon = level.getLevel().getIcon();
|
|
description = GuiUtils.stringSplit(
|
|
this.generateLevelDescription(level.getLevel(), user.getPlayer()),
|
|
this.addon.getChallengesSettings().getLoreLineLength());
|
|
clickHandler = (panel, user1, clickType, slot) -> {
|
|
this.lastSelectedLevel = level;
|
|
|
|
// Reset page index for challenges.
|
|
this.pageIndex = 0;
|
|
|
|
this.build();
|
|
return true;
|
|
};
|
|
glow = this.addon.getChallengesSettings().isAddCompletedGlow() &&
|
|
this.challengesManager.isLevelCompleted(this.user, this.world, level.getLevel());
|
|
}
|
|
else
|
|
{
|
|
if (level.getLevel().getLockedIcon() != null)
|
|
{
|
|
// Clone will prevent issues with description storing.
|
|
// It can be done only here as it can be null.
|
|
icon = level.getLevel().getLockedIcon().clone();
|
|
}
|
|
else
|
|
{
|
|
icon = this.addon.getChallengesSettings().getLockedLevelIcon();
|
|
}
|
|
|
|
description = GuiUtils.stringSplit(
|
|
this.user.getTranslation("challenges.gui.descriptions.level-locked",
|
|
"[count]", Integer.toString(level.getNumberOfChallengesStillToDo()),
|
|
"[level]", level.getPreviousLevel().getFriendlyName()),
|
|
this.addon.getChallengesSettings().getLoreLineLength());
|
|
|
|
clickHandler = null;
|
|
glow = false;
|
|
}
|
|
|
|
return new PanelItemBuilder().
|
|
icon(icon).
|
|
name(ChatColor.translateAlternateColorCodes('&', name)).
|
|
description(description).
|
|
glow(glow).
|
|
clickHandler(clickHandler).
|
|
build();
|
|
}
|
|
|
|
|
|
// ---------------------------------------------------------------------
|
|
// Section: Variables
|
|
// ---------------------------------------------------------------------
|
|
|
|
/**
|
|
* This will be used if free challenges are more then 18.
|
|
*/
|
|
private int freeChallengeIndex = 0;
|
|
|
|
/**
|
|
* This will be used if levels are more then 9.
|
|
*/
|
|
private int levelIndex;
|
|
|
|
/**
|
|
* This list contains all information about level completion in current world.
|
|
*/
|
|
private List<LevelStatus> levelStatusList;
|
|
|
|
/**
|
|
* This indicate last selected level.
|
|
*/
|
|
private LevelStatus lastSelectedLevel;
|
|
|
|
/**
|
|
* Challenge Manager object.
|
|
*/
|
|
private ChallengesManager challengesManager;
|
|
}
|