blob: 1a93ef5c38b148b73f3818d2277c67189eb715e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
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
}
}
|
