CooldownHelper
Allows for displaying cooldowns on the HUD.
Screenshots 1 screenshots
About this mod Author’s original text
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.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide. If the mod depends on a loader such as ReturnOfModding, install it first as the readme describes.
Install these first, or the mod will not work: