EffectSavingThrowDecrease(int, int, int)

Create a Saving Throw Decrease effect to lower one Saving Throw type.

effect EffectSavingThrowDecrease(
    int nSave,
    int nValue,
    int nSaveType = SAVING_THROW_TYPE_ALL
);

Parameters

nSave

The Saving Throw to affect, as defined by the SAVING_THROW_* constants group.

nValue

The amount to lower the saving throws by.

nSaveType

The type of resistance this effect applies to as defined by the SAVING_THROW_TYPE_* constants group. (Default: SAVING_THROW_TYPE_ALL)


Description

Returns a new effect object that when applied to a target will lower the nSave Saving Throw by nValue amount when resisting anything that falls under the nSaveType definition.



Remarks

Note: nSave and nSaveType are defined by similarly named constant groups and should not be confused.

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 | Saving Throw Functions
constants: SAVING_THROW_* Constants | SAVING_THROW_TYPE_* Constants


 author: John Shuell
 Send comments on this topic.