paper-api/dev.s7a.strata.paper/PaperUi

PaperUi

Application API supplied by the installed Strata Paper plugin. Depend on Strata and compile against this API without bundling it. Player operations require Paper's primary thread or the player's Folia region. On Folia, create state inside open and enter execute for subsequent state or session access.

Functions

capabilities

fun capabilities(player: Player): UiClientCapabilities?

Returns the current successful client negotiation, or null before readiness or after disconnection.

execute

fun <T> execute(player: Player, operation: () -> T): T

Enters the player's UI execution owner for state and session access without changing the native region. Async callers must first schedule on the player; this method never grants access to another entity's region.

install

fun install(provider: PaperUiProvider): AutoCloseable

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

open

fun open(ownerPlugin: Plugin, player: Player, definition: () -> UiDefinition): UiSession

Creates state and a fresh definition inside the player's execution owner, synchronously on the calling region. Mutable state must be created inside this factory and outside the definition's reevaluated content.

fun register(ownerPlugin: Plugin, type: ProjectionType)

Registers a plugin-owned extension for future client negotiations.