api/dev.s7a.strata.ui

Package-level declarations

Types

data class UiCategory(val id: ResourceId)

An application-defined screen category; no runtime registration is required.

class UiClientCapabilities(types: Set<ProjectionType>, val hudLimit: Int)

Detached client support advertised by a successfully negotiated Strata connection. types contains exact component, modifier, and action schemas; hudLimit is the negotiated HUD capacity. Transport framing and implementation classes are outside this application contract.

UiCloseReason

enum UiCloseReason : Enum<UiCloseReason>

Terminal reason retained by the public session handle.

UiDefinition

class UiDefinition(title: UiText? = null, val presentation: UiPresentation = UiPresentation.Screen, val category: UiCategory? = null, val inputPolicy: UiInputPolicy = UiInputPolicy.BlockAll, val visibility: UiVisibilityPolicy = UiVisibilityPolicy(), val hudOrder: Int = 0, val pausesGame: Boolean = false, content: UiScope.() -> Unit) : AutoCloseable

One-shot UI contents and opening settings, without retaining a live session. Construction does not evaluate content. Transfer and close may race; exactly one wins ownership. The optional title is a narration name and is not automatically drawn inside the UI. pausesGame only takes effect when presented as a screen.

UiDefinitionPayload

class UiDefinitionPayload

Uniquely transferred definition, owned by its accepting runtime until terminal cleanup.

UiGameAction

enum UiGameAction : Enum<UiGameAction>

Native gameplay actions controlled independently while a UI owns input.

UiInputPolicy

data class UiInputPolicy(val movement: Boolean = false, val jump: Boolean = false, val sneak: Boolean = false, val sprint: Boolean = false, val look: Boolean = false, val attack: Boolean = false, val use: Boolean = false, val hotbar: Boolean = false, val drop: Boolean = false, val swapHands: Boolean = false, val pick: Boolean = false)

Gameplay permissions while this UI owns input; text editing temporarily blocks every permission.

UiInteractionMode

enum UiInteractionMode : Enum<UiInteractionMode>

Which input surface a session requests; only one HUD may own interaction.

UiOperationResult

sealed interface UiOperationResult

Immediate admission result; accepted remote requests still require an application acknowledgement.

UiPresentation

enum UiPresentation : Enum<UiPresentation>

Native placement of a UI, independent of its retained contents.

UiRejection

enum UiRejection : Enum<UiRejection>

A rejected control request leaves the previously applied state intact.

UiScreenKind

enum UiScreenKind : Enum<UiScreenKind>

Adapter classification of an ordinary screen that may obscure a HUD.

UiSession

interface UiSession : AutoCloseable

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.

UiSessionStatus

sealed interface UiSessionStatus

Owner-thread view of presentation admission and terminal lifecycle.

UiVisibility

enum UiVisibility : Enum<UiVisibility>

What happens to a HUD when another ordinary screen is present.

UiVisibilityPolicy

class UiVisibilityPolicy(val default: UiVisibility = UiVisibility.Hide, categories: Map<UiCategory, UiVisibility> = emptyMap(), screens: Map<UiScreenKind, UiVisibility> = emptyMap())

Immutable HUD rules, resolved by category, then screen kind, then default.