EffectDeath(int, int)

Create a Death effect

effect EffectDeath(
    int nSpectacularDeath = FALSE,
    int nDisplayFeedback = TRUE
);

Parameters

nSpectacularDeath

If this is TRUE, the creature to which this effect is applied will die in an extraordinary fashion (Default: FALSE)

nDisplayFeedback

(Default: TRUE)


Description

Returns a new effect object that when applied to a target, their hitpoints are set to zero, they play a death animation (if nSpectacularDeath is TRUE it will apply the 'chunky' death on NPCs), and the creature becomes uncommandable -- they can no longer move, attack, cast or whatever. When it is applied to doors or placeable objects, they are destroyed and play a shatter animation. The death effect is an instantaneous effect that sets the recipient to be 'dead' and then deletes itself. (it is one of the few non-reversible effects along with damage, heal, resurrection and a few others). You apply it, it sets the object dead, and it then disappears forever. To bring a creature back to life you need to use EffectResurrection().



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: Combat Functions | Effects Functions


 author: John Shuell
 Send comments on this topic.