ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
int

Package | Top Level
Class | public final class int
Inheritance | int Object

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The int class lets you work with the data type representing a 32-bit signed integer. The range of values represented by the int class is -2,147,483,648 (-2^31) to 2,147,483,647 (2^31-1).

The constant properties of the int class, `MAX_VALUE` and `MIN_VALUE`, are static, which means that you don't need an object to use them, so you don't need to use the constructor. The methods, however, are not static, which means that you do need an object to use them. You can create an int object by using the int class constructor or by declaring a variable of type int and assigning the variable a literal value.

The int data type is useful for loop counters and other situations where a floating point number is not needed, and is similar to the int data type in Java and C++. The default value of a variable typed as int is `0`

If you are working with numbers that exceed `int.MAX_VALUE`, consider using Number.

The following example calls the `toString()` method of the int class, which returns the string `1234`:

     var myint:int = 1234;
     myint.toString();

The following example assigns the value of the `MIN_VALUE` property to a variable declared without the use of the constructor:

     var smallest:int = int.MIN_VALUE;

View the examples

See also

uint
Number
Data type descriptions
Type conversions

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
|  | 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
--- | --- | ---
|  | int(num:Object) Constructor; creates a new int object. | int
|  | 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
|  | toExponential(fractionDigits:uint):String Returns a string representation of the number in exponential notation. | int
|  | toFixed(fractionDigits:uint):String Returns a string representation of the number in fixed-point notation. | int
|  | toPrecision(precision:uint):String Returns a string representation of the number either in exponential notation or in fixed-point notation. | int
|  | toString(radix:uint):String Returns the string representation of an int object. | int
|  | valueOf():int Returns the primitive value of the specified int object. | int

Public Constants

| Constant | Defined By
--- | --- | ---
|  | MAX_VALUE : int = 2147483647 [static] The largest representable 32-bit signed integer, which is 2,147,483,647. | int
|  | MIN_VALUE : int = -2147483648 [static] The smallest representable 32-bit signed integer, which is -2,147,483,648. | int

Constructor Detail

int | () | Constructor

`public function int(num:Object)`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Constructor; creates a new int object. You must use the int constructor when using `int.toString()` and `int.valueOf()`. You do not use a constructor when using the properties of an int object. The `new int` constructor is primarily used as a placeholder. An int object is not the same as the `int()` function that converts a parameter to a primitive value.

Parameters

| `num:Object` — The numeric value of the int object being created or a value to be converted to a number. The default value is 0 if `value` is not provided.

See also

int.toString()
int.valueOf()
Data type descriptions
Type conversions
Example
How to use examples
The following code constructs new int objects:

      var n1:int = new int(3.4);
      var n2:int = new int(-10);

Method Detail

toExponential | () | method

`AS3 function toExponential(fractionDigits:uint):String`

Returns a string representation of the number in exponential notation. The string contains one digit before the decimal point and up to 20 digits after the decimal point, as specified by the `fractionDigits` parameter.

Parameters

| `fractionDigits:uint` — An integer between 0 and 20, inclusive, that represents the desired number of decimal places.

Returns

| `String`

Throws

| `RangeError` — Throws an exception if the `fractionDigits` argument is outside the range 0 to 20.

Example
The following example shows how `toExponential(2)` returns a string in exponential notation.

    var num:Number = 315003;
    trace(num.toExponential(2)); // 3.15e+5

toFixed | () | method |

`AS3 function toFixed(fractionDigits:uint):String`

Returns a string representation of the number in fixed-point notation. Fixed-point notation means that the string will contain a specific number of digits after the decimal point, as specified in the `fractionDigits` parameter. The valid range for the `fractionDigits` parameter is from 0 to 20. Specifying a value outside this range throws an exception.

Parameters

| `fractionDigits:uint` — An integer between 0 and 20, inclusive, that represents the desired number of decimal places.

Returns

| `String`

Throws

| `RangeError` — Throws an exception if the `fractionDigits` argument is outside the range 0 to 20.

Example
The following example shows how `toFixed(3)` returns a string that rounds to three decimal places.

    var num:Number = 7.31343;
    trace(num.toFixed(3)); // 7.313

The following example shows how `toFixed(2)` returns a string that adds trailing zeroes.

    var num:Number = 4;
    trace(num.toFixed(2)); // 4.00

