velocity/dev.s7a.strata.runtime.velocity/VelocityScreens

VelocityScreens

Public entry point supplied by the installed Strata Velocity plugin. Consumers depend on plugin ID strata; definitions, state, and handlers run on its dedicated UI thread. Calls return immediately. Never join their futures from a screen handler or run blocking work in completion callbacks.

Functions

capabilities

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

Asynchronously reads the successful capability handshake for the current proxy connection.

execute

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

Queues a short state update or read from another Velocity callback onto the UI owner thread. Perform database and network work before this call; operation must not block or wait on another UI request.

open

fun ~~open~~(ownerPlugin: Any, player: Player, definition: () -> ScreenDefinition): CompletableFuture<RemoteScreenSession>

Creates state and a fresh definition on the UI thread, then replaces this player's previous proxy-owned screen. Construct owner-thread state inside definition; capturing state created on another thread is unsupported. Unavailable clients and declarations return a terminal handle with a typed failure.

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

Registers a plugin-owned exact schema for future handshakes; clients install matching factories independently.

release

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

Withdraws a consumer's handlers and schemas when it stops its service before proxy shutdown. The Strata plugin releases all consumers automatically during proxy shutdown.