SpellAbsorptionUnlimitedCheck(object, object, int, int, int, int)

From NWN Lexicon
Jump to navigationJump to search

Does a spell absorption check that checks unlimited spell absorption effects (eg; Globes)

int SpellAbsorptionLimitedCheck(
    object oTarget,
    object oCaster,
    int nSpellId = -1,
    int nSpellSchool=-1,
    int nSpellLevel=-1,
    int bFeedback=FALSE
);

Parameters

oTarget
Target of the check
oCaster
Caster performing the check against oTarget
nSpellId
The spell ID to use if other variables are not set. If -1 it will attempt to be auto-detected. (default: -1)
nSpellSchool
The spell school to check for. If -1 uses nSpellId's spell school. (default: -1)
nSpellLevel
The spell level. If -1 uses nSpellId's spell level (given the casters last spell cast class) (default: -1)
bFeedback
If TRUE displays feedback automatically, FALSE it suppresses it. As per existing ResistSpell convention it defaults to FALSE. (default: FALSE)


Description

Does a spell absorption check that checks unlimited spell absorption effects (eg; Globes).

Returns: TRUE if the target absorbs oCasters spell, FALSE if failed or an error occured.


Remarks

This along with the sister functions SpellXXX functions allow you to do part of ResistSpell as required, even outside of a proper spell script.

nSpellId defaults to GetSpellId, nSpellSchool defaults to the spell school of nSpellId, nSpellLevel defaults to the level of the spell that is related to GetLastSpellCastClass (defaulting to Innate if there is a mismatch) in case you want to manipulate the values.


Version

This function was added in 1.89.8193.37 of NWN:EE.

Example

See Also

functions:

GetSpellResistance, GetCasterLevel, GetSpellId, ResistSpell, SpellResistanceCheck, SpellImmunityCheck, SpellAbsorptionLimitedCheck