flash.errors.ScriptTimeoutError - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.errors
Class	public dynamic class ScriptTimeoutError
Inheritance	ScriptTimeoutError Error Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0 Flash Player 9, Flash Lite 4

The ScriptTimeoutError exception is thrown when the script timeout interval is reached. The script timeout interval is 15 seconds. There are two XML attributes that you can add to the mx:Application tag: scriptTimeLimit (the number of seconds until script timeout) and scriptRecursionLimit (the depth of recursive calls permitted).

Two ScriptTimeoutError exceptions are thrown. The first exception you can catch and exit cleanly. If there is no exception handler, the uncaught exception terminates execution. The second exception is thrown but cannot be caught by user code; it goes to the uncaught exception handler. It is uncatchable to prevent the player from hanging indefinitely.

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		errorID : int [read-only] Contains the reference number associated with the specific error message.	Error
		message : String Contains the message associated with the Error object.	Error
		name : String Contains the name of the Error object.	Error
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ScriptTimeoutError(message:String = "") Creates a new ScriptTimeoutError object.	ScriptTimeoutError
		getStackTrace():String Returns the call stack for an error as a string at the time of the error's construction (for the debugger version of Flash Player and the AIR Debug Launcher (ADL) only; returns null if not using the debugger version of Flash Player or the ADL.	Error
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.	Error
		valueOf():Object Returns the primitive value of the specified object.	Object

Constructor Detail

ScriptTimeoutError

()

Constructor

public function ScriptTimeoutError(message:String = "")

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0 Flash Player 9

Creates a new ScriptTimeoutError object.

Parameters

message:String (default = "") — A string associated with the error object.

Examples How to use this example

ScriptTimeoutErrorExample.as

The following example uses the sample ScriptTimeoutErrorExample class to show the error generated in the event of script timeout. This is accomplished with the following steps:

A keepLooking Boolean property is declared.
The constructor calls the lockMachine() method within an error handling code segment that catches ScriptTimeoutError objects.
The lockMachine() method contains an endless while loop.
After awhile, the ScriptTimeoutError is thrown. The constructor catches it, outputs an error message through the trace statement and resets the keepLooking Boolean to false, which terminates the while loop in lockMachine().

package {
    import flash.display.Sprite;
    import flash.errors.ScriptTimeoutError;

    public class ScriptTimeoutErrorExample extends Sprite {        
        private var keepLooping:Boolean = true;

        public function ScriptTimeoutErrorExample() {
            try {
                lockMachine();
            } 
            catch(e:ScriptTimeoutError) {
                trace(e);    // ScriptTimeoutError: Error #1502: A script has executed for longer than 15 seconds
                keepLooping = false;
            }
        }
        
        private function lockMachine():void {
            while(keepLooping){        
            }
        }
    }
}