EffectTemporaryHitpoints(int)

Create a Temporary Hitpoints effect that raises the Hitpoints of the target.

effect EffectTemporaryHitpoints(
    int nHitPoints
);

Parameters

nHitPoints

A positive integer


Description

Returns a new effect object that when applied to a target will temporarily increase their total Hit Points allowable.

Returns an effect of type EFFECT_TYPE_INVALIDEFFECT if nHitPoints < 0.



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
constants: EFFECT_TYPE_* Constants


 author: John Shuell
 Send comments on this topic.