geary-common-features/com.mineinabyss.geary.game.components/CooldownManager

CooldownManager

@Serializable

data class CooldownManager(completionTime: MutableMap<String, Cooldown> = mutableMapOf())

geary:cooldowns

A component that manages cooldowns for an entity. Each cooldown has a unique key, but may be used to keep track of anything. Typically a good idea to persist this component.

Constructors

CooldownManager

constructor(completionTime: MutableMap<String, Cooldown> = mutableMapOf())

Functions

isDone

fun isDone(key: String): Boolean

onCooldown

inline fun onCooldown(key: String, length: Duration, run: () -> Unit): Boolean

Runs something if no cooldown is active and starts the cooldown after running it.

onCooldownIf

inline fun onCooldownIf(key: String, length: Duration, run: () -> Boolean): Boolean

Runs something if no cooldown is active and starts the cooldown only if run returns true.

reset

fun reset(key: String)

Clears the cooldown for a key.

start

fun start(key: String, length: Long)

Starts a cooldown of a certain length under a key.

Properties

incompleteCooldowns

val incompleteCooldowns: Map<String, Cooldown>

Calculated map of incomplete cooldowns.