Tes3Mod:StopScript

The UESPWiki – Your source for The Elder Scrolls since 1995
Jump to: navigation, search


StopScript

                StopScript, ScriptName

       Where:   ScriptName = Name of the script to stop

        Type:   Script

     Returns:   none

     Example:   StopScript, CharGen

     Scripts:   CharGen
                EndGame

This stops a currently running global script started previously with StartScript. Using StopScript resets any local variables used by that script. A StopScript will not immediately terminate the script when it is called. Instead, the script continues executing to the End statement, and then terminates. Use the Return command to immediately stop a script for the current frame if desired.

If a Tribunal Start Script is terminated with StopScript, it will start up again the next time the game is loaded.

See Also: ScriptRunning, StartScript