From 321c69c2218c64afa5b45a73171e29f3a9de84a4 Mon Sep 17 00:00:00 2001
From: Angeschossen <24841122+Angeschossen@users.noreply.github.com>
Date: Thu, 28 Nov 2024 20:32:16 +0100
Subject: [PATCH] 7.10.13

---
 .../api/war/captureflag/CaptureFlag.java      | 29 +++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/src/main/java/me/angeschossen/lands/api/war/captureflag/CaptureFlag.java b/src/main/java/me/angeschossen/lands/api/war/captureflag/CaptureFlag.java
index aad8d15..a1e3e7c 100644
--- a/src/main/java/me/angeschossen/lands/api/war/captureflag/CaptureFlag.java
+++ b/src/main/java/me/angeschossen/lands/api/war/captureflag/CaptureFlag.java
@@ -19,6 +19,12 @@ public interface CaptureFlag extends ExpressionEntity {
      */
     @NotNull BlockPosition getPosition();
 
+    /**
+     * Get the team that placed the flag.
+     *
+     * @return either {@link WarTeam#ATTACKER} or {@link WarTeam#DEFENDER}
+     */
+    @NotNull
     WarTeam getTeam();
 
     /**
@@ -35,12 +41,35 @@ public interface CaptureFlag extends ExpressionEntity {
      */
     void setSecondsToHold(long secondsToHold);
 
+    /**
+     * Break this flag.
+     *
+     * @param player   if a player broke that flag
+     * @param reward   should the team be rewarded
+     * @param captured was it captured?
+     * @param exlosion create any explosion?
+     * @param reason   reason of removal
+     * @return false, if a 3rd party plugin cancelled the removal
+     */
     CompletableFuture<Boolean> breakCaptureFlag(@Nullable LandPlayer player, boolean reward, boolean captured,
                                                 boolean exlosion, CaptureFlagBreakEvent.BreakReason reason);
 
+    /**
+     * Break this flag.
+     *
+     * @param player   if a player broke that flag
+     * @param reward   should the team be rewarded
+     * @param captured was it captured?
+     * @param reason   reason of removal
+     * @return false, if a 3rd party plugin cancelled the removal
+     */
     CompletableFuture<Boolean> breakCaptureFlag(@Nullable LandPlayer player, boolean reward, boolean captured, boolean end,
                                                 boolean explosion, CaptureFlagBreakEvent.BreakReason reason);
 
+    /**
+     * Trigger code execution whenever the flag is unloaded.
+     * This is only relevant, if you implement your own capture flag.
+     */
     void atUnload();
 
     /**