EffectSpellLevelAbsorption(int, int, int)

Returns a Spell Level Absorption effect

effect EffectSpellLevelAbsorption(
    int nMaxSpellLevelAbsorbed,
    int nTotalSpellLevelsAbsorbed = 0,
    int nSpellSchool = SPELL_SCHOOL_GENERAL
);

Parameters

nMaxSpellLevelAbsorbed

maximum spell level that will be absorbed by the effect

nTotalSpellLevelsAbsorbed

maximum number of spell levels that will be absorbed by the effect (Default: 0)

nSpellSchool

SPELL_SCHOOL_* (Default: SPELL_SCHOOL_GENERAL)


Description

Returns a Spell Level Absorption effect.

Returns an effect of type EFFECT_TYPE_INVALIDEFFECT if: nMaxSpellLevelAbsorbed is not between -1 and 9 inclusive, or nSpellSchool is invalid.



Remarks

This function only creates the effect. The effect must then be applied.


Version

1.22

Example

// Example 1 - The following code will create an effect which, when applied, will absorb up to 4 levels of a (maximum) level 6 spell from the school of necromancy.

  effect eSpellAbsorb;
  eSpellAbsorb = EffectSpellLevelAbsorption(6, 4, SPELL_SCHOOL_NECROMANCY);

See Also

functions: ApplyEffectToObject | GetEffectType | GetFirstEffect | GetNextEffect | RemoveEffect
categories: Effects Functions
constants: EFFECT_TYPE_* Constants | SPELL_SCHOOL_* Constants


 author: Brett Lathrope
 Send comments on this topic.