CurseHelper
Allows for applying visible maximum health reduction.
Screenshots 1 screenshots
About this mod Author’s original text
Allows for applying visible maximum health reduction.
Import line:
Curse = mods["Klehrik-CurseHelper"].setup()
Functions
Curse.apply(actor, id, amount) -> nil
Applies an instance of maximum health reduction to the actor.
Works multiplicatively with other curse applications
(e.g., 2 applications of 0.5 will result in 25% maximum health remaining).
Specifying an existing ID will override it.
Can be called as either host or client and it will automatically sync.
Parameters:
| Parameter | Type | Description |
| ------------- | -------- | --------------- |
| actor | CInstance or Actor object | The actor to apply curse to. |
| id | string | The identifier for the curse application. |
| amount | number | The amount of curse to apply (between 0 (none) and 1 (all health)). |
Curse.remove(actor, id) -> nil
Removes an instance of maximum health reduction from the actor.
Can be called as either host or client and it will automatically sync.
Parameters:
| Parameter | Type | Description |
| ------------- | -------- | --------------- |
| actor | CInstance or Actor object | The actor to remove curse from. |
| id | string | The identifier for the curse application. |
Curse.get_effective(actor) -> number, number, number
Returns the actor's effective (i.e., after curse) maximum health, shield, and barrier as unpacked values.
maximum health, maximum shield, maximum barrier
Parameters:
| Parameter | Type | Description |
| ------------- | -------- | --------------- |
| actor | CInstance or Actor object | The actor to check. |
Installation Instructions
Follow the instructions listed here.
Join the Return of Modding server for support.
Additional Contributions
@0n_x - Mini health bar overlay and general fixes
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: