From 5a62cda75920409537e692afca57c95cf6c32ce2 Mon Sep 17 00:00:00 2001
From: Pierre Maurice Schwang <mail@pschwang.eu>
Date: Sun, 14 Jan 2024 14:17:03 +0100
Subject: [PATCH] chore: add javadocs to CancellablePlotEvent#

---
 .../plotsquared/core/events/CancellablePlotEvent.java  | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Core/src/main/java/com/plotsquared/core/events/CancellablePlotEvent.java b/Core/src/main/java/com/plotsquared/core/events/CancellablePlotEvent.java
index cb4dbc8ff..ed777dd23 100644
--- a/Core/src/main/java/com/plotsquared/core/events/CancellablePlotEvent.java
+++ b/Core/src/main/java/com/plotsquared/core/events/CancellablePlotEvent.java
@@ -26,8 +26,18 @@ import org.checkerframework.checker.nullness.qual.Nullable;
  */
 public interface CancellablePlotEvent {
 
+    /**
+     * The currently set {@link Result} for this event (as set by potential previous event listeners).
+     *
+     * @return the current result.
+     */
     @Nullable Result getEventResult();
 
+    /**
+     * Set the {@link Result} for this event.
+     *
+     * @param eventResult the new result.
+     */
     void setEventResult(@Nullable Result eventResult);
 
     /**