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(source)

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.

Constructors

Link copied to clipboard
constructor(title: UiText? = null, presentation: UiPresentation = UiPresentation.Screen, category: UiCategory? = null, inputPolicy: UiInputPolicy = UiInputPolicy.BlockAll, visibility: UiVisibilityPolicy = UiVisibilityPolicy(), hudOrder: Int = 0, pausesGame: Boolean = false, content: UiScope.() -> Unit)
constructor(title: String, presentation: UiPresentation = UiPresentation.Screen, category: UiCategory? = null, inputPolicy: UiInputPolicy = UiInputPolicy.BlockAll, visibility: UiVisibilityPolicy = UiVisibilityPolicy(), hudOrder: Int = 0, pausesGame: Boolean = false, content: UiScope.() -> Unit)

Creates a definition with a literal narration title.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun close()

Releases unused contents; after transfer, only the returned session owns termination.

Link copied to clipboard

Opens on the installed client runtime's owner thread; pre-transfer rejection leaves this definition available.

Link copied to clipboard

Atomically transfers contents to one runtime; application code must not call this privileged operation.