Add a History feature to the questbook #156
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| package betterquesting.api2.client.gui.panels.lists; | ||
|
|
||
| import betterquesting.api.api.QuestingAPI; | ||
| import betterquesting.api.properties.NativeProps; | ||
| import betterquesting.api.questing.IQuest; | ||
| import betterquesting.api.questing.IQuestLine; | ||
| import betterquesting.api.questing.IQuestLineEntry; | ||
| import betterquesting.api2.client.gui.controls.PanelButtonCustom; | ||
| import betterquesting.api2.client.gui.controls.PanelButtonQuest; | ||
| import betterquesting.api2.client.gui.misc.GuiRectangle; | ||
| import betterquesting.api2.client.gui.misc.IGuiRect; | ||
| import betterquesting.api2.client.gui.panels.content.PanelTextBox; | ||
| import betterquesting.api2.client.gui.themes.presets.PresetColor; | ||
| import betterquesting.api2.storage.DBEntry; | ||
| import betterquesting.api2.utils.QuestTranslation; | ||
| import betterquesting.misc.QuestHistoryEntry; | ||
| import betterquesting.questing.QuestDatabase; | ||
| import betterquesting.questing.QuestLineDatabase; | ||
| import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap; | ||
| import net.minecraft.entity.player.EntityPlayer; | ||
| import net.minecraft.nbt.NBTTagCompound; | ||
|
|
||
| import java.text.DateFormat; | ||
| import java.util.ArrayDeque; | ||
| import java.util.ArrayList; | ||
| import java.util.Comparator; | ||
| import java.util.Date; | ||
| import java.util.Iterator; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import java.util.function.Consumer; | ||
|
|
||
| public class CanvasQuestHistory extends CanvasSearch<QuestHistoryEntry, QuestHistoryEntry> { | ||
| private List<QuestHistoryEntry> historyList; | ||
| private Consumer<QuestHistoryEntry> questOpenCallback; | ||
| private final EntityPlayer player; | ||
| private RepeatableFilter repeatableFilter = RepeatableFilter.SHOW_ALL; | ||
|
|
||
| public CanvasQuestHistory(IGuiRect rect, EntityPlayer player) { | ||
| super(rect); | ||
| this.player = player; | ||
| } | ||
|
|
||
| @Override | ||
| protected Iterator<QuestHistoryEntry> getIterator() { | ||
| if (historyList == null) { | ||
| historyList = collectHistory(); | ||
| } | ||
|
|
||
| return historyList.iterator(); | ||
| } | ||
|
|
||
| private List<QuestHistoryEntry> collectHistory() { | ||
| Map<Integer, QuestHistoryEntry> historyEntries = new Int2ObjectOpenHashMap<>(); | ||
| UUID questingUUID = QuestingAPI.getQuestingUUID(player); | ||
|
|
||
| for (DBEntry<IQuestLine> questLine : QuestLineDatabase.INSTANCE.getEntries()) { | ||
| for (DBEntry<IQuestLineEntry> questLineEntry : questLine.getValue().getEntries()) { | ||
| int questId = questLineEntry.getID(); | ||
| if (historyEntries.containsKey(questId)) { | ||
| continue; | ||
| } | ||
|
|
||
| IQuest quest = QuestDatabase.INSTANCE.getValue(questId); | ||
| if (quest == null) { | ||
| continue; | ||
| } | ||
|
|
||
| NBTTagCompound completionInfo = quest.getCompletionInfo(questingUUID); | ||
| if (completionInfo == null) { | ||
| continue; | ||
| } | ||
|
|
||
| DBEntry<IQuest> questEntry = new DBEntry<>(questId, quest); | ||
| long timestamp = quest.getLastCompletedAt(questingUUID); | ||
| if (timestamp <= 0) { | ||
| continue; | ||
| } | ||
|
|
||
| boolean repeatable = quest.getProperty(NativeProps.REPEAT_TIME) >= 0; | ||
| boolean pendingRewards = repeatable && quest.canClaimBasically(player); | ||
| historyEntries.put(questId, new QuestHistoryEntry(questEntry, questLine, timestamp, repeatable, pendingRewards)); | ||
| } | ||
| } | ||
|
|
||
| List<QuestHistoryEntry> sortedEntries = new ArrayList<>(historyEntries.values()); | ||
| sortedEntries.sort(Comparator.comparingLong(QuestHistoryEntry::getCompletionTimestamp) | ||
| .reversed() | ||
| .thenComparingInt(entry -> entry.getQuest().getID())); | ||
| return sortedEntries; | ||
| } | ||
|
|
||
| @Override | ||
| protected void queryMatches(QuestHistoryEntry entry, String query, ArrayDeque<QuestHistoryEntry> results) { | ||
| if (entry.isRepeatable()) { | ||
| if (repeatableFilter == RepeatableFilter.HIDE) { | ||
| return; | ||
| } | ||
|
|
||
| if (repeatableFilter == RepeatableFilter.SHOW_PENDING_REWARDS && !entry.hasPendingRewards()) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| results.add(entry); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean addResult(QuestHistoryEntry entry, int index, int cachedWidth) { | ||
| GuiRectangle buttonRect = new GuiRectangle(0, index * 32, cachedWidth, 32, 0); | ||
| PanelButtonCustom buttonContainer = new PanelButtonCustom(buttonRect, 2); | ||
| buttonContainer.setCallback(panelButtonCustom -> { | ||
| if (questOpenCallback != null) { | ||
| questOpenCallback.accept(entry); | ||
| } | ||
| }); | ||
| this.addPanel(buttonContainer); | ||
|
|
||
| GuiRectangle questButtonRect = new GuiRectangle(2, 2, 28, 28); | ||
| PanelButtonQuest questButton = new PanelButtonQuest(questButtonRect, 0, "", entry.getQuest()); | ||
|
Collaborator
There was a problem hiding this comment. need to update this regularly to have the correct color - test a quest that resets, have it be completed when the gui opens and then reset while the gui remains open. color will not change, but should.
Author
There was a problem hiding this comment. Yes, I avoided refreshing in real time, as it an be kinda expensive on big quest books. I guess I can updates every X seconds, with X configurable, but the user can just as much close and reopen. |
||
| questButton.setCallback(value -> { | ||
| if (questOpenCallback != null) { | ||
| questOpenCallback.accept(entry); | ||
| } | ||
| }); | ||
| buttonContainer.addPanel(questButton); | ||
|
|
||
| int repeatableLabelWidth = entry.isRepeatable() ? 96 : 0; | ||
| int questNameWidth = Math.max(0, cachedWidth - 36 - repeatableLabelWidth - (entry.isRepeatable() ? 8 : 0)); | ||
| GuiRectangle questNameRect = new GuiRectangle(36, 6, questNameWidth, 12); | ||
| String questNameStr = entry.getQuest().getValue().getProperty(NativeProps.NAME); | ||
| PanelTextBox questName = new PanelTextBox(questNameRect, QuestTranslation.translate(questNameStr)); | ||
| buttonContainer.addPanel(questName); | ||
|
|
||
| if (entry.isRepeatable()) { | ||
| GuiRectangle repeatableRect = new GuiRectangle(cachedWidth - repeatableLabelWidth - 4, 6, repeatableLabelWidth, 12); | ||
| PanelTextBox repeatableLabel = new PanelTextBox(repeatableRect, QuestTranslation.translate("betterquesting.gui.history.repeatable")); | ||
| repeatableLabel.setAlignment(2); | ||
| repeatableLabel.setColor(PresetColor.QUEST_LINE_COMPLETE.getColor()); | ||
| buttonContainer.addPanel(repeatableLabel); | ||
| } | ||
|
|
||
| GuiRectangle timestampRect = new GuiRectangle(36, 20, cachedWidth - 36, 10); | ||
| PanelTextBox timestamp = new PanelTextBox(timestampRect, getHistoryDetails(entry)); | ||
| timestamp.setColor(PresetColor.TEXT_AUX_0.getColor()); | ||
| buttonContainer.addPanel(timestamp); | ||
| return true; | ||
| } | ||
|
|
||
| private String getHistoryDetails(QuestHistoryEntry entry) { | ||
| String timestamp = formatTimestamp(entry.getCompletionTimestamp()); | ||
| if (!entry.isRepeatable()) { | ||
| return QuestTranslation.translate("betterquesting.gui.history.completed_at", timestamp); | ||
| } | ||
|
|
||
| if (entry.hasPendingRewards()) { | ||
| return QuestTranslation.translate("betterquesting.gui.history.pending_rewards_at", timestamp); | ||
| } | ||
|
|
||
| return QuestTranslation.translate("betterquesting.gui.history.last_completed_at", timestamp); | ||
| } | ||
|
|
||
| private String formatTimestamp(long timestamp) { | ||
| if (timestamp <= 0) { | ||
| return "-"; | ||
| } | ||
|
|
||
| return DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT) | ||
| .format(new Date(timestamp)); | ||
| } | ||
|
|
||
| public void setQuestOpenCallback(Consumer<QuestHistoryEntry> questOpenCallback) { | ||
| this.questOpenCallback = questOpenCallback; | ||
| } | ||
|
|
||
| public void setRepeatableFilter(RepeatableFilter repeatableFilter) { | ||
| if (this.repeatableFilter == repeatableFilter) { | ||
| return; | ||
| } | ||
|
|
||
| this.repeatableFilter = repeatableFilter; | ||
| refreshSearch(); | ||
| updatePanelScroll(); | ||
| } | ||
|
|
||
| public enum RepeatableFilter { | ||
| HIDE("betterquesting.gui.history.repeatable_filter.hide"), | ||
| SHOW_PENDING_REWARDS("betterquesting.gui.history.repeatable_filter.pending_rewards"), | ||
| SHOW_ALL("betterquesting.gui.history.repeatable_filter.all"); | ||
|
Comment on lines
+187
to
+190
Collaborator
There was a problem hiding this comment. what about expanding this to filter everything - mainly, i would like to filter by "pending rewards" for all quests.
Author
There was a problem hiding this comment. So 2 buttons or drop hiding repeatables altogether?
Collaborator
There was a problem hiding this comment. i think i would be fine with either, but would prefer two buttons |
||
|
|
||
| private static final RepeatableFilter[] VALUES = values(); | ||
|
|
||
| private final String translationKey; | ||
|
|
||
| RepeatableFilter(String translationKey) { | ||
| this.translationKey = translationKey; | ||
| } | ||
|
|
||
| public String getTranslationKey() { | ||
| return translationKey; | ||
| } | ||
|
|
||
| public static RepeatableFilter fromName(String name) { | ||
| for (RepeatableFilter value : VALUES) { | ||
| if (value.name().equalsIgnoreCase(name)) { | ||
| return value; | ||
| } | ||
| } | ||
|
|
||
| return SHOW_ALL; | ||
| } | ||
|
|
||
| public RepeatableFilter next() { | ||
| return VALUES[(ordinal() + 1) % VALUES.length]; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as much as it would be beneficial to do this, we currently dont, and so shouldnt store the name in a field.