velocity-api/dev.s7a.strata.velocity/VelocityUi

VelocityUi

object VelocityUi(source)

Application API supplied by the installed Strata Velocity plugin. Construct owner-thread state inside open, and queue external state or session access through execute. Never block the UI thread on returned futures. Plugin events contain snapshots and do not block UI processing.

Functions

fun capabilities(player: Player): CompletableFuture<UiClientCapabilities?>

Asynchronously reads the current negotiated support, or null while unavailable.

fun <T> execute(ownerPlugin: Any, operation: () -> T): CompletableFuture<T>

Queues short state updates or session operations on the owner thread. Complete blocking work before calling this method.

fun install(provider: VelocityUiProvider): AutoCloseable

Installs one runtime; closing the registration releases only that installation.

fun open(ownerPlugin: Any, player: Player, definition: () -> UiDefinition): CompletableFuture<UiSession>

Creates state and a fresh one-shot definition on the UI thread, then opens the owned session.

fun register(ownerPlugin: Any, type: ProjectionType): CompletableFuture<Unit>

Registers a plugin-owned exact schema for future client negotiations.

fun release(ownerPlugin: Any): CompletableFuture<Unit>

Releases one consumer's sessions and schemas before proxy shutdown.