Rename event bus

1 files changed, 36 insertions, 0 deletions

diff --git a/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt b/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt
new file mode 100644
index 0000000..6ac2a4b
--- /dev/null
+++ b/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt
@@ -0,0 +1,36 @@
+package moe.nea.firmament.events
+
+/**
+ * An event that can be fired by a [FirmamentEventBus].
+ *
+ * Typically, that event bus is implemented as a companion object
+ *
+ * ```
+ * class SomeEvent : NEUEvent() {
+ *     companion object : NEUEventBus<SomeEvent>()
+ * }
+ * ```
+ */
+abstract class FirmamentEvent {
+    /**
+     * A [FirmamentEvent] that can be [cancelled]
+     */
+    abstract class Cancellable : FirmamentEvent() {
+        /**
+         * Cancels this is event.
+         *
+         * @see cancelled
+         */
+        fun cancel() {
+            cancelled = true
+        }
+
+        /**
+         * Whether this event is cancelled.
+         *
+         * Cancelled events will bypass handlers unless otherwise specified and will prevent the action that this
+         * event was originally fired for.
+         */
+        var cancelled: Boolean = false
+    }
+}