You are viewing a potentially older version of this package. View all versions.
Klehrik-CurseHelper-1.0.2 icon

CurseHelper

Allows for applying visible maximum health reduction.

Date uploaded a year ago
Version 1.0.2
Download link Klehrik-CurseHelper-1.0.2.zip
Downloads 112
Dependency string Klehrik-CurseHelper-1.0.2

This mod requires the following mods to function

ReturnOfModding-ReturnOfModding-1.0.65 icon
ReturnOfModding-ReturnOfModding

Lua Mod Loader for Risk of Rain Returns

Preferred version: 1.0.65
RoRRModdingToolkit-RoRR_Modding_Toolkit-1.2.17 icon
RoRRModdingToolkit-RoRR_Modding_Toolkit

Friendly abstractions of the game's internal functions for easier modding.

Preferred version: 1.2.17
MGReturns-ENVY-1.2.0 icon
MGReturns-ENVY

A plugin to allow ReturnOfModding plugins greater control of their environment.

Preferred version: 1.2.0

README

Allows for applying visible maximum health reduction.

CurseHelperShowcase.png

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.

CHANGELOG

v1.0.7

  • Actual fix for buggy shield sfx.

v1.0.6

  • Fix for buggy shield sfx.

v1.0.5

  • Check if self exists in hook.

v1.0.4

  • Fix for mini health bar overlay appearing when it shouldn't.

v1.0.3

  • Now overlays on top of the mini health bar (thanks @0n_x).

v1.0.2

  • Now online synced.

v1.0.1

  • Updated alongside RMT.

v1.0.0

  • Initial release