LiquidBounce/net.ccbluex.liquidbounce.features.addon/LiquidBounceAddon

LiquidBounceAddon

abstract class LiquidBounceAddon : EventListener, MinecraftShortcuts

Declared under the liquidbounce entrypoint in fabric.mod.json:

"entrypoints": { "liquidbounce": ["com.example.addon.ExampleAddon"] }

Constructors

LiquidBounceAddon

constructor()

Properties

authors

val authors: List<String>

Functions

after

open fun after(ticks: Int, task: Runnable): AutoCloseable

Runs task once, ticks game ticks from now, unless this listener stops running first.

children

open fun children(): List<EventListener>

Children EventListener

computedOn

inline fun <E : Event, V> EventListener.computedOn(initialValue: V, priority: Short = 0, crossinline accumulator: (event: E, prev: V) -> V): ReadWriteProperty<EventListener, V>

Returns computed ReadWriteProperty based on the accumulator of specific event.

config

@JvmOverloads

fun config(name: String = id, tree: MutableCollection<out ValueGroup> = mutableListOf()): Config

createEventHook

open override fun <T : Event> EventListener.createEventHook(eventClass: Class<T>, wrappedContext: CoroutineContext, priority: Short, handler: SuspendableEventHandler<T>): EventHook<T>

debugGeometry

inline fun DebuggedOwner.debugGeometry(name: String, lazyGeometry: () -> ModuleDebug.DebuggedGeometry?)

debugParameter

inline fun DebuggedOwner.debugParameter(name: String, lazyValue: () -> Any?)

EntityLookup

@JvmStatic

@JvmName(name = "create")

fun <T : Entity> EventListener.EntityLookup(collector: EntityLookup.Collector<T>): EntityLookup<T>

every

open fun every(ticks: Int, task: Runnable): AutoCloseable

Runs task every ticks game ticks while this listener is running, the first time after ticks.

ExpiringList

@JvmStatic

@JvmName(name = "create")

fun <E> EventListener.ExpiringList(): ExpiringList<E>

handler

inline fun <T : Event> EventListener.handler(priority: Short = 0, handler: Consumer<T>): EventHook<T>

fun <T : Event> EventListener.handler(eventClass: Class<T>, priority: Short = 0, handler: Consumer<T>): EventHook<T>

newEventHook

inline fun <E : Event> EventListener.newEventHook(priority: Short = 0, handler: Consumer<E>): EventHook<E>

open fun <E : Event> on(type: Class<E>, handler: Consumer<E>): AutoCloseable

open fun <E : Event> on(type: Class<E>, priority: Short, handler: Consumer<E>): AutoCloseable

Calls handler for every type event while this listener is running. Higher priority runs first. Close the result to stop early; unregister does the same for all of them.

once

inline fun <T : Event> EventListener.once(priority: Short = 0, crossinline handler: (T) -> Unit): EventHook<T>

onInitialize

abstract fun onInitialize()

Runs before configs are loaded, so only what is registered here gets its settings restored.

onStarted

open fun onStarted()

Runs once configs are loaded.

onStopping

open fun onStopping()

Runs before configs are written back to disk.

onTick

open fun onTick(task: Runnable): AutoCloseable

task every game tick while this listener is running.

parent

open fun parent(): EventListener?

Parent EventListener

registerBrowserBackend

fun registerBrowserBackend(provider: BrowserBackendProvider)

Offers a browser backend the player can choose when the client starts.

registerCategory

fun registerCategory(category: ModuleCategory): ModuleCategory

For categories that are only known once the add-on runs. Declare the rest in categories.

registerCommand

fun registerCommand(registrar: CommandRegistrar)

registerCommandNodes

fun registerCommandNodes(nodes: Collection<LiteralCommandNode<ClientCommandSource>>)

registerListeners

fun registerListeners(vararg listeners: EventListener)

Only tracks listeners for rollback; modules and modes are tracked already.

registerMarketplaceHandler

fun registerMarketplaceHandler(type: MarketplaceItemType, handler: MarketplaceItemHandler)

Takes over subscribed marketplace items of type; handler runs once the subscriptions are loaded at startup and after every install, update or removal of one.

registerMode

fun <T : Mode> registerMode(parent: ModeValueGroup<T>, mode: T)

registerModules

fun registerModules(vararg modules: ClientModule)

registerQuickFix

fun registerQuickFix(quickFix: QuickFix): QuickFix

Offers quickFix on the fatal error screen for the errors it matches.

removeEventListenerScope

fun EventListener.removeEventListenerScope()

Remove cached scope and cancel it.

repeated

inline fun <T : Event> EventListener.repeated(times: Int = 1, priority: Short = 1, crossinline handler: (T) -> Unit): EventHook<T>

sequenceHandler

inline fun <T : Event> EventListener.sequenceHandler(priority: Short = 0, dispatcher: CoroutineDispatcher? = null, onCancellation: Runnable? = null, crossinline eventHandler: SuspendableEventHandler<T>): EventHook<T>

Registers an event hook for events of type T and launches a sequence

suspendHandler

inline fun <T : Event> EventListener.suspendHandler(context: CoroutineContext = EmptyCoroutineContext, priority: Short = 0, behavior: SuspendHandlerBehavior = SuspendHandlerBehavior.Parallel.Default, noinline handler: SuspendableEventHandler<T>): EventHook<T>

Start a Job on event.

tickHandler

inline fun EventListener.tickHandler(dispatcher: CoroutineDispatcher? = null, onCancellation: Runnable? = null, crossinline eventHandler: suspend CoroutineScope.() -> Unit): EventHook<GameTickEvent>

Registers a repeatable sequence which repeats the execution of code on GameTickEvent.

toString

open override fun toString(): String

unregister

open fun unregister()

Unregisters the event handler from the manager. This decision is FINAL! After the class was unregistered we cannot restore the handlers.

unregisterModules

fun unregisterModules(vararg modules: ClientModule)

until

inline fun <T : Event> EventListener.until(priority: Short = 0, crossinline handler: (T) -> Boolean): EventHook<T>

waitMatches

inline suspend fun <T : Event> EventListener.waitMatches(priority: Short = 0, predicate: Predicate<T>): T

Wait an event of type T which matches given predicate.

suspend fun <T : Event> EventListener.waitMatches(eventClass: Class<T>, priority: Short, predicate: Predicate<T>): T

waitMatchesWithTimeout

inline suspend fun <T : Event> EventListener.waitMatchesWithTimeout(timeout: Duration, priority: Short = 0, predicate: Predicate<T>): T?

Wait an event of type T which matches given predicate. If the timeout is exceeded, return null.

wrapContinuationInterceptor

fun EventListener.wrapContinuationInterceptor(original: ContinuationInterceptor? = null): ContinuationInterceptor

Wrap the original interceptor and make it auto-detect the listener's running state at suspension to determine whether to resume the continuation.