Siege Lore Feature - Record of Siege data and outcome on the banner item

src/main/java/com/gmail/goosius/siegewar/SiegeController.java

@@ -20,13 +20,9 @@
 import com.gmail.goosius.siegewar.events.SiegeCampStartEvent;
 import com.gmail.goosius.siegewar.events.SiegeWarStartEvent;
 import com.gmail.goosius.siegewar.settings.SiegeWarSettings;
-import com.gmail.goosius.siegewar.utils.DataCleanupUtil;
+import com.gmail.goosius.siegewar.utils.*;
 import com.gmail.goosius.siegewar.timeractions.AttackerTimedWin;
 import com.gmail.goosius.siegewar.timeractions.DefenderTimedWin;
-import com.gmail.goosius.siegewar.utils.SiegeCampUtil;
-import com.gmail.goosius.siegewar.utils.SiegeWarDistanceUtil;
-import com.gmail.goosius.siegewar.utils.SiegeWarNationUtil;
-import com.gmail.goosius.siegewar.utils.SiegeWarSiegeCompletionUtil;
 import com.palmergames.bukkit.towny.TownyEconomyHandler;
 import com.palmergames.bukkit.towny.TownyMessaging;
 import com.palmergames.bukkit.towny.object.Government;
@@ -40,7 +36,6 @@
 import com.gmail.goosius.siegewar.metadata.SiegeMetaDataController;
 import com.gmail.goosius.siegewar.objects.Siege;
 import com.gmail.goosius.siegewar.objects.SiegeCamp;
-import com.gmail.goosius.siegewar.utils.SiegeWarMoneyUtil;
 import com.palmergames.bukkit.towny.TownyAPI;
 import com.palmergames.bukkit.towny.TownyUniverse;
 import com.palmergames.bukkit.towny.exceptions.TownyException;

src/main/java/com/gmail/goosius/siegewar/SiegeWar.java

@@ -1,6 +1,6 @@
 package com.gmail.goosius.siegewar;
 
-import com.gmail.goosius.siegewar.listeners.SiegeWarTownyChatEventListener;
+import com.gmail.goosius.siegewar.listeners.*;
 import com.gmail.goosius.siegewar.settings.SiegeWarSettings;
 import com.gmail.goosius.siegewar.utils.DataCleanupUtil;
 
@@ -25,15 +25,6 @@
 import com.gmail.goosius.siegewar.command.SiegeWarNationSetOccupationTaxAddonCommand;
 import com.gmail.goosius.siegewar.hud.SiegeHUDManager;
 import com.gmail.goosius.siegewar.integration.dynmap.DynmapIntegration;
-import com.gmail.goosius.siegewar.listeners.SiegeWarActionListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarBukkitEventListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarNationEventListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarPlotEventListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarSafeModeListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarSelfListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarStatusScreenListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarTownEventListener;
-import com.gmail.goosius.siegewar.listeners.SiegeWarTownyEventListener;
 
 import java.io.File;
 import java.nio.file.Files;
