WillSave(object, int, int, object)

Performs a Will Save check.

int WillSave(
    object oCreature,
    int nDC,
    int nSaveType = SAVING_THROW_TYPE_NONE,
    object oSaveVersus = OBJECT_SELF
);

Parameters

oCreature

The creature that needs to roll a saving throw.

nDC

The difficulty check of the saving throw.

nSaveType

SAVING_THROW_TYPE_* (Default: SAVING_THROW_TYPE_NONE)

oSaveVersus

The source cause for the saving throw. (Default: OBJECT_SELF)

Description

Does a Will Save check for the given DC

Returns 0 if the saving throw roll failed, 1 if the saving throw roll succeeded and 2 if the target was immune to the save type specified.

Note: If used within an Area of Effect Object Script (On Enter, OnExit, OnHeartbeat), you MUST pass GetAreaOfEffectCreator() into oSaveVersus!!

Version

1.61

See Also

functions:	GetWillSavingThrow | SetWillSavingThrow | FortitudeSave | ReflexSave
categories:	Saving Throw Functions
constants:	SAVING_THROW_TYPE_*

---

 author: Tom Cassiotis, editor: Lilac Soul, Mistress