BotCommands-core/io.github.freya022.botcommands.api.core.waiter

Package-level declarations

Types

fun interface CompletedFutureEvent<T : Event>

Functional interface for EventWaiterBuilder.setOnComplete, provides a Future and either the event or an exception.

@InterfacedService(acceptMultiple = false)

Lets you run code when receiving a specific event, while not blocking threads nor having listeners everywhere, and being able to capture existing variables.

EventWaiterBuilder

interface EventWaiterBuilder<T : Event>

Builder for EventWaiter

Functions

await

suspend fun <T : Event> EventWaiterBuilder<T>.await(): T

Suspends until the event waiter receives an event of the specified type, and all preconditions have passed.

inline suspend fun <T : Event> EventWaiter.await(noinline filter: (T) -> Boolean = { true }): T

Suspends until an event of type T satisfying the filter is received on any shard, then returns it.

awaitMessage

inline suspend fun EventWaiter.awaitMessage(channel: MessageChannel, author: UserSnowflake? = null, crossinline filter: (Message) -> Boolean = { true }): Message

Suspends until a Message from the author satisfying the filter is received on any shard, then returns it.

inline fun <T : Event> EventWaiter.of(): EventWaiterBuilder<T>

Same as EventWaiter.of but with a reified type parameter.