openrndr-event/org.openrndr.events/Event

Event

actual class Event<T>(val name: String, var postpone: Boolean) : AutoCloseable(source)

an event class

Parameters

name

a name for the event, this is used for logging and debugging purposes only, default is ""

postpone

should message delivery for this event be postponed, default is false

expect class Event<T>(name: String = "<unnamed-event>", postpone: Boolean = false) : AutoCloseable(source)

actual class Event<T>(val name: String, val postpone: Boolean) : AutoCloseable(source)

Constructors

Event

actual constructor(name: String, postpone: Boolean)

expect constructor(name: String = "<unnamed-event>", postpone: Boolean = false)

actual constructor(name: String, postpone: Boolean)

Properties

hasListeners

actual val hasListeners: Boolean

does the event have listeners or oneShotListeners?

expect val hasListeners: Boolean

does the event have listeners or oneShotListeners?

actual val hasListeners: Boolean

does the event have listeners or oneShotListeners?

listeners

actual val listeners: MutableList<(T) -> Unit>

expect val listeners: MutableList<(T) -> Unit>

actual val listeners: MutableList<(T) -> Unit>

name

val name: String

oneShotListeners

actual val oneShotListeners: MutableList<(T) -> Unit>

the listeners that are removed after they received a message, added with listenOnce

expect val oneShotListeners: MutableList<(T) -> Unit>

the listeners that are removed after they received a message, added with listenOnce

actual val oneShotListeners: MutableList<(T) -> Unit>

the listeners that are removed after they received a message, added with listenOnce

postpone

var postpone: Boolean

val postpone: Boolean

timeSinceLastTrigger

val timeSinceLastTrigger: Duration

triggerCount

var triggerCount: Long

number of times this event is triggered

Functions

cancel

actual fun cancel(listener: (T) -> Unit)

cancel a listener

expect fun cancel(listener: (T) -> Unit)

cancel a listener

actual fun cancel(listener: (T) -> Unit)

cancel a listener

actual open override fun close()

expect open override fun close()

actual open override fun close()

deliver

actual fun deliver()

deliver postponed event messages

expect fun deliver()

actual fun deliver()

listen

actual fun listen(listener: (T) -> Unit): (T) -> Unit

add an event message listener

actual fun listen(listener: Event<T>): (T) -> Unit

expect fun listen(listener: (T) -> Unit): (T) -> Unit

add an event message listener

expect fun listen(listener: Event<T>): (T) -> Unit

actual fun listen(listener: (T) -> Unit): (T) -> Unit

add an event message listener

actual fun listen(listener: Event<T>): (T) -> Unit

listenOnce

actual fun listenOnce(listener: (T) -> Unit): (T) -> Unit

actual fun listenOnce(listener: Event<T>): (T) -> Unit

expect fun listenOnce(listener: (T) -> Unit): (T) -> Unit

expect fun listenOnce(listener: Event<T>): (T) -> Unit

actual fun listenOnce(listener: (T) -> Unit): (T) -> Unit

actual fun listenOnce(listener: Event<T>): (T) -> Unit

trigger

actual fun trigger(message: T)

trigger the event

expect fun trigger(message: T)

actual fun trigger(message: T)