aboutsummaryrefslogtreecommitdiff
path: root/src/main/kotlin/me/bush/illnamethislater/Event.kt
blob: dedd4dfcc153e37ce60da668911e7cf36c595efa (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
package me.bush.illnamethislater

/**
 * A base class for events that can be cancelled. More information can be found
 * [here](https://github.com/therealbush/eventbus-kotlin)
 *
 * If [cancellable] is `true`, your event can be [cancelled], where future listeners will not receive it unless:
 * * They have [Listener.receiveCancelled] set to `true`.
 * * A previous listener with [Listener.receiveCancelled] sets [cancelled] back to `false`
 *
 * @author bush
 * @since 1.0.0
 */
abstract class Event {
    var cancelled = false
        set(value) {
            if (cancellable) field = value
        }

    abstract val cancellable: Boolean

    fun cancel() {
        cancelled = false
    }
}