EffectRegenerate(int, float)

Create a Regenerate effect.

effect EffectRegenerate(
    int nAmount,
    float fIntervalSeconds
);

Parameters

nAmount

amount of damage to be regenerated per time interval

fIntervalSeconds

length of interval in seconds


Description

Returns a new effect object that when applied, will cause the target to heal at the rate of nAmount every fIntervalSeconds.

Because effects are wiped by the internal engine when a PC or NPC goes below 1 hit point, this effect cannot be used to heal a dying PC.

But, items with the property Regeneration will work when a PC is dying, strangely enough! And normally means they raise back from the dead.

This shouldn't stop Wounding or EffectHitPointsWhenDying effects, as it isn't an actual Healing effect, as such.



Remarks

Constructors are special methods that return a new instance of an object. In NWN Script each effect that you can place on an object has it’s own constructor that creates a new instance of the specified effect. This effect object can then be used in an ApplyEffectToObject() Command. See Effect Constructor for more details.


Version

1.22

See Also

categories: Effects Functions


 author: John Shuell, editor: Jasperre
 Send comments on this topic.