Merge pull request #776 from FTBTeam/dev

Dev

Author: desht

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2101.1.7]
+
+### Added
+* Added exclusive quest branching, where starting one quest makes certain other quests unavailable
+  * New "Max Completable Dependents" integer property for quests
+  * When that number of dependent quests is completed, other uncompleted dependents of that quest become unavailable to the player/team
+* Improved importing of legacy quest data (from quest book data in 1.20.1 and earlier)
+  * Item SNBT data is now imported, other than custom NBT data, which can't reliably be auto-converted to 1.21 item component data
+* Added ja_jp translation (thanks @twister716)
+* Added de_de translation (thanks @FlyonDE)
+* Task Screens now show related quest names along with task names (and can search on those)
+* New hotkeys when hovering chapters (same as 2101.1.6 changes made to quests):
+  * Left-Alt & Left-Mouse opens directly to chapter properties
+  * Right-Alt & Left-Mouse copies the chapter ID
+
+### Fixed
+* Add extra defensive null-checking to avoid crashes by mods incorrectly calling `Entity#die` with a null damage source
+
 ## [2101.1.6]
 
 ### Added

common/src/main/java/dev/ftb/mods/ftbquests/FTBQuestsEventHandler.java

@@ -114,6 +114,11 @@ private void playerChangedTeam(PlayerChangedTeamEvent event) {
 	}
 
 	private EventResult playerKill(LivingEntity entity, DamageSource source) {
+		// `source` should never be null, this is a defensive check against badly behaved mods.
+		if (source == null) {
+			return EventResult.pass();
+		}
+
 		if (source.getEntity() instanceof ServerPlayer player && !PlayerHooks.isFake(player)) {
 			if (killTasks == null) {
 				killTasks = ServerQuestFile.INSTANCE.collect(KillTask.class);

common/src/main/java/dev/ftb/mods/ftbquests/block/entity/TaskScreenBlockEntity.java

@@ -18,6 +18,7 @@
 import dev.ftb.mods.ftbquests.registry.ModBlocks;
 import dev.ftb.mods.ftbquests.registry.ModDataComponents;
 import dev.ftb.mods.ftbquests.util.ConfigQuestObject;
+import net.minecraft.ChatFormatting;
 import net.minecraft.Util;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
@@ -26,6 +27,7 @@
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.nbt.NbtOps;
 import net.minecraft.network.RegistryFriendlyByteBuf;
+import net.minecraft.network.chat.Component;
 import net.minecraft.network.codec.ByteBufCodecs;
 import net.minecraft.network.codec.StreamCodec;
 import net.minecraft.network.protocol.Packet;
@@ -223,7 +225,7 @@ public ConfigGroup fillConfigGroup(TeamData data) {
 
         cg0.setNameKey(getBlockState().getBlock().getDescriptionId());
         ConfigGroup cg = cg0.getOrCreateSubgroup("screen");
-        cg.add("task", new ConfigQuestObject<>(o -> isSuitableTask(data, o)), getTask(), this::setTask, null).setNameKey("ftbquests.task");
+        cg.add("task", new ConfigQuestObject<>(o -> isSuitableTask(data, o), this::formatLine), getTask(), this::setTask, null).setNameKey("ftbquests.task");
         cg.add("skin", new ItemStackConfig(true, true), getSkin(), this::setSkin, ItemStack.EMPTY).setNameKey("block.ftbquests.screen.skin");
         cg.add("text_shadow", new BooleanConfig(), isTextShadow(), this::setTextShadow, false).setNameKey("block.ftbquests.screen.text_shadow");
         cg.add("indestructible", new BooleanConfig(), isIndestructible(), this::setIndestructible, false).setNameKey("block.ftbquests.screen.indestructible");
@@ -233,6 +235,13 @@ public ConfigGroup fillConfigGroup(TeamData data) {
         return cg0;
     }
 
+    private Component formatLine(Task task) {
+        if (this.task == null) return Component.empty();
+
+        Component questTxt = Component.literal(" [").append(task.getQuest().getTitle()).append("]").withStyle(ChatFormatting.GREEN);
+        return ConfigQuestObject.formatEntry(task).copy().append(questTxt);
+    }
+
     private boolean isSuitableTask(TeamData data, QuestObjectBase o) {
         return o instanceof Task t && (data.getCanEdit(FTBQuestsClient.getClientPlayer()) || data.canStartTasks(t.getQuest())) && t.consumesResources();
     }

common/src/main/java/dev/ftb/mods/ftbquests/client/FTBQuestsClientConfig.java

@@ -18,6 +18,7 @@ public interface FTBQuestsClientConfig {
     IntValue PINNED_QUESTS_INSET_Y = UI.addInt("pinned_quests_inset_y", 2);
     BooleanValue SHOW_LOCK_ICON = UI.addBoolean("show_lock_icon", true);
     BooleanValue BACKSPACE_HISTORY = UI.addBoolean("backspace_history", true);
+    BooleanValue CHAPTER_PANEL_PINNED = UI.addBoolean("chapter_panel_pinned", false);
 
     SNBTConfig XLATE = CONFIG.addGroup("xlate", 1);
     StringValue EDITING_LOCALE = XLATE.add(new LocaleValue(XLATE,"editing_locale", ""));
@@ -29,4 +30,11 @@ static void openSettings(boolean pauseGame) {
         ConfigManager.getInstance().createConfigGroup(KEY)
                 .ifPresent(group -> new QuestsClientConfigScreen(group, pauseGame).openGui());
     }
+
+    static void setChapterPanelPinned(boolean pinned) {
+        if (pinned != CHAPTER_PANEL_PINNED.get()) {
+            CHAPTER_PANEL_PINNED.set(pinned);
+            ConfigManager.getInstance().save(KEY);
+        }
+    }
 }

common/src/main/java/dev/ftb/mods/ftbquests/client/FTBQuestsNetClient.java

@@ -259,11 +259,6 @@ private static void refreshQuestScreenIfOpen() {
 		}
 	}
 
-	public static void toggleChapterPinned(boolean pinned) {
-		ClientQuestFile.INSTANCE.selfTeamData.setChapterPinned(FTBQuestsClient.getClientPlayer(), pinned);
-		ClientQuestFile.INSTANCE.getQuestScreen().ifPresent(QuestScreen::refreshChapterPanel);
-	}
-
 	public static void syncRewardBlocking(UUID teamId, boolean rewardsBlocked) {
 		if (ClientQuestFile.INSTANCE.getOrCreateTeamData(teamId).setRewardsBlocked(rewardsBlocked)) {
 			ClientQuestFile.INSTANCE.refreshGui();

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/SelectQuestObjectScreen.java

@@ -2,10 +2,7 @@
 
 import dev.ftb.mods.ftblibrary.config.ConfigCallback;
 import dev.ftb.mods.ftblibrary.icon.Color4I;
-import dev.ftb.mods.ftblibrary.ui.GuiHelper;
-import dev.ftb.mods.ftblibrary.ui.Panel;
-import dev.ftb.mods.ftblibrary.ui.SimpleTextButton;
-import dev.ftb.mods.ftblibrary.ui.Theme;
+import dev.ftb.mods.ftblibrary.ui.*;
 import dev.ftb.mods.ftblibrary.ui.input.Key;
 import dev.ftb.mods.ftblibrary.ui.input.MouseButton;
 import dev.ftb.mods.ftblibrary.ui.misc.AbstractButtonListScreen;
@@ -23,10 +20,13 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
+import java.util.function.Function;
 
 public class SelectQuestObjectScreen<T extends QuestObjectBase> extends AbstractButtonListScreen {
 	private final ConfigQuestObject<T> config;
 	private final ConfigCallback callback;
+	private Function<T,Component> formatter = ConfigQuestObject::formatEntry;
 
 	public SelectQuestObjectScreen(ConfigQuestObject<T> config, ConfigCallback callback) {
 		setTitle(Component.translatable("ftbquests.gui.select_quest_object"));
@@ -40,6 +40,11 @@ public SelectQuestObjectScreen(ConfigQuestObject<T> config, ConfigCallback callb
 		this.callback = callback;
 	}
 
+	public SelectQuestObjectScreen<T> withFormatter(@Nullable Function<T,Component> formatter) {
+		this.formatter = Objects.requireNonNullElse(formatter, ConfigQuestObject::formatEntry);
+		return this;
+	}
+
 	@Override
 	public boolean onClosedByKey(Key key) {
 		if (super.onClosedByKey(key)) {
@@ -82,6 +87,15 @@ public void addButtons(Panel panel) {
 		for (T objectBase : list) {
 			panel.add(new QuestObjectButton(panel, objectBase));
 		}
+
+		int width = panel.getWidgets().stream().map(Widget::getWidth).max(Integer::compare).orElse(200);
+		panel.getWidgets().forEach(w -> w.setWidth(width));
+	}
+
+	@Override
+	public boolean onInit() {
+		setWidth(mainPanel.getWidgets().isEmpty() ? 200 : mainPanel.getWidgets().getFirst().width + 20);
+		return super.onInit();
 	}
 
 	@Override
@@ -97,14 +111,20 @@ protected void doAccept() {
 	private class QuestObjectButton extends SimpleTextButton {
 		public final T object;
 
-		public QuestObjectButton(Panel panel, @Nullable T o) {
-			super(panel, o == null ? Component.translatable("ftbquests.null") : o.getMutableTitle().withStyle(o.getObjectType().getColor()), o == null ? Color4I.empty() : o.getIcon());
-			object = o;
-			setSize(200, 14);
+		public QuestObjectButton(Panel panel, @Nullable T questObject) {
+			super(panel,
+					questObject == null ? Component.translatable("ftbquests.null") : formatter.apply(questObject),
+					questObject == null ? Color4I.empty() : questObject.getIcon()
+			);
+			object = questObject;
+			setHeight(getTheme().getFontHeight() + 4);
 		}
 
 		private void addObject(TooltipList list, QuestObjectBase o) {
-			list.add(QuestObjectType.NAME_MAP.getDisplayName(o.getObjectType()).copy().withStyle(ChatFormatting.GRAY).append(": ").append(o.getMutableTitle().withStyle(o.getObjectType().getColor())));
+			list.add(QuestObjectType.NAME_MAP.getDisplayName(o.getObjectType()).copy().withStyle(ChatFormatting.GRAY)
+					.append(": ")
+					.append(o.getMutableTitle().withStyle(o.getObjectType().getColor()))
+			);
 		}
 
 		@Override
@@ -114,30 +134,36 @@ public void addMouseOverText(TooltipList list) {
 			}
 
 			list.add(object.getTitle());
-			list.add(Component.literal("ID: ").withStyle(ChatFormatting.GRAY).append(Component.literal(object.toString()).withStyle(ChatFormatting.DARK_GRAY)));
-			list.add(Component.literal("Type: ").withStyle(ChatFormatting.GRAY).append(QuestObjectType.NAME_MAP.getDisplayName(object.getObjectType()).copy().withStyle(object.getObjectType().getColor())));
-
-			if (object instanceof Quest quest) {
-				addObject(list, quest.getChapter());
-				addRewardTooltip(list, quest);
-			} else if (object instanceof QuestLink link) {
-				link.getQuest().ifPresent(quest -> {
-					addObject(list, link.getChapter());
-					list.add(Component.translatable("ftbquests.gui.linked_quest_id", Component.literal(quest.getCodeString()).withStyle(ChatFormatting.DARK_GRAY)).withStyle(ChatFormatting.GRAY));
-					addObject(list, quest.getChapter());
-				});
-			} else if (object instanceof Task task) {
-				Quest quest = task.getQuest();
-				addObject(list, quest.getChapter());
-				addObject(list, quest);
-				addRewardTooltip(list, quest);
-			} else if (object instanceof Reward reward) {
-				Quest quest = reward.getQuest();
-				addObject(list, quest.getChapter());
-				addObject(list, quest);
-			} else if (object instanceof RewardTable rewardTable) {
-				rewardTable.addMouseOverText(list, true, true);
-			}
+			list.add(Component.literal("ID: ").withStyle(ChatFormatting.GRAY)
+					.append(Component.literal(object.toString()).withStyle(ChatFormatting.DARK_GRAY)));
+			list.add(Component.literal("Type: ").withStyle(ChatFormatting.GRAY)
+					.append(QuestObjectType.NAME_MAP.getDisplayName(object.getObjectType()).copy().withStyle(object.getObjectType().getColor())));
+
+            switch (object) {
+                case Quest quest -> {
+                    addObject(list, quest.getChapter());
+                    addRewardTooltip(list, quest);
+                }
+                case QuestLink link -> link.getQuest().ifPresent(quest -> {
+                    addObject(list, link.getChapter());
+                    list.add(Component.translatable("ftbquests.gui.linked_quest_id", Component.literal(quest.getCodeString()).withStyle(ChatFormatting.DARK_GRAY)).withStyle(ChatFormatting.GRAY));
+                    addObject(list, quest.getChapter());
+                });
+                case Task task -> {
+                    Quest quest = task.getQuest();
+                    addObject(list, quest.getChapter());
+                    addObject(list, quest);
+                    addRewardTooltip(list, quest);
+                }
+                case Reward reward -> {
+                    Quest quest = reward.getQuest();
+                    addObject(list, quest.getChapter());
+                    addObject(list, quest);
+                }
+                case RewardTable rewardTable -> rewardTable.addMouseOverText(list, true, true);
+                default -> {
+                }
+            }
 		}
 
 		private void addRewardTooltip(TooltipList list, Quest quest) {

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/quests/ChapterPanel.java

@@ -1,5 +1,6 @@
 package dev.ftb.mods.ftbquests.client.gui.quests;
 
+import com.mojang.blaze3d.platform.InputConstants;
 import com.mojang.blaze3d.systems.RenderSystem;
 import dev.architectury.networking.NetworkManager;
 import dev.ftb.mods.ftblibrary.config.StringConfig;
@@ -12,13 +13,14 @@
 import dev.ftb.mods.ftblibrary.util.TooltipList;
 import dev.ftb.mods.ftblibrary.util.client.PositionedIngredient;
 import dev.ftb.mods.ftbquests.client.ClientQuestFile;
+import dev.ftb.mods.ftbquests.client.FTBQuestsClient;
 import dev.ftb.mods.ftbquests.client.FTBQuestsClientConfig;
 import dev.ftb.mods.ftbquests.client.gui.ChangeChapterGroupScreen;
 import dev.ftb.mods.ftbquests.client.gui.ContextMenuBuilder;
+import dev.ftb.mods.ftbquests.client.gui.CustomToast;
 import dev.ftb.mods.ftbquests.net.CreateObjectMessage;
 import dev.ftb.mods.ftbquests.net.MoveChapterGroupMessage;
 import dev.ftb.mods.ftbquests.net.MoveChapterMessage;
-import dev.ftb.mods.ftbquests.net.ToggleChapterPinnedMessage;
 import dev.ftb.mods.ftbquests.quest.Chapter;
 import dev.ftb.mods.ftbquests.quest.ChapterGroup;
 import dev.ftb.mods.ftbquests.quest.theme.property.ThemeProperties;
@@ -160,7 +162,7 @@ public void setExpanded(boolean b) {
 	}
 
 	boolean isPinned() {
-		return ClientQuestFile.INSTANCE.selfTeamData.isChapterPinned(Minecraft.getInstance().player);
+		return FTBQuestsClientConfig.CHAPTER_PANEL_PINNED.get();
 	}
 
 	public static abstract class ListButton extends Button {
@@ -195,7 +197,7 @@ public ModpackButton(ChapterPanel panel, ClientQuestFile f) {
 		public void onClicked(MouseButton button) {
 			if (getMouseX() > getX() + width - 18) {
 				playClickSound();
-				NetworkManager.sendToServer(ToggleChapterPinnedMessage.INSTANCE);
+				FTBQuestsClientConfig.setChapterPanelPinned(!FTBQuestsClientConfig.CHAPTER_PANEL_PINNED.get());
 			} else {
 				ClientQuestFile file = chapterPanel.questScreen.file;
 				if (file.canEdit() && getMouseX() > getX() + width - 34) {
@@ -277,9 +279,7 @@ public int getActualWidth(QuestScreen screen) {
 		public void addMouseOverText(TooltipList list) {
 			chapterPanel.questScreen.addInfoTooltip(list, chapterPanel.questScreen.file);
 
-			if (getMouseX() > getX() + width - 18) {
-				list.translate(chapterPanel.isPinned() ? "ftbquests.gui.stays_open" : "ftbquests.gui.does_not_stay_open");
-			} else if (chapterPanel.questScreen.file.canEdit() && getMouseX() > getX() + width - 34) {
+			if (chapterPanel.questScreen.file.canEdit() && getMouseX() > getX() + width - 34) {
 				list.translate("gui.add");
 			}
 		}
@@ -406,10 +406,21 @@ public void onClicked(MouseButton button) {
 			if (chapterPanel.questScreen.file.canEdit() || chapter.hasAnyVisibleChildren()) {
 				playClickSound();
 
-				if (chapterPanel.questScreen.selectedChapter != chapter) {
-					chapterPanel.questScreen.open(chapter, false);
-					chapter.getAutofocus().ifPresent(chapterPanel.questScreen::scrollTo);
-				}
+                if (chapterPanel.questScreen.file.canEdit() && button.isLeft()) {
+                    if (isKeyDown(InputConstants.KEY_LALT)) {
+						chapter.onEditButtonClicked(chapterPanel.questScreen);
+					} else if (isKeyDown(InputConstants.KEY_RALT)) {
+						FTBQuestsClient.copyToClipboard(chapter);
+						Minecraft.getInstance().getToasts().addToast(new CustomToast(Component.translatable("ftbquests.quest.copied"),
+								Icons.INFO, Component.literal(chapter.getTitle().getString())));
+                    } else if (chapterPanel.questScreen.selectedChapter != chapter) {
+                        chapterPanel.questScreen.open(chapter, false);
+                        chapter.getAutofocus().ifPresent(chapterPanel.questScreen::scrollTo);
+                    }
+                } else if (chapterPanel.questScreen.selectedChapter != chapter) {
+                    chapterPanel.questScreen.open(chapter, false);
+                    chapter.getAutofocus().ifPresent(chapterPanel.questScreen::scrollTo);
+                }
 			}
 
 			if (chapterPanel.questScreen.file.canEdit() && button.isRight()) {

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/quests/QuestButton.java

@@ -328,6 +328,10 @@ public void addMouseOverText(TooltipList list) {
 		if (!questScreen.file.selfTeamData.canStartTasks(quest)) {
 			list.add(Component.literal("[").withStyle(ChatFormatting.DARK_GRAY).append(Component.translatable("ftbquests.quest.locked")).append("]"));
 		}
+		if (quest.isExclusiveQuest()) {
+			list.add(Component.translatable("ftbquests.quest.misc.exclusive").withStyle(ChatFormatting.GOLD));
+			list.add(Component.translatable("ftbquests.quest.misc.exclusive.desc").withColor(0xFFC08000));
+		}
 	}
 
 	@Override

common/src/main/java/dev/ftb/mods/ftbquests/net/FTBQuestsNetHandler.java

@@ -28,7 +28,6 @@ public static void init() {
 		NetworkHelper.registerC2S(SyncStructuresRequestMessage.TYPE, SyncStructuresRequestMessage.STREAM_CODEC, SyncStructuresRequestMessage::handle);
 		NetworkHelper.registerC2S(SyncTranslationMessageToServer.TYPE, SyncTranslationMessageToServer.STREAM_CODEC, SyncTranslationMessageToServer::handle);
 		NetworkHelper.registerC2S(TaskScreenConfigResponseMessage.TYPE, TaskScreenConfigResponseMessage.STREAM_CODEC, TaskScreenConfigResponseMessage::handle);
-		NetworkHelper.registerC2S(ToggleChapterPinnedMessage.TYPE, ToggleChapterPinnedMessage.STREAM_CODEC, ToggleChapterPinnedMessage::handle);
 		NetworkHelper.registerC2S(ToggleEditingModeMessage.TYPE, ToggleEditingModeMessage.STREAM_CODEC, ToggleEditingModeMessage::handle);
 		NetworkHelper.registerC2S(TogglePinnedMessage.TYPE, TogglePinnedMessage.STREAM_CODEC, TogglePinnedMessage::handle);
 
@@ -62,7 +61,6 @@ public static void init() {
 		NetworkHelper.registerS2C(SyncTranslationTableMessage.TYPE, SyncTranslationTableMessage.STREAM_CODEC, SyncTranslationTableMessage::handle);
 		NetworkHelper.registerS2C(TaskScreenConfigRequestMessage.TYPE, TaskScreenConfigRequestMessage.STREAM_CODEC, TaskScreenConfigRequestMessage::handle);
 		NetworkHelper.registerS2C(TeamDataChangedMessage.TYPE, TeamDataChangedMessage.STREAM_CODEC, TeamDataChangedMessage::handle);
-		NetworkHelper.registerS2C(ToggleChapterPinnedResponseMessage.TYPE, ToggleChapterPinnedResponseMessage.STREAM_CODEC, ToggleChapterPinnedResponseMessage::handle);
 		NetworkHelper.registerS2C(TogglePinnedResponseMessage.TYPE, TogglePinnedResponseMessage.STREAM_CODEC, TogglePinnedResponseMessage::handle);
 		NetworkHelper.registerS2C(UpdateTaskProgressMessage.TYPE, UpdateTaskProgressMessage.STREAM_CODEC, UpdateTaskProgressMessage::handle);
 		NetworkHelper.registerS2C(UpdateTeamDataMessage.TYPE, UpdateTeamDataMessage.STREAM_CODEC, UpdateTeamDataMessage::handle);