Enhance Start and End Siege Events

This PR adds more methods to the events thrown at start and end of sieges. It also adds a SiegeSide variable to Sieges: SiegeWinner. Closes #400. Whitespacing fixes.
TownyAdvanced · Oct 31, 2021 · 025fde8 · 025fde8
1 parent f1b9689
commit 025fde8
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 5 deletions.
diff --git a/src/main/java/com/gmail/goosius/siegewar/SiegeController.java b/src/main/java/com/gmail/goosius/siegewar/SiegeController.java
@@ -485,8 +485,15 @@ public static void startSiege(Block bannerBlock,
 		//Save to DB
 		SiegeController.saveSiege(siege);
 
+		Nation nation =  siege.getSiegeType().equals(SiegeType.REVOLT) ? TownOccupationController.getTownOccupier(targetTown) : (Nation)siege.getAttackingNationIfPossibleElseTown();
 		//Call event
-		Bukkit.getPluginManager().callEvent(new SiegeWarStartEvent(siege, townOfSiegeStarter, bannerBlock));
+		Bukkit.getPluginManager().callEvent(new SiegeWarStartEvent(
+				siege,
+				siege.getSiegeType(),
+				siege.getTown(),
+				nation,
+				townOfSiegeStarter,
+				bannerBlock));
 	}
 
 	private static void sendGlobalSiegeStartMessage(Siege siege) {

diff --git a/src/main/java/com/gmail/goosius/siegewar/events/SiegeEndEvent.java b/src/main/java/com/gmail/goosius/siegewar/events/SiegeEndEvent.java
@@ -22,12 +22,24 @@ public class SiegeEndEvent extends Event {
 
     private static final HandlerList handlers = new HandlerList();
     private final Siege siege;
+    private final String siegeType;
+    private final String siegeWinner;
+    private final String attackerName;
+    private final String defenderName;
     private final String besiegedTownName;
 
     public SiegeEndEvent(Siege siege,
+                         String siegeType,
+                         String siegeWinner,
+                         String attackerName,
+                         String defenderName,
                          String besiegedTownName) {
         super(!Bukkit.getServer().isPrimaryThread());
         this.siege = siege;
+        this.siegeType = siegeType;
+        this.siegeWinner = siegeWinner;
+        this.attackerName = attackerName;
+        this.defenderName = defenderName;
         this.besiegedTownName = besiegedTownName;
     }
 
@@ -41,11 +53,45 @@ public static HandlerList getHandlerList() {
         return handlers;
     }
 
+    /**
+     * @return Siege object
+     */
     public Siege getSiege() {
         return siege;
     }
 
-    public String getBesiegedTownName() {
+    /**
+	 * @return the siegeType as a String
+	 */
+	public String getSiegeType() {
+		return siegeType;
+	}
+
+	/**
+	 * @return the siegeWinner as a String
+	 */
+	public String getSiegeWinner() {
+		return siegeWinner;
+	}
+
+	/**
+	 * @return the attackerName
+	 */
+	public String getAttackerName() {
+		return attackerName;
+	}
+
+	/**
+	 * @return besiegedTownName;
+	 */
+	public String getBesiegedTownName() {
         return besiegedTownName;
     }
+
+	/**
+	 * @return the defenderName
+	 */
+	public String getDefenderName() {
+		return defenderName;
+	}
 }
diff --git a/src/main/java/com/gmail/goosius/siegewar/events/SiegeWarStartEvent.java b/src/main/java/com/gmail/goosius/siegewar/events/SiegeWarStartEvent.java
@@ -1,6 +1,8 @@
 package com.gmail.goosius.siegewar.events;
 
+import com.gmail.goosius.siegewar.enums.SiegeType;
 import com.gmail.goosius.siegewar.objects.Siege;
+import com.palmergames.bukkit.towny.object.Nation;
 import com.palmergames.bukkit.towny.object.Town;
 import org.bukkit.block.Block;
 import org.bukkit.event.Event;
@@ -10,13 +12,25 @@
 public class SiegeWarStartEvent extends Event {
 
     private static final HandlerList handlers = new HandlerList();
+    private final SiegeType siegeType;
     private final Siege siege;
     private final Town townOfSiegeStarter;
+    private final Nation nation;
     private final Block flag;
+    private final Town targetTown;
 
-    public SiegeWarStartEvent(Siege siege, Town townOfSiegeStarter, Block flag) {
+    public SiegeWarStartEvent(
+            Siege siege,
+            SiegeType siegeType,
+            Town targetTown,
+            Nation nation,
+            Town townOfSiegeStarter,
+            Block flag) {
         this.siege = siege;
+        this.siegeType = siegeType;
+        this.targetTown = targetTown;
         this.townOfSiegeStarter = townOfSiegeStarter;
+        this.nation = nation;
         this.flag = flag;
     }
 
@@ -41,4 +55,16 @@ public Town getTownOfSiegeStarter() {
     public Block getFlag() {
         return flag;
     }
+
+	public SiegeType getSiegeType() {
+		return siegeType;
+	}
+
+	public Nation getNation() {
+		return nation;
+	}
+
+	public Town getTargetTown() {
+		return targetTown;
+	}
 }
diff --git a/src/main/java/com/gmail/goosius/siegewar/objects/Siege.java b/src/main/java/com/gmail/goosius/siegewar/objects/Siege.java
@@ -56,6 +56,7 @@ public class Siege {
 	private double warChestAmount;
 	private List<Resident> bannerControllingResidents;  //Soldiers currently controlling the banner
 	private SiegeSide bannerControllingSide;
+	private SiegeSide siegeWinner;    //For when a siege is over, holds the winning side.
 	private Map<Player, BannerControlSession> bannerControlSessions;
 	private int timedBattlePointsEarnedFromCurrentBannerControl;
 	private boolean attackerHasLowestPopulation;
@@ -488,6 +489,14 @@ public int getTotalBattleSessions() {
 		return result;
 	}
 
+	public SiegeSide getSiegeWinner() {
+		return siegeWinner;
+	}
+
+	public void setSiegeWinner(SiegeSide siegeWinner) {
+		this.siegeWinner = siegeWinner;
+	}
+
 	public String getAttackerName() {
 		return attackerName;
 	}

diff --git a/src/main/java/com/gmail/goosius/siegewar/timeractions/AttackerWin.java b/src/main/java/com/gmail/goosius/siegewar/timeractions/AttackerWin.java
@@ -1,6 +1,7 @@
 package com.gmail.goosius.siegewar.timeractions;
 
 import com.gmail.goosius.siegewar.TownOccupationController;
+import com.gmail.goosius.siegewar.enums.SiegeSide;
 import com.gmail.goosius.siegewar.enums.SiegeStatus;
 import com.gmail.goosius.siegewar.objects.Siege;
 import com.gmail.goosius.siegewar.utils.SiegeWarMoneyUtil;
@@ -21,6 +22,7 @@ public class AttackerWin {
 	 * @param siegeStatus the siege status
 	 */
 	public static void attackerWin(Siege siege, SiegeStatus siegeStatus) {
+		siege.setSiegeWinner(SiegeSide.ATTACKERS);
 		SiegeWarSiegeCompletionUtil.setCommonSiegeCompletionValues(siege, siegeStatus);
 		switch(siege.getSiegeType()) {
 			case CONQUEST:

diff --git a/src/main/java/com/gmail/goosius/siegewar/timeractions/DefenderWin.java b/src/main/java/com/gmail/goosius/siegewar/timeractions/DefenderWin.java
@@ -1,6 +1,7 @@
 package com.gmail.goosius.siegewar.timeractions;
 
 import com.gmail.goosius.siegewar.TownOccupationController;
+import com.gmail.goosius.siegewar.enums.SiegeSide;
 import com.gmail.goosius.siegewar.enums.SiegeStatus;
 import com.gmail.goosius.siegewar.objects.Siege;
 import com.gmail.goosius.siegewar.utils.SiegeWarMoneyUtil;
@@ -21,6 +22,7 @@ public class DefenderWin
 	 * @param siegeStatus the siege status
 	 */
     public static void defenderWin(Siege siege, SiegeStatus siegeStatus) {
+    	siege.setSiegeWinner(SiegeSide.DEFENDERS);
 		SiegeWarSiegeCompletionUtil.setCommonSiegeCompletionValues(siege, siegeStatus);
 		switch(siege.getSiegeType()) {
 			case CONQUEST:

diff --git a/src/main/java/com/gmail/goosius/siegewar/utils/SiegeWarSiegeCompletionUtil.java b/src/main/java/com/gmail/goosius/siegewar/utils/SiegeWarSiegeCompletionUtil.java
@@ -51,7 +51,12 @@ public static void setCommonSiegeCompletionValues(Siege siege,
 		SiegeController.saveSiege(siege);
 
 		//Fire SiegeEnded event
-		SiegeEndEvent siegeEndEvent = new SiegeEndEvent(siege, siege.getTown().getName());
-		Bukkit.getPluginManager().callEvent(siegeEndEvent);
+		Bukkit.getPluginManager().callEvent(new SiegeEndEvent(
+				siege,
+				siege.getSiegeType().getName(),
+				siege.getSiegeWinner().name(),
+				siege.getAttackerName(),
+				siege.getDefenderName(),
+				siege.getTown().getName()));
 	}
 }