FortitudeSave(object, int, int, object)

Returns the result of a Fortitude Save check.

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

Parameters

oCreature

nDC

Difficulty check

nSaveType

SAVING_THROW_TYPE_* (Default: SAVING_THROW_TYPE_NONE)

oSaveVersus

(Default: OBJECT_SELF)

Description

Returns the result of a Fortitude Save check for the given Difficulty Check.

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

Version

1.22

Example

// Example 1 - Simple use.
nSaveResult = FortitudeSave(oTarget, nDifficultyCheck);

// Example 2 - Full parameter use.
nSaveResult = FortitudeSave(oTarget, nDifficultyCheck, SAVING_THROW_TYPE_COLD, OBJECT_SELF);

See Also

functions:	GetFortitudeSavingThrow | SetFortitudeSavingThrow | ReflexSave | WillSave
categories:	Saving Throw Functions
constants:	SAVING_THROW_TYPE_* Constants

---

 author: Brett Lathrope, editor: Mistress