GetLastSpellHarmful

From NWN Lexicon
Revision as of 22:38, 21 June 2020 by Jasperre (talk | contribs) (See Also)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

GetLastSpellHarmful()

Determines whether the last spell cast was harmful.

Description

Use this in a SpellCast script to determine whether the spell was considered harmful.

Returns TRUE if the last spell cast was harmful.

Only can be used accurately in the OnSpellCastAt script of a creature, placeable or door.

Remarks

Speculation: Returns TRUE if HostileSetting is set to 1 for this particular spell in spells.2da.

That speculation is wrong, it merely returns the value passed into the EventSpellCastAt(), using SignalEvent().

If it is FALSE, it doesn't mean it was a good spell, it could be any non-hostile (IE: don't initiate combat) spell.

Returns exact value passed into EventSpellCastAt function, i.e. any value, not just FALSE/TRUE can be put into EventSpellCastAt().

Version

1.22

Example

if(GetLastSpellHarmful())
{
    SpeakString("Ouch!");
}
else
{
    SpeakString("Thank you!");
}

See Also

functions: 

GetLastSpellCaster GetLastSpell

events: 

OnSpellCastAt Event


 author: Jochem van 't Hull, editor: Jasperre