diff options
Diffstat (limited to 'src/main/kotlin/me/bush/illnamethislater/Event.kt')
| -rw-r--r-- | src/main/kotlin/me/bush/illnamethislater/Event.kt | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/src/main/kotlin/me/bush/illnamethislater/Event.kt b/src/main/kotlin/me/bush/illnamethislater/Event.kt index 39360eb..dedd4df 100644 --- a/src/main/kotlin/me/bush/illnamethislater/Event.kt +++ b/src/main/kotlin/me/bush/illnamethislater/Event.kt @@ -1,19 +1,16 @@ package me.bush.illnamethislater /** - * A base class for events that can be cancelled. + * 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]. - * - * If [cancelled] is true, listeners with lower priority will not receive it unless: + * 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 future listener with [Listener.receiveCancelled] sets [cancelled] to `false` + * * A previous listener with [Listener.receiveCancelled] sets [cancelled] back to `false` * * @author bush * @since 1.0.0 */ -// TODO: 3/27/2022 ducks or a way to cancel anything (can't put a custom annotation on forge events) -// store cancellable info at subscribe time, do not calculate it in post abstract class Event { var cancelled = false set(value) { |