| Function | Defined By | ||
|---|---|---|---|
Creates a new array. | Top Level | ||
Boolean(expression:Object):Boolean
Converts the expression parameter to a Boolean value and returns the value. | Top Level | ||
Date():String
Returns a String representation of the current day, date, time, and timezone. | Top Level | ||
decodeURI(uri:String):String
Decodes an encoded URI into a string. | Top Level | ||
decodeURIComponent(uri:String):String
Decodes an encoded URI component into a string. | Top Level | ||
encodeURI(uri:String):String
Encodes a string into a valid URI (Uniform Resource Identifier). | Top Level | ||
encodeURIComponent(uri:String):String
Encodes a string into a valid URI component. | Top Level | ||
escape(str:String):String
Converts the parameter to a string and encodes it in a URL-encoded format,
where most nonalphanumeric characters are replaced with % hexadecimal sequences. | Top Level | ||
int(value:Number):int
Converts a given numeric value to an integer value. | Top Level | ||
isFinite(num:Number):Boolean
Returns true if the value is a finite number,
or false if the value is Infinity or -Infinity. | Top Level | ||
isNaN(num:Number):Boolean
Returns true if the value is NaN(not a number). | Top Level | ||
isXMLName(str:String):Boolean
Determines whether the specified string is a valid name for an XML element or attribute. | Top Level | ||
Number(expression:Object):Number
Converts a given value to a Number value. | Top Level | ||
Object(value:Object):Object
Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value. | Top Level | ||
parseFloat(str:String):Number
Converts a string to a floating-point number. | Top Level | ||
parseInt(str:String, radix:uint = 0):Number
Converts a string to an integer. | Top Level | ||
String(expression:Object):String
Returns a string representation of the specified parameter. | Top Level | ||
Displays expressions, or writes to log files, while debugging. | Top Level | ||
uint(value:Number):uint
Converts a given numeric value to an unsigned integer value. | Top Level | ||
unescape(str:String):String
Evaluates the parameter str as a string, decodes the string from URL-encoded format
(converting all hexadecimal sequences to ASCII characters), and returns the string. | Top Level | ||
XML(expression:Object):XML
Converts an object to an XML object. | Top Level | ||
XMLList(expression:Object):XMLList
Converts an object to an XMLList object. | Top Level | ||
| Constant | Defined By | ||
|---|---|---|---|
| Infinity : Number
A special value representing positive Infinity. | Top Level | ||
| -Infinity : Number
A special value representing negative Infinity. | Top Level | ||
| NaN : Number
A special member of the Number data type that represents a value that is "not a number" (NaN). | Top Level | ||
| undefined : *
A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized. | Top Level | ||
| Infinity | Constant |
const Infinity:Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
A special value representing positive Infinity. The value of this constant is the same as Number.POSITIVE_INFINITY.
See also
| -Infinity | Constant |
const -Infinity:Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
A special value representing negative Infinity. The value of this constant is the same as Number.NEGATIVE_INFINITY.
See also
| NaN | Constant |
const NaN:Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
A special member of the Number data type that represents a value that is "not a number" (NaN).
When a mathematical expression results in a value that cannot be expressed as a number, the result is NaN.
The following list describes common expressions that result in NaN.
NaN only if the divisor is also 0. If the divisor is greater than 0, division by 0 results in Infinity. If the divisor is less than 0, division by 0 results in -Infinity;Infinity subtracted from Infinity;Infinity or -Infinity divided by Infinity or -Infinity;Infinity or -Infinity multiplied by 0;The NaN value is not a member of the int or uint data types.
The NaN value is not considered equal to any other value, including NaN, which makes it impossible to use the equality operator to test whether an expression is NaN. To determine whether a number is the NaN function, use isNaN().
See also
| undefined | Constant |
const undefined:*| Runtime Versions: | AIR 1.0, Flash Player 9 |
A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized.
In ActionScript 3.0, only variables that are untyped can hold the value undefined,
which is not true in ActionScript 1.0 and ActionScript 2.0.
For example, both of the following variables are undefined because they are untyped and unitialized:
var foo;var bar:*;The undefined value also applies to uninitialized or undefined properties of dynamic objects.
For example, if an object is an instance of the Object class,
the value of any dynamically added property is undefined until a value is assigned to that property.
Results vary when undefined is used with various functions:
String(undefined) is "undefined" (undefined is
converted to a string).Number(undefined) is NaN.int(undefined) and uint(undefined) is 0.Object(undefined) is a new Object instance.undefined is assigned to a typed variable,
the value is converted to the default value of the data type.Do not confuse undefined with null.
When null and undefined are compared with the equality
(==) operator, they compare as equal. However, when null and undefined are
compared with the strict equality (===) operator, they compare
as not equal.
See also
| Array | () | function |
function Array(... args):Array| Runtime Versions: | AIR 1.0, Flash Player 9 |
Creates a new array. The array can be of length zero or more, or an array populated by a list of specified elements, possibly of different data types. The number and data type of the arguments you use determine the contents of the returned array.
Array() with no arguments returns an empty array.Array() with a single integer argument returns an array of the specified length, but whose elements have undefined values.Array() with a list of specific values returns an array with elements that contain each of the specified values.Array() function is similar to creating an array with the Array class constructor.
Use the as operator for explicit type conversion, or type casting,
when the argument is not a primitive value. For more information, see the Example
section of this entry.
Parameters
... args — You can pass no arguments for an empty array, a single integer argument for an array of a specific length, or a series of comma-separated values of various types for an array populated with those values.
|
Array — An array of length zero or more.
|
See also
| Boolean | () | function |
function Boolean(expression:Object):Boolean| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts the expression parameter to a Boolean value and returns the value.
The return value depends on the data type and value of the argument, as described in the following table:
| Input Value | Example | Return Value |
|---|---|---|
0 | Boolean(0) | false |
NaN | Boolean(NaN) | false |
Number (not 0 or NaN) | Boolean(4) | true |
| Empty string | Boolean("") | false |
| Non-empty string | Boolean("6") | true |
null | Boolean(null) | false |
undefined | Boolean(undefined) | false |
| Instance of Object class | Boolean(new Object()) | true |
| No argument | Boolean() | false |
Unlike previous versions of ActionScript, the Boolean() function returns the same results as does the Boolean class constructor.
Parameters
expression:Object — An expression or object to convert to Boolean.
|
Boolean — The result of the conversion to Boolean.
|
| Date | () | function |
function Date():String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Returns a String representation of the current day, date, time, and timezone. The date format for the output is:
Day Mon Date HH:MM:SS TZD YYYY
For example:
Wed Apr 12 15:30:17 GMT-0700 2006
To cast a value to type Date use x as Date instead of
Date(x).
String — The current date as a String data type. The return value for
Date() is the same as the return value for Date.toString().
|
See also
| decodeURI | () | function |
function decodeURI(uri:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Decodes an encoded URI into a string. Returns a string in which all characters previously encoded
by the encodeURI function are restored to their unencoded representation.
The following table shows the set of escape sequences that are not decoded to characters by the decodeURI function. Use decodeURIComponent() to decode the escape sequences in this table.
| Escape sequences not decoded | Character equivalents |
|---|---|
%23 | # |
%24 | $ |
%26 | & |
%2B | + |
%2C | , |
%2F | / |
%3A | : |
%3B | ; |
%3D | = |
%3F | ? |
%40 | @ |
Parameters
uri:String — A string encoded with the encodeURI function.
|
String — A string in which all characters previously escaped by the encodeURI function are
restored to their unescaped representation.
|
See also
| decodeURIComponent | () | function |
function decodeURIComponent(uri:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Decodes an encoded URI component into a string. Returns a string in which
all characters previously escaped by the encodeURIComponent
function are restored to their uncoded representation.
This function differs from the decodeURI() function in that it is intended for use only with a part of a URI string, called a URI component.
A URI component is any text that appears between special characters called component separators
(: / ; and ? ).
Common examples of a URI component are "http" and "www.adobe.com".
Another important difference between this function and decodeURI() is that because this function
assumes that it is processing a URI component it treats the escape sequences that represent special separator characters (; / ? : @ & = + $ , #) as regular
text that should be decoded.
Parameters
uri:String — A string encoded with the encodeURIComponent function.
|
String — A string in which all characters previously escaped by the encodeURIComponent function are
restored to their unescaped representation.
|
See also
| encodeURI | () | function |
function encodeURI(uri:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Encodes a string into a valid URI (Uniform Resource Identifier). Converts a complete URI into a string in which all characters are encoded as UTF-8 escape sequences unless a character belongs to a small group of basic characters.
The following table shows the entire set of basic characters that are not converted to UTF-8 escape sequences by the encodeURI function.
| Characters not encoded |
|---|
0 1 2 3 4 5 6 7 8 9 |
a b c d e f g h i j k l m n o p q r s t u v w x y z |
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
; / ? : @ & = + $ , # |
- _ . ! ~ * ' ( ) |
Parameters
uri:String — A string representing a complete URI.
|
String — A string with certain characters encoded as UTF-8 escape sequences.
|
See also
| encodeURIComponent | () | function |
function encodeURIComponent(uri:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Encodes a string into a valid URI component. Converts a substring of a URI into a string in which all characters are encoded as UTF-8 escape sequences unless a character belongs to a very small group of basic characters.
The encodeURIComponent() function differs from the encodeURI() function in that it is intended for use only with a part of a URI string, called a URI component.
A URI component is any text that appears between special characters called component separators
(: / ; and ? ).
Common examples of a URI component are "http" and "www.adobe.com".
Another important difference between this function and encodeURI() is that because this function
assumes that it is processing a URI component it treats the special separator characters (; / ? : @ & = + $ , #) as regular
text that should be encoded.
The following table shows all characters that are not converted to UTF-8 escape sequences by the encodeURIComponent function.
| Characters not encoded |
|---|
0 1 2 3 4 5 6 7 8 9 |
a b c d e f g h i j k l m n o p q r s t u v w x y z |
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
- _ . ! ~ * ' ( ) |
Parameters
uri:String — A string representing a complete URI.
|
String — A string with certain characters encoded as UTF-8 escape sequences.
|
See also
| escape | () | function |
function escape(str:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts the parameter to a string and encodes it in a URL-encoded format,
where most nonalphanumeric characters are replaced with % hexadecimal sequences.
When used in a URL-encoded string, the percentage symbol (%) is used to introduce
escape characters, and is not equivalent to the modulo operator (%).
The following table shows all characters that are not converted to escape sequences by the escape() function.
| Characters not encoded |
|---|
0 1 2 3 4 5 6 7 8 9 |
a b c d e f g h i j k l m n o p q r s t u v w x y z |
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
@ - _ . * + / |
Parameters
str:String — The expression to convert into a string and encode in a URL-encoded format.
|
String — A URL-encoded string.
|
See also
| int | () | function |
function int(value:Number):int| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts a given numeric value to an integer value. Decimal values are truncated at the decimal point.
Parameters
value:Number — A value to be converted to an integer.
|
int — The converted integer value.
|
See also
| isFinite | () | function |
function isFinite(num:Number):Boolean| Runtime Versions: | AIR 1.0, Flash Player 9 |
Returns true if the value is a finite number,
or false if the value is Infinity or -Infinity.
The presence of Infinity or -Infinity indicates a mathematical
error condition such as division by 0.
Parameters
num:Number — A number to evaluate as finite or infinite.
|
Boolean — Returns true if it is a finite number
or false if it is infinity or negative infinity.
|
| isNaN | () | function |
function isNaN(num:Number):Boolean| Runtime Versions: | AIR 1.0, Flash Player 9 |
Returns true if the value is NaN(not a number). The isNaN() function is useful for checking whether a mathematical expression evaluates successfully to a number. The NaN value is a special member of the Number data type that represents a value that is "not a number."
Note: The NaN value is not a member of the int or uint data types.
The following table describes the return value of isNaN() on various input types and values.
| Input Type/Value | Example | Return Value |
|---|---|---|
| 0 divided by 0 | isNaN(0/0) | true |
Non-zero number divided by 0 | isNaN(5/0) | false |
| Square root of a negative number | isNaN(Math.sqrt(-1)) | true |
| Arcsine of number greater than 1 or less than 0 | isNaN(Math.asin(2)) | true |
| String that can be converted to Number | isNaN("5") | false |
| String that cannot be converted to Number | isNaN("5a") | true |
Parameters
num:Number — A numeric value or mathematical expression to evaluate.
|
Boolean — Returns true if the value is NaN(not a number) and false otherwise.
|
| isXMLName | () | function |
function isXMLName(str:String):Boolean| Runtime Versions: | AIR 1.0, Flash Player 9 |
Determines whether the specified string is a valid name for an XML element or attribute.
Parameters
str:String — A string to evaluate.
|
Boolean — Returns true if the str argument is a valid XML name; false otherwise.
|
| Number | () | function |
function Number(expression:Object):Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts a given value to a Number value. The following table shows the result of various input types:
| Input Type/Value | Example | Return Value |
|---|---|---|
undefined | Number(undefined) | NaN |
null | Number(null) | 0 |
true | Number(true) | 1 |
false | Number(false) | 0 |
NaN | Number(NaN) | NaN |
| Empty string | Number("") | 0 |
| String that converts to Number | Number("5") | The number (e.g. 5) |
| String that does not convert to Number | Number("5a") | NaN |
Parameters
expression:Object — A value to be converted to a number.
|
Number — The converted number value.
|
| Object | () | function |
function Object(value:Object):Object| Runtime Versions: | AIR 1.0, Flash Player 9 |
Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value.
Parameters
value:Object — An object or a number, string, or Boolean value to convert.
|
Object — The value specified by the value parameter.
|
| parseFloat | () | function |
function parseFloat(str:String):Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts a string to a floating-point number. The function reads, or parses, and returns the numbers in a string until it reaches a character that is not a part of the initial number. If the string does not begin with a number that can be parsed, parseFloat() returns NaN. White space preceding valid integers is ignored, as are trailing nonnumeric characters.
Parameters
str:String — The string to read and convert to a floating-point number.
|
Number — A number or NaN (not a number).
|
| parseInt | () | function |
function parseInt(str:String, radix:uint = 0):Number| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts a string to an integer. If the specified string in the parameters cannot be converted to a number, the function returns NaN. Strings beginning with 0x are interpreted as hexadecimal numbers. Unlike in previous versions of ActionScript, integers beginning with 0 are not interpreted as octal numbers. You must specify a radix of 8 for octal numbers. White space and zeroes preceding valid integers are ignored, as are trailing nonnumeric characters.
Parameters
str:String — A string to convert to an integer.
| |
radix:uint (default = 0) — An integer representing the radix (base) of the number to parse. Legal values are from 2 to 36.
|
Number — A number or NaN (not a number).
|
| String | () | function |
function String(expression:Object):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Returns a string representation of the specified parameter.
The following table shows the result of various input types:
| Input Type/Value | Return Value |
|---|---|
undefined | undefined |
null | "null" |
true | "true" |
false | "false" |
NaN | "NaN" |
| String | String |
| Object | Object.toString() |
| Number | String representation of the number |
Parameters
expression:Object — An expression to convert to a string.
|
String — A string representation of the value passed for the expression parameter.
|
| trace | () | function |
function trace(... arguments):void| Runtime Versions: | AIR 1.0, Flash Player 9 |
Displays expressions, or writes to log files, while debugging. A single trace
statement can support multiple arguments. If any argument in a trace statement includes a data type
other than a String, the trace function invokes the associated toString() method for
that data type. For example, if the argument is a Boolean value the trace function invokes
Boolean.toString() and displays the return value.
Parameters
... arguments — One or more (comma separated) expressions to evaluate. For multiple expressions, a space is inserted between each expression in the output.
|
TraceExample to
show how the trace() method can be used to print a simple string. Generally,
the message will be printed to a "Debug" console.
<html>
<head>
<script src="AIRAliases.js" />
<script>
function init() {
air.trace("Hello World");
}
</script>
</head>
<body onclick='init()'>
</body>
</html>
| uint | () | function |
function uint(value:Number):uint| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts a given numeric value to an unsigned integer value. Decimal values are truncated at the decimal point.
The following table describes the return value of uint() on various input types and values.
| Input Type/Value | Example | Return Value |
|---|---|---|
undefined | uint(undefined) | 0 |
null | uint(null) | 0 |
0 | uint(0) | 0 |
NaN | uint(NaN) | 0 |
| Positive floating-point number | uint(5.31) | Truncated unsigned integer (e.g. 5) |
| Negative floating-point number | uint(-5.78) | Truncates to integer then applies rule for negative integers |
| Negative integer | uint(-5) | Sum of uint.MAX_VALUE and the negative integer (for example, uint.MAX_VALUE + (-5)) |
true | uint(true) | 1 |
false | uint(false) | 0 |
| Empty String | uint("") | 0 |
| String that converts to Number | uint("5") | The number |
| String that does not convert to Number | uint("5a") | 0 |
Parameters
value:Number — A value to be converted to an integer.
|
uint — The converted integer value.
|
See also
| unescape | () | function |
function unescape(str:String):String| Runtime Versions: | AIR 1.0, Flash Player 9 |
Evaluates the parameter str as a string, decodes the string from URL-encoded format
(converting all hexadecimal sequences to ASCII characters), and returns the string.
Parameters
str:String — A string with hexadecimal sequences to escape.
|
String — A string decoded from a URL-encoded parameter.
|
| XML | () | function |
function XML(expression:Object):XML| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts an object to an XML object.
The following table describes return values for various input types.
| Parameter Type | Return Value |
|---|---|
| Boolean | Value is first converted to a string, then converted to an XML object. |
| Null | A runtime error occurs (TypeError exception). |
| Number | Value is first converted to a string, then converted to an XML object. |
| Object | Converts to XML only if the value is a String, Number or Boolean value. Otherwise a runtime error occurs (TypeError exception). |
| String | Value is converted to XML. |
| Undefined | A runtime error occurs (TypeError exception). |
| XML | Input value is returned unchanged. |
| XMLList | Returns an XML object only if the XMLList object contains only one property of type XML. Otherwise a runtime error occurs (TypeError exception). |
Parameters
expression:Object — Object to be converted to XML.
|
XML — An XML object containing values held in the converted object.
|
See also
| XMLList | () | function |
function XMLList(expression:Object):XMLList| Runtime Versions: | AIR 1.0, Flash Player 9 |
Converts an object to an XMLList object.
The following table describes return values for various input types.
| Parameter Type | Return Value |
|---|---|
| Boolean | Value is first converted to a string, then converted to an XMLList object. |
| Null | A runtime error occurs (TypeError exception). |
| Number | Value is first converted to a string, then converted to an XMLList object. |
| Object | Converts to XMLList only if the value is a String, Number or Boolean value. Otherwise a runtime error occurs (TypeError exception). |
| String | Value is converted to an XMLList object. |
| Undefined | A runtime error occurs (TypeError exception). |
| XML | Value is converted to an XMLList object. |
| XMLList | Input value is returned unchanged. |
Parameters
expression:Object — Object to be converted into an XMLList object.
|
XMLList — An XMLList object containing values held in the converted object.
|
See also