Difference between revisions of "ScriptEffectFinish"
Jump to navigation
Jump to search
imported>JOG (Moved to "Category: Blocktypes") |
imported>Scruggs (fails to run during Wait menu or when reference is out of loaded cell) |
||
| Line 4: | Line 4: | ||
Special block type used only by Magic Effect scripts. This block will run only once, after the scripted spell effect has ended. | Special block type used only by Magic Effect scripts. This block will run only once, after the scripted spell effect has ended. | ||
Notes: | |||
* The ScriptEffectUpdate will be processed before the ScriptEffectFinish block when the spell ends. If there is a return statement in ScriptEffectUpdate, then the ScriptEffectFinish block will never run. | |||
* When the script effect is removed or expires while running on a reference which is not in the currently loaded cell, there is a very good chance that the ScriptEffectFinish block will not be processed. This can lead to the effect becoming permanent - the spell is removed, but any "clean-up" code inside the Finish block never executes. | |||
* The above is also true if the spell expires while the Wait or Sleep menu is displayed. | |||
==See Also== | ==See Also== | ||
Revision as of 11:47, 20 July 2006
Usage
begin ScriptEffectFinish
Special block type used only by Magic Effect scripts. This block will run only once, after the scripted spell effect has ended.
Notes:
- The ScriptEffectUpdate will be processed before the ScriptEffectFinish block when the spell ends. If there is a return statement in ScriptEffectUpdate, then the ScriptEffectFinish block will never run.
- When the script effect is removed or expires while running on a reference which is not in the currently loaded cell, there is a very good chance that the ScriptEffectFinish block will not be processed. This can lead to the effect becoming permanent - the spell is removed, but any "clean-up" code inside the Finish block never executes.
- The above is also true if the spell expires while the Wait or Sleep menu is displayed.