View source

class Error

package openfl.errors

extends Exception

extended by ArgumentError, IOError, IllegalOperationError, PermissionError, RangeError, SecurityError, TypeError

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on all platforms

The Error class contains information about an error that occurred in a script. In developing OpenFL applications, when you run your compiled code in a debugger, a message displays exceptions of type Error, or of a subclass, to help you troubleshoot the code. You create an Error object by using the Error constructor function. Typically, you throw a new Error object from within a try code block that is caught by a catch code block.

You can also create a subclass of the Error class and throw instances of that subclass.

Constructor

@:value({ id : 0, message : "" })new(message:String = "", id:Int = 0)

Creates a new Error object. If message is specified, its value is assigned to the object's Error.message property.

Parameters:

message

A string associated with the Error object; this parameter is optional.

id

A reference number to associate with the specific error message.

Variables

read onlyerrorID:Int

Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

name:String

Contains the message associated with the Error object. By default, the value of this property is "Error". You can specify a message property when you create an Error object by passing the error string to the Error constructor function.

Methods

getStackTrace():String

Returns the call stack for an error at the time of the error's construction as a string. As shown in the following example, the first line of the return value is the string representation of the exception object, followed by the stack trace elements:

TypeError: Error #1009: Cannot access a property or method of a null object reference
	at com.xyz::OrderEntry/retrieveData()[/src/com/xyz/OrderEntry.as:995]
	at com.xyz::OrderEntry/init()[/src/com/xyz/OrderEntry.as:200]
	at com.xyz::OrderEntry()[/src/com/xyz/OrderEntry.as:148]

The preceding listing shows the value of this method when called in a debugger version of Flash Player or code running in the AIR Debug Launcher (ADL). When code runs in a release version of Flash Player or AIR, the stack trace is provided without the file path and line number information, as in the following example:

TypeError: Error #1009: Cannot access a property or method of a null object reference
	at com.xyz::OrderEntry/retrieveData()
	at com.xyz::OrderEntry/init()
	at com.xyz::OrderEntry()

For Flash Player 11.4 and earlier and AIR 3.4 and earlier, stack traces are only available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

Returns:

A string representation of the call stack.

toString():String

Returns the string "Error" by default or the value contained in the Error.message property, if defined.

Returns:

The error message.