@@ -174,6 +165,7 @@ private boolean registerListeners() {
 			pm.registerEvents(new SiegeWarPlotEventListener(this), this);
 			pm.registerEvents(new SiegeWarStatusScreenListener(), this);
 			pm.registerEvents(new SiegeWarSelfListener(), this);
+			pm.registerEvents(new SiegeWarLoreListener(), this);
 			if (getServer().getPluginManager().isPluginEnabled("TownyChat")) {
 				info("SiegeWar found TownyChat plugin, enabling TownyChat integration.");
 				pm.registerEvents(new SiegeWarTownyChatEventListener(), this);

src/main/java/com/gmail/goosius/siegewar/listeners/SiegeWarLoreListener.java

@@ -0,0 +1,156 @@
+package com.gmail.goosius.siegewar.listeners;
+
+import com.gmail.goosius.siegewar.Messaging;
+import com.gmail.goosius.siegewar.events.PreSiegeCampEvent;
+import com.gmail.goosius.siegewar.events.SiegeEndEvent;
+import com.gmail.goosius.siegewar.events.SiegeWarStartEvent;
+import com.gmail.goosius.siegewar.settings.SiegeWarSettings;
+import com.gmail.goosius.siegewar.utils.SiegeWarLoreUtil;
+import com.palmergames.bukkit.towny.object.Translation;
+import org.bukkit.Material;
+import org.bukkit.Tag;
+import org.bukkit.block.Banner;
+import org.bukkit.entity.Item;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+import org.bukkit.event.block.Action;
+import org.bukkit.event.block.BlockDropItemEvent;
+import org.bukkit.event.block.BlockPlaceEvent;
+import org.bukkit.event.inventory.PrepareItemCraftEvent;
+import org.bukkit.event.player.PlayerInteractEvent;
+import org.bukkit.inventory.EquipmentSlot;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.BannerMeta;
+import org.bukkit.inventory.meta.ItemMeta;
+import org.bukkit.persistence.PersistentDataContainer;
+import org.bukkit.persistence.PersistentDataHolder;
+
+import java.util.Arrays;
+
+/**
+ *
+ * @author lexiccn
+ *
+ */
+public class SiegeWarLoreListener implements Listener {
+
+    @EventHandler(priority = EventPriority.LOWEST)
+    public void onSiegeStart(SiegeWarStartEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        //Set name, type, attacker, defender, start time
+        SiegeWarLoreUtil.bannerSiegeStart(event.getSiege());
+    }
+
+    @EventHandler(priority = EventPriority.LOWEST)
+    public void onSiegeEnd(SiegeEndEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        //Set outcome, winner, points, end time
+        SiegeWarLoreUtil.bannerSiegeEnd(event.getSiege());
+    }
+
+    @EventHandler
+    public void onInteractBanner(PlayerInteractEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        PersistentDataContainer container;
+        if (event.hasBlock()) {
+            if (event.getHand() != EquipmentSlot.HAND) return;
+            if (event.getAction() != Action.RIGHT_CLICK_BLOCK) return;
+            if (event.getClickedBlock().isEmpty()) return;
+            if (!Tag.BANNERS.isTagged(event.getClickedBlock().getType())) return;
+            if (!(event.getClickedBlock().getState() instanceof PersistentDataHolder)) return;
+            PersistentDataHolder holder = (PersistentDataHolder) event.getClickedBlock().getState();
+            container = holder.getPersistentDataContainer();
+        } else if (event.hasItem()) {
+            if (event.getHand() != EquipmentSlot.HAND) return;
+            if (event.getAction() != Action.RIGHT_CLICK_AIR) return;
+            if (!Tag.BANNERS.isTagged(event.getMaterial())) return;
+            ItemStack item = event.getItem();
+            if (!item.hasItemMeta()) return;
+            container = item.getItemMeta().getPersistentDataContainer();
+        } else return;
+
+        if (!SiegeWarLoreUtil.hasLoreKey(container)) return;
+
+        Messaging.sendMsg(event.getPlayer(), SiegeWarLoreUtil.bannerChat(container));
+    }
+
+    @EventHandler
+    public void onPrepareCraft(PrepareItemCraftEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        ItemStack resultItem = event.getInventory().getResult();
+        if (resultItem == null) return;
+        if (resultItem.getType() != Material.SHIELD) return;
+
+        ItemStack bannerItem = Arrays.stream(event.getInventory().getMatrix()).filter(itemStack -> {
+            if (itemStack == null) return false;
+            if (itemStack.getItemMeta() instanceof BannerMeta) {
+                return SiegeWarLoreUtil.hasLoreKey(itemStack.getItemMeta().getPersistentDataContainer());
+            }
+            return false;
+        }).findFirst().orElse(null);
+        if (bannerItem == null) return;
+
+        ItemMeta resultMeta = resultItem.getItemMeta();
+
+        SiegeWarLoreUtil.bannerCopyData(bannerItem.getItemMeta().getPersistentDataContainer(), resultMeta.getPersistentDataContainer());
+        SiegeWarLoreUtil.shieldItem(resultMeta, bannerItem.getItemMeta().getPersistentDataContainer());
+
+        resultItem.setItemMeta(resultMeta);
+    }
+
+    @EventHandler(ignoreCancelled = true)
+    public void onTryStartSiege(PreSiegeCampEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        if (!(event.getFlag().getState() instanceof Banner)) return;
+        Banner flag = (Banner)event.getFlag().getState();
+
+        if (!SiegeWarLoreUtil.hasLoreKey(flag.getPersistentDataContainer())) return;
+
+        event.setCancelled(true);
+        event.setCancellationMsg(Translation.of("siege_lore_error_banner_cannot_be_used"));
+    }
+
+    @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true)
+    public void onPlaceBlock(BlockPlaceEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        if (!(event.getItemInHand().getItemMeta() instanceof BannerMeta)) return;
+        if (!(event.getBlock().getState() instanceof Banner)) return;
+        Banner state = (Banner)event.getBlock().getState();
+        BannerMeta meta = (BannerMeta)event.getItemInHand().getItemMeta();
+
+        if (!SiegeWarLoreUtil.hasLoreKey(meta.getPersistentDataContainer())) return;
+
+        SiegeWarLoreUtil.bannerCopyData(meta.getPersistentDataContainer(), state.getPersistentDataContainer());
+
+        state.update();
+    }
+
+    @EventHandler(ignoreCancelled = true)
+    public void onDropBanner(BlockDropItemEvent event) {
+        if (!SiegeWarSettings.isSiegeLoreEnabled()) return;
+
+        if (event.getItems().isEmpty()) return;
+        Item item = event.getItems().get(0);
+        if (!(item.getItemStack().getItemMeta() instanceof BannerMeta)) return;
+        if (!(event.getBlockState() instanceof Banner)) return;
+        Banner state = (Banner)event.getBlockState();
+        BannerMeta meta = (BannerMeta)item.getItemStack().getItemMeta();
+
+        if (!SiegeWarLoreUtil.hasLoreKey(state.getPersistentDataContainer())) return;
+
+        ItemStack stack = item.getItemStack();
+
+        SiegeWarLoreUtil.bannerCopyData(state.getPersistentDataContainer(), meta.getPersistentDataContainer());
+        SiegeWarLoreUtil.bannerItem(meta, state.getPersistentDataContainer());
+
+        stack.setItemMeta(meta);
+        item.setItemStack(stack);
+    }
+}

src/main/java/com/gmail/goosius/siegewar/settings/ConfigNodes.java

@@ -1161,7 +1161,25 @@ public enum ConfigNodes {
 			"# If this value is true, then the Battle Commander feature is enabled.",
 			"# When a battle sessions starts, then for each siege, one player from each side may be designated as the Battle Commander.",
 			"# To qualify as a battle commander, a player must be an official participant with general or king rank, and be online and in the Siege-Zone.",
-			"# If one side has a battle commander, then any member can run /sw spawn <town> to spawn on the commander.");
+			"# If one side has a battle commander, then any member can run /sw spawn <town> to spawn on the commander."),
+	SIEGE_LORE(
+			"siege_lore",
+			"",
+			"",
+			"",
+			"############################################################",
+			"# +------------------------------------------------------+ #",
+			"# |                      SIEGE LORE                      | #",
+			"# +------------------------------------------------------+ #",
+			"############################################################",
+			""),
+	SIEGE_LORE_ENABLED(
+			"siege_lore.enabled",
+			"true",
+			"",
+			"# If this value is true, then the Siege Lore feature is enabled.",
+			"# When a banner is broken after a siege has ended, it will drop with a name and lore set to display info about the siege.",
+			"# Banners dropped from this feature can be placed and broken without losing lore, but can not be used to begin a new siege.");
 	private final String Root;
 	private final String Default;
 	private String[] comments;

src/main/java/com/gmail/goosius/siegewar/settings/SiegeWarSettings.java

@@ -620,6 +620,10 @@ public static boolean isBattleCommandersEnabled() {
 		return Settings.getBoolean(ConfigNodes.BATTLE_COMMANDERS_ENABLED);
 	}
 
+	public static boolean isSiegeLoreEnabled() {
+		return Settings.getBoolean(ConfigNodes.SIEGE_LORE_ENABLED);
+	}
+
 	public static String getDynmapLayerName() {
 		return Settings.getString(ConfigNodes.WAR_SIEGE_DYNMAP_LAYER_NAME);
 	}