HUD

actual class HUD : BaseHUD

Default BaseHUD implementation.

expect class HUD : BaseHUD

Default BaseHUD implementation.

actual class HUD

Default BaseHUD implementation.

actual class HUD : BaseHUD

Default BaseHUD implementation.

actual class HUD : BaseHUD

Default BaseHUD implementation.

Constructors

Link copied to clipboard
constructor(hudConfig: HudConfig, coroutineScope: CoroutineScope)
constructor(hudConfig: HudConfig, coroutineScope: CoroutineScope)

Types

Link copied to clipboard

Builder class for creating a HUD

expect class Builder : BaseHUD.Builder

Builder class for creating a HUD

actual class Builder

Builder class for creating a HUD

actual class Builder : BaseHUD.Builder

Builder class for creating a HUD

actual class Builder : BaseHUD.Builder

Builder class for creating a HUD

Properties

coroutineContext
Link copied to clipboard
Link copied to clipboard
open override val hudConfig: HudConfig

The HudConfig of the HUD being presented.

abstract val hudConfig: HudConfig

The HudConfig of the HUD being presented.

open val hudConfig: <Error class: unknown class>
open override val hudConfig: HudConfig

The HudConfig of the HUD being presented.

open override val hudConfig: HudConfig

The HudConfig of the HUD being presented.

Link copied to clipboard
open override val isVisible: Boolean

Returns true if indicator is visible

abstract val isVisible: Boolean

Returns true if indicator is visible

open val isVisible: Boolean
open override val isVisible: Boolean

Returns true if indicator is visible

open override val isVisible: Boolean

Returns true if indicator is visible

Link copied to clipboard

The HUDStyle of the HUD.

Link copied to clipboard

The title of the HUD.

Functions

Link copied to clipboard
open suspend override fun dismiss(animated: Boolean)

Dismisses the indicator

abstract suspend fun dismiss(animated: Boolean = true)

Dismisses the indicator

open suspend fun dismiss(animated: Boolean): <Error class: unknown class>
open suspend override fun dismiss(animated: Boolean)

Dismisses the indicator

open suspend override fun dismiss(animated: Boolean)

Dismisses the indicator

Link copied to clipboard
fun BaseHUD.dismissAfter(timeMillis: Long, animated: Boolean = true): BaseHUD

Dismisses the indicator after timeMillis milliseconds

fun BaseHUD.dismissAfter(duration: Duration, animated: Boolean = true): BaseHUD

Dismisses the indicator after duration

Link copied to clipboard
open suspend override fun present(animated: Boolean): HUD

Presents as indicator

abstract suspend fun present(animated: Boolean = true): BaseHUD

Presents as indicator

open suspend fun present(animated: Boolean): HUD
open suspend override fun present(animated: Boolean): HUD

Presents as indicator

open suspend override fun present(animated: Boolean): HUD

Presents as indicator

Link copied to clipboard
suspend fun <T> BaseHUD.presentDuring(animated: Boolean = true, block: suspend BaseHUD.() -> T): T

Presents and keep presenting the indicator during block execution, hides view after block finished.