aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt')
-rw-r--r--src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt38
1 files changed, 0 insertions, 38 deletions
diff --git a/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt b/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt
deleted file mode 100644
index 1a93ef5..0000000
--- a/src/main/kotlin/moe/nea/firmament/events/FirmamentEvent.kt
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-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 : FirmamentEvent() {
- * companion object : FirmamentEventBus<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
- }
-}