api/dev.s7a.strata.ui/UiSession

UiSession

interface UiSession : AutoCloseable(source)

Execution-owner-confined handle for one retained UI, shared by client and remote event callbacks. Controls requested inside an event are applied after event delivery finishes. Terminal handles never reopen and retain their last applied presentation.

Properties

inputPolicy

abstract val inputPolicy: UiInputPolicy

Applied gameplay permissions while this session owns input.

interactionMode

abstract val interactionMode: UiInteractionMode

Applied interaction mode; hiding a HUD ends its interaction.

presentation

abstract val presentation: UiPresentation?

Applied native presentation, or null before the initial application acknowledgement.

status

abstract val status: UiSessionStatus

Current lifecycle, including pending switches and terminal reasons.

Functions

abstract override fun close()

Idempotently ends the session; takes precedence over unapplied controls.

setInputPolicy

abstract fun setInputPolicy(policy: UiInputPolicy): UiOperationResult

Changes permissions and releases previously forwarded pressed inputs.

setInteractionMode

abstract fun setInteractionMode(mode: UiInteractionMode): UiOperationResult

Selects cursor or camera interaction, or stops HUD interaction.

switch

abstract fun switch(presentation: UiPresentation): UiOperationResult

Requests a new native wrapper without replacing the contents or identity.