toPrecision | () | method |

`AS3 function toPrecision(precision:uint):String`

Returns a string representation of the number either in exponential notation or in fixed-point notation. The string will contain the number of digits specified in the `precision` parameter.

Parameters

| `precision:uint` — An integer between 1 and 21, inclusive, that represents the desired number of digits to represent in the resulting string.

Returns

| `String`

Throws

| `RangeError` — Throws an exception if the `precision` argument is outside the range 1 to 21.

Example
The following example shows how `toPrecision(3)` returns a string with only three digits. The string is in fixed-point notation because exponential notation is not required.

    var num:Number = 31.570;
    trace(num.toPrecision(3)); // 31.6

The following example shows how `toPrecision(3)` returns a string with only three digits. The string is in exponential notation because the resulting number does not contain enough digits for fixed-point notation.

    var num:Number = 4000;
    trace(num.toPrecision(3)); // 4.00e+3

toString | () | method |

`AS3 function toString(radix:uint):String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Returns the string representation of an `int` object.

Parameters

| `radix:uint` — Specifies the numeric base (from 2 to 36) to use for the number-to-string conversion. If you do not specify the `radix` parameter, the default value is 10.

Returns

| `String` — A string.

Example
How to use examples
The following example uses 2 and 8 for the `radix` parameter and returns a string that contains the corresponding representation of the number 9:

      var myint:int = new int(9);
      trace(myint.toString(2)); // 1001
      trace(myint.toString(8)); // 11

The following example results in a hexadecimal value.

      var r:int = new int(250);
      var g:int = new int(128);
      var b:int = new int(114);
      var rgb:String = "0x"+ r.toString(16)+g.toString(16)+b.toString(16);
      trace(rgb); // 0xfa8072

valueOf | () | method |

`AS3 function valueOf():int`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Returns the primitive value of the specified int object.

Returns

| `int` — An int value.

Example
How to use examples
The following example results in the primative value of the `numSocks` object.

      var numSocks:int = new int(2);
      trace(numSocks.valueOf()); // 2

Constant Detail

MAX_VALUE | Constant

`public static const MAX_VALUE:int = 2147483647`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The largest representable 32-bit signed integer, which is 2,147,483,647.

Example
How to use examples
The following ActionScript displays the largest and smallest representable int objects to the Output panel:

     trace("int.MIN_VALUE = "+int.MIN_VALUE);
     trace("int.MAX_VALUE = "+int.MAX_VALUE);

This code displays the following values:

     int.MIN_VALUE = -2147483648
     int.MAX_VALUE = 2147483647

MIN_VALUE | Constant |

`public static const MIN_VALUE:int = -2147483648`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The smallest representable 32-bit signed integer, which is -2,147,483,648.

Example
How to use examples
The following ActionScript displays the largest and smallest representable int objects to the Output panel:

         trace("int.MIN_VALUE = "+int.MIN_VALUE);
         trace("int.MAX_VALUE = "+int.MAX_VALUE);

This code displays the following values:

     int.MIN_VALUE = -2147483648
     int.MAX_VALUE = 2147483647

Examples How to use examples
IntExample.as
The following example uses the `IntExample` class to show how to work with and check the validity of int data types:

1. Two int variables `a` and `b` are declared in the constructor.
2. The two ints are added using the method `addIntegers()`.
3. A third int variable `c` is assigned the outcome of `parseInteger()`, which checks the validity of the string passed to it to ensure that it is an integer value in the acceptable range for int data types and returns an int equal to the integer value of the string if it is valid.
4. The int variables `a` and `c` are added together using `addIntegers()`.

    package {
        import flash.display.Sprite;

        public class IntExample extends Sprite {
            public function IntExample() {
                var a:int = 512;
                var b:int = -128;

                trace(addIntegers(a, b)); // 384

                var c:int = parseInteger("32");

                trace(addIntegers(a, c)); // 544
            }

            public function addIntegers(a:int, b:int):int {
                return a + b;
            }

            public function parseInteger(str:String):int {
                var num:Number = parseInt(str);
                if(!isNaN(num) && num <= int.MAX_VALUE && num >= int.MIN_VALUE) {
                    return int(num);
                }

                return 0;
            }

        }
    }

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00