CurseHelper
Allows for applying visible maximum health reduction.
| Last updated | 2 months ago |
| Total downloads | 7448 |
| Total rating | 0 |
| Categories | Mods Tools Libraries |
| Dependency string | Klehrik-CurseHelper-1.0.7 |
| Dependants | 2 other packages depend on this package |
This mod requires the following mods to function
MGReturns-ENVY
A plugin to allow ReturnOfModding plugins greater control of their environment.
Preferred version: 1.2.0
RoRRModdingToolkit-RoRR_Modding_Toolkit
Friendly abstractions of the game's internal functions for easier modding.
Preferred version: 1.2.17README
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
