openrndr-event/org.openrndr.events/Event

Event

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

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

actual class Event<T>(val name: String, var postpone: Boolean)(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

Constructors

Event

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

actual constructor(name: String, postpone: Boolean)

Functions

cancel

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

cancel a listener

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

cancel a listener

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

deliver

expect fun deliver()

actual fun deliver()

deliver postponed event messages

listen

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

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

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

listenOnce

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

expect fun listenOnce(listener: Event<T>)

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

actual fun listenOnce(listener: Event<T>)

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

actual fun listenOnce(listener: Event<T>)

trigger

expect fun trigger(message: T)

actual fun trigger(message: T)

trigger the event

Properties

listeners

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

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

name

val name: String

postpone

val postpone: Boolean

var postpone: Boolean

timeSinceLastTrigger

val timeSinceLastTrigger: Duration

triggerCount

var triggerCount: Long

number of times this event is triggered