CooldownHelper

Allows for displaying cooldowns on the HUD.
(Automatically adds Time Keeper's Secret's cooldown.)

Import line:

Cooldown = mods["Klehrik-CooldownHelper"].setup()

---

Functions

Cooldown.set(inst, id, duration, [icon], [color]) -> nil

Adds a cooldown to the instance.
Overrides the existing cooldown if the ID is already in use.

Parameters:

Parameter	Type	Description
inst	CInstance or Instance object	The instance to set the cooldown for.
id	string	The identifier for the cooldown.
duration	number	The maximum time for the cooldown (in frames).
[icon]	sprite	Player HUD: The icon to display on the cooldown visual. Should be 8px x 8px.
[color]	color	Player HUD: The color to use for the cooldown visual.

Cooldown.get(inst, id) -> number, number, sprite, color

Returns information about a cooldown as unpacked values.
remaining time, maximum time, icon sprite, color

Parameters:

Parameter	Type	Description
inst	CInstance or Instance object	The instance to get the cooldown from.
id	string	The identifier for the cooldown.

---

Installation Instructions

Follow the instructions listed here.
Join the Return of Modding server for support.