Xordac: 1 revision imported

2017-10-23T23:23:29Z

1 revision imported

New page

=Spells Function Category=

Functions that deal with spells.

 

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionCastSpellAtLocation | ActionCastSpellAtLocation ]]
| Cast a spell at a specific location.
|-
|
[[ActionCastSpellAtObject | ActionCastSpellAtObject ]]
| Cast a spell at an object.
|-
|
[[ArcaneArcherDamageDoneByBow | ArcaneArcherDamageDoneByBow ]]
| Returns how much should special archer arrows do for damage.
|-
|
[[ArcaneArcherCalculateBonus | ArcaneArcherCalculateBonus ]]
| Calculates the enhancement bonus for an Arcane Archer.
|-
|
[[CreateProtectionFromAlignmentLink | CreateProtectionFromAlignmentLink ]]
| Creates a protection from alignment effect.
|-
|
[[DecrementRemainingSpellUses | DecrementRemainingSpellUses ]]
| Decrease the number of spell uses of a particular spell for a given creature.
|-
|
[[doAura | doAura ]]
| Used in the alignment aura spells.
|-
|
[[DoCaltropEffect | DoCaltropEffect ]]
| Caltrops do 25 points of damage (1 point per target per round) and then are gone.
|-
|
[[DoCaltropsEffect | DoCaltropsEffect ]]
| Apply the caltrops effect to the specified target.
|-
|
[[DoCamoflage | DoCamoflage ]]
| Applies the 'camoflage' magical effect to the target.
|-
|
[[DoDirgeEffect | DoDirgeEffect ]]
| Applies the ability score damage of the dirge effect.
|-
|
[[DoGrenade | DoGrenade ]]
| Does a damage type grenade (direct or splash on miss).
|-
|
[[DoMagicFang | DoMagicFang ]]
| Improves an animal companion's attack and damage and the ability to hit magically protected creatures.
|-
|
[[DoMissileStorm | DoMissileStorm ]]
| Fires a storm of missiles at targets in area.
|-
|
[[DoPetrification | DoPetrification ]]
| This is a wrapper for how Petrify will work in Expansion Pack 1.
|-
|
[[DoSpellBreach | DoSpellBreach ]]
| Performs a spell breach; up to nTotal spells are removed and nSR spell resistance is lowered.
|-
|
[[DoSpikeGrowthEffect | DoSpikeGrowthEffect ]]
| For spike growth area of effect object applies damage and slow effect.
|-
|
[[DoTrapSpike | DoTrapSpike ]]
| Apply effects of spike trap on entering object.
|-
|
[[DoWhirlwindAttack | DoWhirlwindAttack ]]
| Perform a whirlwind attack.
|-
|
[[EffectACDecrease | EffectACDecrease ]]
| Creates an AC decrease effect.
|-
|
[[EffectACIncrease | EffectACIncrease ]]
| Gives an AC bonus to an object.
|-
|
[[EffectAreaOfEffect | EffectAreaOfEffect ]]
| Returns a new effect object.
|-
|
[[EffectDispelMagicAll | EffectDispelMagicAll ]]
| Create a Dispel Magic All effect.
|-
|
[[EffectDispelMagicBest | EffectDispelMagicBest ]]
| Create a Dispel Magic Best effect.
|-
|
[[EffectPolymorph | EffectPolymorph ]]
| Create a Polymorph effect that changes the target into a different type of creature.
|-
|
[[EffectSpellImmunity | EffectSpellImmunity ]]
| Returns an effect of spell immunity.
|-
|
[[EffectSpellLevelAbsorption | EffectSpellLevelAbsorption ]]
| Returns a Spell Level Absorption effect
|-
|
[[EffectTurnResistanceDecrease | EffectTurnResistanceDecrease ]]
| Create a Turn Resistance Decrease effect that can make creatures more susceptible to turning.
|-
|
[[EffectTurnResistanceIncrease | EffectTurnResistanceIncrease ]]
| Create a Turn Resistance Decrease effect that can make creatures more resistant to turning.
|-
|
[[EventSpellCastAt | EventSpellCastAt ]]
| Creates an event which triggers a "spell cast at" reaction.
|-
|
[[ExplodeObject | ExplodeObject ]]
| Blow up an object with the given spell.
|-
|
[[GetArcaneSpellFailure | GetArcaneSpellFailure ]]
| Gets a creature's arcane spell failure factor
|-
|
[[GetAttemptedSpellTarget | GetAttemptedSpellTarget ]]
| Determines the creature a spell was attempted to be cast at.
|-
|
[[GetCasterLevel | GetCasterLevel ]]
| Determines the level of caster for a creature or PC casting a spell.
|-
|
[[GetDefensiveCastingMode | GetDefensiveCastingMode ]]
| Retrieves the defensive casting mode status of a creature.
|-
|
[[GetEnteringObject | GetEnteringObject ]]
| Gets the object that last opened or entered the calling object.
|-
|
[[GetEpicSpellSaveDC | GetEpicSpellSaveDC ]]
| Determines the DC needed to save against any epic spell.
|-
|
[[GetExitingObject | GetExitingObject ]]
| Get the object that last left the calling object.
|-
|
[[GetHasSpell | GetHasSpell ]]
| Determines whether a creature has a spell available.
|-
|
[[GetIsMagicStatBonus | GetIsMagicStatBonus ]]
| Returns spellcasting ability modifier.
|-
|
[[GetLastSpell | GetLastSpell ]]
| Determines the spell that was last cast.
|-
|
[[GetLastSpellCastClass | GetLastSpellCastClass ]]
| Returns the class that the spellcaster cast the spell as
|-
|
[[GetLastSpellCaster | GetLastSpellCaster ]]
| Determines who last cast a spell.
|-
|
[[GetLastSpellHarmful | GetLastSpellHarmful ]]
| Determines whether the last spell cast was harmful.
|-
|
[[GetMetaMagicFeat | GetMetaMagicFeat ]]
| Get the type of metamagic used on the last spell.
|-
|
[[GetScaledDuration | GetScaledDuration ]]
| Determines a scaled down duration based on the game difficulty setting.
|-
|
[[GetScaledEffect | GetScaledEffect ]]
| Creates a new effect based on the game difficulty.
|-
|
[[GetSizeModifier | GetSizeModifier ]]
| Gets the creature's applicable size modifier.
|-
|
[[GetSpellBreachProtection | GetSpellBreachProtection ]]
| Returns the next protection spell from a list of seventeen.
|-
|
[[GetSpellCastItem | GetSpellCastItem ]]
| Determines the object that caused the spell script to be called.
|-
|
[[GetSpellEffectDelay | GetSpellEffectDelay ]]
| Determines the time an effect should be delayed.
|-
|
[[GetSpellId | GetSpellId ]]
| Determines the spell identifier for a spell which a script is currently processing.
|-
|
[[GetSpellResistance | GetSpellResistance ]]
| Returns the spell resistance of the specified creature
|-
|
[[GetSpellSaveDC | GetSpellSaveDC ]]
| Determines the DC needed to save against the cast spell.
|-
|
[[GetSpellTargetLocation | GetSpellTargetLocation ]]
| Determines the location of a spell's target location.
|-
|
[[GetSpellTargetObject | GetSpellTargetObject ]]
| Retrieves the target of the caller's last spell.
|-
|
[[GetTypeFromTalent | GetTypeFromTalent ]]
| Determines the primary category of the talent requested.
|-
|
[[GZCanNotUseGazeAttackCheck | GZCanNotUseGazeAttackCheck ]]
| Returns TRUE if oCreature is blinded and thus cannot use a gaze attack.
|-
|
[[GZGetHighestSpellcastingClassLevel | GZGetHighestSpellcastingClassLevel ]]
| Returns the target creature's levels in their highest spell casting class.
|-
|
[[HasSpell | HasSpell ]]
| Checks if caller has spell
|-
|
[[IPGetIPConstCastSpellFromSpellID | IPGetIPConstCastSpellFromSpellID ]]
| Returns a spell's corresponding itemproperty constant.
|-
|
[[IPGetItemSequencerProperty | IPGetItemSequencerProperty ]]
| Checks the sequencer property of an item.
|-
|
[[ItemPropertyCastSpell | ItemPropertyCastSpell ]]
| Sets a "cast spell" itemproperty.
|-
|
[[ItemPropertyOnHitCastSpell | ItemPropertyOnHitCastSpell ]]
| Sets an "on hit cast spell" item property.
|-
|
[[MaximizeOrEmpower | MaximizeOrEmpower ]]
| Checks the appropriate metamagic to see how the damage should be scaled.
|-
|
[[MyResistSpell | MyResistSpell ]]
| Determines and plays animation for resisting a spell when applicable.
|-
|
[[MySavingThrow | MySavingThrow ]]
| Checks for spell countering by a saving throw.
|-
|
[[RemoveAnySpellEffects | RemoveAnySpellEffects ]]
| Doesn't care who the caster was; removes the effects of the specified spell.
|-
|
[[RemoveProtections | RemoveProtections ]]
| Removes all spell protections of a specific type.
|-
|
[[RemoveSpellEffects | RemoveSpellEffects ]]
| Removes the effects of a spell cast on a creature.
|-
|
[[RemoveSpellEffects2 | RemoveSpellEffects2 ]]
| Advanced version of RemoveSpellEffects to handle multiple spells.
|-
|
[[ResistSpell | ResistSpell ]]
| Performs a spell resistance check between the caster and the target.
|-
|
[[RunMelfAcidImpact | RunMelfAcidImpact ]]
| Handles the dealing of damage each round by the Melfâs Acid Arrow spell.
|-
|
[[ShadowBolt | ShadowBolt ]]
| Used with Greater Shadow Conjuration spell to cast a damaging bolt towards an NPC.
|-
|
[[spellApplyMindBlank | spellApplyMindBlank ]]
| Removes negative mind effects and provides mind protection.
|-
|
[[SpellDelay | SpellDelay ]]
| Incorporates a delay on applying special FX and damage FX until cone 'reaches' the target.
|-
|
[[spellsDispelAoE | spellsDispelAoE ]]
| Handles dispel magic of area of effect spells.
|-
|
[[spellsDispelMagic | spellsDispelMagic ]]
| Dispel magic on one or multiple targets.
|-
|
[[spellsGenericAreaOfEffect | spellsGenericAreaOfEffect ]]
| Generic apply area of effect wrapper.
|-
|
[[spellsInflictTouchAttack | spellsInflictTouchAttack ]]
| Inflicts a spell touch attack.
|-
|
[[spellsIsFlying | spellsIsFlying ]]
| Returns TRUE if the target creature is flying.
|-
|
[[spellsIsImmuneToPetrification | spellsIsImmuneToPetrification ]]
| Returns TRUE if the target creature is immune to petrification.
|-
|
[[spellsIsMindless | spellsIsMindless ]]
| Returns TRUE if the target creature does not have a mind.
|-
|
[[spellsIsTarget | spellsIsTarget ]]
| Generic reputation wrapper.
|-
|
[[spellsStinkingCloud | spellsStinkingCloud ]]
| Does a stinking cloud.
|-
|
[[TalentAdvancedBuff | TalentAdvancedBuff ]]
| Causes the NPC/Creature to buff themselves using a priority aligned list of spells if they have them.
|-
|
[[TalentCureCondition | TalentCureCondition ]]
| Cure Disease, Poison, Curse and Blindness and Deafness of nearest friendly target.
|-
|
[[TalentSeeInvisible | TalentSeeInvisible ]]
| Determines if the NPC has the ability to see invisible creatures through feat or spell.
|-
|
[[TrimLevel | TrimLevel ]]
| Returns the valid upper limit for any arcane spell scroll.
|-
|
[[VersusAlignmentEffect | VersusAlignmentEffect ]]
| Set eEffect to be versus a specific alignment.
|-
|
[[VersusRacialTypeEffect | VersusRacialTypeEffect ]]
| Set eEffect to be versus nRacialType.
|-
|
[[X2CastOnItemWasAllowed | X2CastOnItemWasAllowed ]]
| This function return TRUE if the last casted spell can be cast to any item.
|-
|
[[X2GetSpellCastOnSequencerItem | X2GetSpellCastOnSequencerItem ]]
| Sequencer item property handling.
|-
|
[[X2PreSpellCastCode | X2PreSpellCastCode ]]
| This function hooks all default spell scripts and is used for procedures related to all spells or for block the spell code to be executed.
|-
|
[[X2RunUserDefinedSpellScript | X2RunUserDefinedSpellScript ]]
| Runs a custom spellhook script if defined.
|}

----
author: NWN Lexicon Group, editor: Mistress 
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Spells Functions - Revision history

Xordac: 1 revision imported