MACROMEDIA FLASHLITE2 ACTIONSCRIPT-LANGUAGE Reference

Page 1

Flash lite 2.X actionscript language reference.

Page 3

3 contents chapter 1: actionscript language elements. . . . . . . . . . . . . . . . . 23 compiler directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 #endinitclip directive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ....

Page 5

Contents 5 _capsmaf property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 _capsms property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 _capstreamsound property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ...

Page 7

Contents 7 for statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196 for..In statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 function statement. . . . . . . . . . . . . . . . . . . . . . . . . ....

Page 9

Contents 9 ondragover (button.Ondragover handler) . . . . . . . . . . . . . . . . . . . 280 onkeydown (button.Onkeydown handler) . . . . . . . . . . . . . . . . . . . 280 onkeyup (button.Onkeyup handler) . . . . . . . . . . . . . . . . . . . . . . . . .281 onkillfocus (button.Onkillfocus handler) . ...

Page 11

Contents 11 getlocalelongdate (date.Getlocalelongdate method) . . . . . . 334 getlocaleshortdate (date.Getlocaleshortdate method). . . . . . 334 getlocaletime (date.Getlocaletime method). . . . . . . . . . . . . . . . 335 getmilliseconds (date.Getmilliseconds method). . . . . . . . . . . . . . . 335...

Page 13

Contents 13 loadvars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 addrequestheader (loadvars.Addrequestheader method) . . . . . . . . . . . . . . . . . . . 392 contenttype (loadvars.Contenttype property) . . . . . . . . . . . . . . . 394 d...

Page 15

Contents 15 hitarea (movieclip.Hitarea property). . . . . . . . . . . . . . . . . . . . . . . . . 480 hittest (movieclip.Hittest method) . . . . . . . . . . . . . . . . . . . . . . . . . . 480 linestyle (movieclip.Linestyle method) . . . . . . . . . . . . . . . . . . . . . . . 482 lineto (movieclip....

Page 17

Contents 17 registerclass (object.Registerclass method) . . . . . . . . . . . . . . . . . . 559 __resolve (object.__resolve property) . . . . . . . . . . . . . . . . . . . . . . . . 560 tostring (object.Tostring method) . . . . . . . . . . . . . . . . . . . . . . . . . . . 563 unwatch (object.Unwatc...

Page 19

Contents 19 _highquality (textfield._highquality property) . . . . . . . . . . . . . . . . . .661 hscroll (textfield.Hscroll property) . . . . . . . . . . . . . . . . . . . . . . . . . . .661 html (textfield.Html property). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662 htmltext (te...

Page 21

Contents 21 xmlnode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738 appendchild (xmlnode.Appendchild method) . . . . . . . . . . . . . . . 740 attributes (xmlnode.Attributes property) . . . . . . . . . . . . . . . . . . . . 742 childnodes (xml...

Page 23

23 1 chapter 1 actionscript language elements this section provides syntax, usage information, and code samples for global functions and properties (those elements that do not belong to an actionscript class); compiler directives; and for the constants, operators, statements, and keywords used in ac...

Page 25

Compiler directives 25 parameters [path]filename.As - filename.As the filename and optional path for the script to add to the actions panel or to the current script; .As is the recommended filename extension. Example the following examples show various ways of specifying a path for a file to be incl...

Page 27

Constants 27 constants a constant is a variable used to represent a property whose value never changes. This section describes global constants that are available to every script. Constants summary false constant a unique boolean value that represents the opposite of true . When automatic data typin...

Page 29

Constants 29 newline constant inserts a carriage return character ( \r ) that generates a blank line in text output generated by your code. Use newline to make space for information that is retrieved by a function or statement in your code. Availability: actionscript 1.0; flash lite 1.1 example the ...

Page 31

Constants 31 in files published for flash player 6 or earlier, the value of number(undefined) is 0 . In files published for flash player 7 or later, the value of number(undefined) is nan . The value undefined is similar to the special value null . When null and undefined are compared with the equali...

Page 33

Global functions 33 fscommand (command: string , parameters: string ) lets a swf file communicate with the flash lite player or the environment for a mobile device (such as an operating system). Fscommand2 (command: string , parameters: string ) lets the swf file communicate with the flash lite play...

Page 35

Global functions 35 mbchr (number: number ) deprecated since flash player 5. This function was deprecated in favor of the string.Fromcharcode() method. Converts an ascii code number to a multibyte character. Mblength (string: string ) : number deprecated since flash player 5. This function was depre...

Page 37

Global functions 37 stopdrag () stops the current drag operation. String (expression: object ) : string returns a string representation of the specified parameter. Substring (string: string , index: number , count: number ) : string deprecated since flash player 5. This function was deprecated in fa...

Page 39

Global functions 39 usage 3: the following example creates an array with three defined elements: var myarray:array = array("firstelement", "secondelement", "thirdelement"); trace (myarray); // traces firstelement,secondelement,thirdelement unlike the array class constructor, the array() function doe...

Page 41

Global functions 41 executes the script in the called frame without moving the playhead to that frame. Local variables do not exist after the script executes. ■ if variables are not declared inside a block ( {} ) but the action list was executed with a call() action, the variables are local and expi...

Page 43

Global functions 43 parameters target: object - the target path of the movie clip to duplicate. This parameter can be either a string (e.G. "my_mc") or a direct reference to the movie clip instance (e.G. My_mc). Parameters that can accept more than one data type are listed as type object . Newname: ...

Page 45

Global functions 45 in flash 5 or later, you cannot use eval() to dynamically set and retrieve the value of a variable or instance name, because you cannot use eval() on the left side of an equation. For example, replace the code eval ("var" + i) = "first"; with this: this["var"+i] = "first" or this...

Page 47

Global functions 47 fscommand2 function fscommand2(command:string, parameter1:string,...Parametern:string) : void lets the swf file communicate with the flash lite player or a host application on a mobile device. The fscommand2() function is similar to the fscommand() function, with the following di...

Page 49

Global functions 49 gettimer function gettimer() : number returns the number of milliseconds that have elapsed since the swf file started playing. Availability: actionscript 1.0; flash lite 1.0 returns number - the number of milliseconds that have elapsed since the swf file started playing. Example ...

Page 51

Global functions 51 getversion function getversion() : string returns a string containing flash player version and platform information. The getversion function returns information only for flash player 5 or later versions of flash player. Availability: actionscript 1.0; flash lite 2.0 returns strin...

Page 53

Global functions 53 example in the following example, a document has two scenes: sceneone and scenetwo . Scene one contains a frame label on frame 10 called newframe , and two buttons, mybtn_btn and myotherbtn_btn . This actionscript is placed on frame 1, scene 1 of the main timeline: stop(); mybtn_...

Page 55

Global functions 55 example the following example shows return values for isfinite : isfinite(56) // returns true isfinite(number.Positive_infinity) //returns false isnan function isnan(expression:object) : boolean evaluates the parameter and returns true if the value is nan (not a number). This fun...

Page 57

Global functions 57 loadmovie function loadmovie(url:string, target:object [, method:string]) : voidloadmovie(url:string, target:string [, method:string]) : void loads a swf or jpeg file into flash player while the original swf file plays. Jpeg files saved in progressive format are not supported. Ti...

Page 59

Global functions 59 normally, flash player displays a single swf file and then closes. The loadmovienum() action lets you display several swf files at once and switch among swf files without loading another html document. If you want to specify a target instead of a level, use loadmovie() instead of...

Page 61

Global functions 61 if you want to load variables into a specific level, use loadvariablesnum() instead of loadvariables() . Availability: actionscript 1.0; flash lite 1.1 - behavior changed in flash player 7. Parameters url: string - an absolute or relative url where the variables are located. If t...

Page 63

Global functions 63 method: string [optional] - specifies an http method for sending variables. The parameter must be the string get or post . If there are no variables to be sent, omit this parameter. The get method appends the variables to the end of the url and is used for small numbers of variab...

Page 65

Global functions 65 returns number - the converted character. See also charcodeat (string.Charcodeat method) mbsubstring function mbsubstring(value, index, count) : string deprecated since flash player 5. This function was deprecated in favor of string.Substr() method. Extracts a new multibyte chara...

Page 67

Global functions 67 example in the following example, when a user clicks the button that is created at runtime, the playhead is sent to frame 1 of the next scene. Create two scenes, and enter the following actionscript on frame 1 of scene 1. Stop(); if (init == undefined) { this.Createemptymovieclip...

Page 69

Global functions 69 object function object( [value] ) : object creates a new empty object or converts the specified number, string, or boolean value to an object. This command is equivalent to creating an object using the object constructor (see "constructor for the object class"). Availability: act...

Page 71

Global functions 71 example in the following script, the startdrag() function executes when the mouse is pressed, and the conditional script is executed when the mouse is released and the object is dropped: on (press) { startdrag(this); } on (release) { trace("x:"+this._x); trace("y:"+this._y); stop...

Page 73

Global functions 73 see also key , _xmouse (movieclip._xmouse property) , _ymouse (movieclip._ymouse property) , on handler ord function ord(character) : number deprecated since flash player 5. This function was deprecated in favor of the methods and properties of the string class. Converts characte...

Page 75

Global functions 75 the following example returns 4: parseint("4foo") the following example shows a hexadecimal conversion that returns 1016: parseint("0x3f8") the following example shows a hexadecimal conversion using the optional radix parameter that returns 1000: parseint("3e8", 16) the following...

Page 77

Global functions 77 returns number - a random integer. Example the following use of random() returns a value of 0, 1, 2, 3, or 4: random(5); see also random (math.Random method) removemovieclip function removemovieclip(target:object) deletes the specified movie clip. Availability: actionscript 1.0; ...

Page 79

Global functions 79 example usage 1: the following example calls an anonymous function every 1000 milliseconds (1 second). Setinterval( function(){ trace("interval called"); }, 1000 ); usage 2: the following example defines two event handlers and calls each of them. The first call to setinterval() c...

Page 81

Global functions 81 then create a file called user.As in the same directory as your fla file. Enter the following actionscript: class user { var intervalid:number; var username:string; function user(param_username:string) { trace("welcome, "+param_username); this.Username = param_username; this.Inte...

Page 83

Global functions 83 see also stopdrag function , _droptarget (movieclip._droptarget property) , startdrag (movieclip.Startdrag method) stop function stop() : void stops the swf file that is currently playing. The most common use of this action is to control movie clips with buttons. Availability: ac...

Page 85

Global functions 85 string function string(expression:object) : string returns a string representation of the specified parameter, as described in the following list: ■ if expression is a number, the return string is a text representation of the number. ■ if expression is a string, the return string...

Page 87

Global functions 87 returns string - a string containing the target path of the specified object. Example the following example traces the target path of a movie clip as soon as it loads: this.Createemptymovieclip("myclip_mc", this.Getnexthighestdepth()); trace(targetpath(myclip_mc)); // _level0.Myc...

Page 89

Global functions 89 example the following code could be applied to a button that, when clicked, would toggle anti- aliasing on and off: on(release) { togglehighquality(); } see also _quality property trace function trace(expression:object) you can use flash debug player to capture output from the tr...

Page 91

Global functions 91 unloadmovie function unloadmovie(target:movieclip) : void unloadmovie(target:string) : void removes a movie clip that was loaded by means of loadmovie() from flash player. To unload a movie clip that was loaded by means of loadmovienum() , use unloadmovienum() instead of unloadmo...

Page 93

Global properties 93 _capcompoundsound deprecated since flash lite player 2.0. This action was deprecated in favor of the system.Capabilities.Hascompoundsound property. Indicates whether flash lite can process compound sound data. _capemail deprecated since flash lite player 2.0. This action was dep...

Page 95

Global properties 95 $version property $version deprecated since flash lite player 2.0. This action was deprecated in favor of the system.Capabilities.Version property. String variable; contains the version number of flash lite. It contains a major number, minor number, build number, and an internal...

Page 97

Global properties 97 numeric variable; indicates whether flash lite can process compound sound data. If so, this variable is defined and has a value of 1; if not, this variable is undefined. For example, a single flash file can contain the same sound represented in both midi and mfi formats. The pla...

Page 99

Global properties 99 example if the device can play mfi sound data, the following example sets canmfi to 1 : canmfi = _capmfi; if (canmfi == 1) { // send movieclip buttons to frame with buttons that trigger events sounds telltarget("buttons") { gotoandplay(2); } } _capmidi property _capmidi deprecat...

Page 101

Global properties 101 example the following example sets cansmaf to 1 in flash lite 1.1, but leaves it undefined in flash lite 1.0 (however, not all flash lite 1.1 phones can send smaf messages, so this code is still dependent on the phone): cansmaf = _capsmaf; if (cansmaf) { // send movieclip butto...

Page 103

Global properties 103 if the global _focusrect property is set to false , the default behavior for all buttons and movieclips is that keyboard navigation is limited to the tab key. All other keys, including the enter and arrow keys, are ignored. To restore full keyboard navigation, you must set _foc...

Page 105

Global properties 105 _highquality property _highquality deprecated since flash player 5. This property was deprecated in favor of _quality . Specifies the level of anti-aliasing applied to the current swf file. Specify 2 (best quality) to apply the best quality. Specify 1 (high quality) to apply an...

Page 107

Global properties 107 example in the following example, there is a movie clip on the stage with the instance name square_mc . Within that movie clip is another movie clip with an instance name circle_mc . The following actionscript lets you modify the circle_mc parent instance (which is square_mc ) ...

Page 109

Global properties 109 deprecated since flash player 5. This property was deprecated in favor of textfield.Scroll . Controls the display of information in a text field associated with a variable. The scroll property defines where the text field begins displaying content; after you set it, flash playe...

Page 111

Global properties 111 because this is evaluated in the context of the script that contains it, you can't use this in a script to refer to a variable defined in a class file. Create applythis.As, and enter the following code: class applythis { var str:string = "defined in applythis.As"; function conc...

Page 113

Operators 113 = ( assignment ) assigns the value of expression2 (the parameter on the right) to the variable, array element, or property in expression1 . & ( bitwise and ) converts expression1 and expression2 to 32-bit unsigned integers, and performs a boolean and operation on each bit of the intege...

Page 115

Operators 115 gt ( greater than (strings) ) deprecated since flash player 5. This operator was deprecated in favor of the > (greater than) operator. Compares the string representation of expression1 with the string representation of expression2 and returns true if expression1 is greater than express...

Page 117

Operators 117 + addition operator expression1 + expression2 adds numeric expressions or concatenates (combines) strings. If one expression is a string, all other expressions are converted to strings and concatenated. If both expressions are integers, the sum is an integer; if either or both expressi...

Page 119

Operators 119 usage 3: variables associated with dynamic and input text fields have the data type string. In the following example, the variable deposit is an input text field on the stage. After a user enters a deposit amount, the script attempts to add deposit to oldbalance . However, because depo...

Page 121

Operators 121 var my_array:array = new array(); my_array[0] = 15; my_array[1] = "hello"; my_array[2] = true; you can use brackets ([]) to add a fourth element, as shown in the following example: my_array[3] = "george"; you can use brackets ([]) to access an element in a multidimensional array. The f...

Page 123

Operators 123 = assignment operator expression1 = expression2 assigns the value of expression2 (the parameter on the right) to the variable, array element, or property in expression1 . Assignment can be either by value or by reference. Assignment by value copies the actual value of expression2 and s...

Page 125

Operators 125 note: the behavior of this operator is different for flash lite, depending on the version. For example, flash lite 2.0 supports the and ( & ) operator as a bitwise and. To concatenate strings in flash lite 2.0, you must use the addition ( + ) operator. However, flash lite 1.X supports ...

Page 127

Operators 127 floating-point numbers are converted to integers by discarding any digits after the decimal point. Positive integers are converted to an unsigned hex value with a maximum value of 4294967295 or 0xffffffff; values larger than the maximum have their most significant digits discarded when...

Page 129

Operators 129 in hexadecimal, this is 0x8888. Therefore, ~0x7777 is 0x8888. The most common use of bitwise operators is for representing flag bits (boolean values packed into 1 bit each). Floating-point numbers are converted to integers by discarding any digits after the decimal point. Positive inte...

Page 133

Operators 133 the following example converts -1 to a 32-bit integer and shifts it 1 bit to the right: var x:number = -1 >> 1; trace(x); // outputs -1 the following example shows the result of the previous example: var x:number = -1; this is because -1 decimal equals 11111111111111111111111111111111 ...

Page 135

Operators 135 this is because -1 decimal is 11111111111111111111111111111111 binary (thirty-two 1s), and when you shift right (unsigned) by 1 bit, the least significant (rightmost) bit is discarded, and the most significant (leftmost) bit is filled with a 0. The result is 011111111111111111111111111...

Page 137

Operators 137 ^= bitwise xor assignment operator expression1 ^= expression2 assigns expression1 the value of expression1 ^ expression2 . For example, the following two statements are equivalent: x ^= y x = x ^ y availability: actionscript 1.0; flash lite 2.0 operands expression1 : number - integers ...

Page 139

Operators 139 operands expression1 : number - an expression to be evaluated. Expression2 : number - an expression to be evaluated. Expressionn : number - any number of additional expressions to be evaluated. Returns object - the value of expression1 , expression2 , and so on. Example the following e...

Page 141

Operators 141 ?: conditional operator expression1 ? Expression2 : expression3 instructs flash to evaluate expression1 , and if the value of expression1 is true , it returns the value of expression2 ; otherwise it returns the value of expression3 . Availability: actionscript 1.0; flash lite 1.0 opera...

Page 143

Operators 143 operands expression : number - a number or a variable that evaluates to a number. Returns number - the floating-point result of the operation. Example the following statement divides the current width and height of the stage, and then displays the result in the output panel. Trace(stag...

Page 145

Operators 145 the following example creates a new movie clip within the _root scope. Then a text field is created inside the movie clip called container_mc . The text field's autosize property is set to true and then populated with the current date. This.Createemptymovieclip("container_mc", this.Get...

Page 147

Operators 147 compares two expressions for equality and returns a value of true if the string representation of expression1 is equal to the string representation of expression2 , false otherwise. Availability: actionscript 1.0; flash lite 1.0 operands expression1 : object - numbers, strings, or vari...

Page 149

Operators 149 availability: actionscript 1.0; flash lite 1.0 - in flash 4, >= is a numeric operator. In flash 5 or later, the greater than or equal to ( >= ) operator is a comparison operator capable of handling various data types. Flash 4 files that are brought into the flash 5 or later authoring e...

Page 151

Operators 151 example the following example uses ++ as a post-increment operator to make a while loop run five times: var i:number = 0; while (i++ trace("this is execution " + i); } /* output: this is execution 1 this is execution 2 this is execution 3 this is execution 4 this is execution 5 */ the ...

Page 153

Operators 153 the following example illustrates the use of the inequality ( != ) operator in an if statement: var a:string = "david"; var b:string = "fool"; if (a != b) { trace("david is not a fool"); } the following example illustrates comparison by reference with two functions: var a:function = fu...

Page 155

Operators 155 returns boolean - if object is an instance of or a subclass of classconstructor , instanceof returns true , otherwise it returns false . Also, _global instanceof object returns false . See also typeof operator expression1 expression2 compares two expressions and determines whether expr...

Page 157

Operators 157 availability: actionscript 1.0; flash lite 1.0 - in flash 4, is a numeric operator. In flash 5 or later, the less than or equal to ( ) operator is a comparison operator capable of handling various data types. Flash 4 files that are brought into the flash 5 or later authoring environmen...

Page 159

Operators 159 performs a boolean operation on the values of one or both of the expressions. Evaluates expression1 (the expression on the left side of the operator) and returns false if the expression evaluates to false . If expression1 evaluates to true , expression2 (the expression on the right sid...

Page 161

Operators 161 example in the following example, the variable happy is set to false . The if condition evaluates the condition !Happy , and if the condition is true , the trace() statement sends a string to the output panel. Var happy:boolean = false; if (!Happy) { trace("don't worry, be happy"); //t...

Page 163

Operators 163 the following example demonstrates how using a function call as expression2 can lead to unexpected results. If the expression on the left of the operator evaluates to true , that result is returned without evaluating the expression on the right (the function fx2() is not called). Funct...

Page 165

Operators 165 availability: actionscript 1.0; flash lite 1.0 - in flash 4 files, the % operator is expanded in the swf file as x - int(x/y) * y and may not be as fast or as accurate in later versions of flash player. Operands expression1 : number - a number or expression that evaluates to a number. ...

Page 167

Operators 167 new operator new constructor() creates a new, initially anonymous, object and calls the function identified by the constructor parameter. The new operator passes to the function any optional parameters in parentheses, as well as the newly created object, which is referenced using the k...

Page 169

Operators 169 the following example creates an object account and initializes the properties name , address , city , state , zip , and balance with accompanying values: var account:object = {name:"macromedia, inc.", address:"600 townsend street", city:"san francisco", state:"california", zip:"94103"...

Page 171

Operators 171 see also with statement === strict equality operator expression1 === expression2 tests two expressions for equality; the strict equality ( === )operator performs in the same way as the equality ( == ) operator, except that data types are not converted. The result is true if both expres...

Page 173

Operators 173 !== strict inequality operator expression1 !== expression2 tests for the exact opposite of the strict equality ( === )operator. The strict inequality operator performs the same as the inequality operator except that data types are not converted. If expression1 is equal to expression2 ,...

Page 175

Operators 175 availability: actionscript 1.0; flash lite 1.0 operands expression1 : number - a number or expression that evaluates to a number. Expression2 : number - a number or expression that evaluates to a number. Returns number - an integer or floating-point number. Example usage 1: the followi...

Page 177

Operators 177 example usage 1: the following example declares a public variable named username whose type is string and assigns an empty string to it: var username:string = ""; usage 2: the following example shows how to specify a function's parameter type by defining a function named randomint() th...

Page 179

Statements 179 class defines a custom class, which lets you instantiate objects that share methods and properties that you define. Continue jumps past all remaining statements in the innermost loop and starts the next iteration of the loop as if control had passed through to the end of the loop norm...

Page 181

Statements 181 example the following example uses the break statement to exit an otherwise infinite loop: var i:number = 0; while (true) { trace(i); if (i >= 10) { break; // this will terminate/exit the loop } i++; } which traces the following output: 0 1 2 3 4 5 6 7 8 9 10 see also for statement ca...

Page 183

Statements 183 the name of the class must match the name of the external file that contains the class. The name of the external file must be the name of the class with the file extension .As appended. For example, if you name a class student, the file that defines the class must be named student.As....

Page 185

Statements 185 in an external script file or in the actions panel, use the new operator to create an imageloader object. Var jakob_mc:movieclip = this.Createemptymovieclip("jakob_mc", this.Getnexthighestdepth()); var jakob:imageloader = new imageloader("http://www.Helpexamples.Com/flash/ images/imag...

Page 187

Statements 187 example in the following example, the expression a does not equal the expressions b or d, so the statement following the default keyword is run and the trace() statement is sent to the output panel. Var dayofweek:number = new date().Getday(); switch (dayofweek) { case 1 : trace("monda...

Page 189

Statements 189 usage 4: the following example shows the behavior of delete on object references: var ref1:object = new object(); ref1.Name = "jody"; // copy the reference variable into a new variable // and delete ref1 ref2 = ref1; delete ref1; trace("ref1.Name "+ref1.Name); //output: ref1.Name unde...

Page 191

Statements 191 example in the following example, class person2 has not yet been marked as dynamic, so calling an undeclared function on it generates an error at compile time: class person2 { var name:string; var age:number; function person2(param_name:string, param_age:number) { trace ("anything"); ...

Page 193

Statements 193 parameters condition: boolean - an expression that evaluates to true or false . Example the following example uses else if statements to compare score_txt to a specified value: if (score_txt.Text>90) { trace("a"); } else if (score_txt.Text>75) { trace("b"); } else if (score_txt.Text>6...

Page 195

Statements 195 the following example instantiates a car object, calls a method defined in the vehicle class ( start() ), then calls the method overridden by the car class ( stop() ), and finally calls a method from the car class ( activatecaralarm() ): var mynewcar:car = new car(2, "red", true); myn...

Page 197

Statements 197 for..In statement for (variableiterant in object) { ] statement(s); } iterates over the properties of an object or elements in an array and executes the statement for each property or element. Methods of an object are not enumerated by the for..In action. Some properties cannot be enu...

Page 199

Statements 199 you can use this statement to define a function with the specified functionname , parameters , and statement(s) . When a script calls a function, the statements in the function's definition are executed. Forward referencing is permitted; within the same script, a function may be decla...

Page 201

Statements 201 enter the following actionscript in a frame on the timeline: var giants:team = new team("san fran", "sfo"); trace(giants.Name); giants.Name = "san francisco"; trace(giants.Name); /* output: san fran san francisco */ when you trace giants.Name, you use the get method to return the valu...

Page 203

Statements 203 import statement import classname import packagename.* note: to use this keyword, you must specify actionscript 2.0 and flash player 6 or later in the flash tab of your fla file's publish settings dialog box. This statement is supported in the actions panel as well as in external clas...

Page 205

Statements 205 interface ib { function o():void; } class d implements ia, ib { function k():number { return 15; } function n(x:number):number { return x * x; } function o():void { trace("o"); } } // external script or actions panel // script file mvar = new d(); trace(mvar.K()); // 15 trace(mvar.N(7...

Page 207

Statements 207 return math.Pi*this.Radius*this.Radius; }; this.Getdiameter = function() { return 2*this.Radius; }; this.Setradius = function(param_radius) { this.Radius = param_radius; } } // actionscript 2.0 code that uses the circle class var mycircle:circle = new circle(5); trace(mycircle.Getarea...

Page 209

Statements 209 specifies that a variable or function is available to any caller. Because variables and functions are public by default, this keyword is used primarily for stylistic reasons. For example, you might want to use it for reasons of consistency in a block of code that also contains private...

Page 211

Statements 211 example the following example creates a login class that demonstrates how the set keyword can be used to set private variables: class login { private var loginusername:string; private var loginpassword:string; public function login(param_username:string, param_password:string) { this....

Page 213

Statements 213 see also var statement static statement class someclassname{ static var name; static function name() { // your statements here } } note: to use this keyword, you must specify actionscript 2.0 and flash player 6 or later in the flash tab of your fla file's publish settings dialog box. ...

Page 215

Statements 215 switch statement switch (expression){caseclause: [defaultclause:] } creates a branching structure for actionscript statements. As with the if statement, the switch statement tests a condition and executes statements if the condition returns a value of true . All switch statements shou...

Page 217

Statements 217 in a fla or as file, enter the following actionscript in frame 1 of the timeline: import invalidemailaddress; function checkemail(email:string) { if (email.Indexof("@") == -1) { throw new invalidemailaddress(); } } try { checkemail("joe smith"); } catch (e) { this.Createtextfield("err...

Page 219

Statements 219 in the following example, the finally block is used to delete an actionscript object, regardless of whether an error occurred. Create a new as file called account.As. Class account { var balance:number = 1000; function getaccountinfo():number { return (math.Round(math.Random() * 10) %...

Page 221

Statements 221 finally, in another as file or fla script, the following code invokes the sortrows() method on an instance of the recordset class. It defines catch blocks for each type of error that is thrown by sortrows() import recordset; var myrecordset:recordset = new recordset(); try { myrecords...

Page 223

Statements 223 parameters condition: boolean - an expression that evaluates to true or false . Example in the following example, the while statement is used to test an expression. When the value of i is less than 20, the value of i is traced. When the condition is no longer true , the loop exits. Va...

Page 225

Fscommand2 commands 225 the with statement is useful for accessing multiple items in a scope chain list simultaneously. In the following example, the built-in math object is placed at the front of the scope chain. Setting math as a default object resolves the identifiers cos , sin , and pi to math.C...

Page 227

Fscommand2 commands 227 extendbacklightduration fscommand2 command extendbacklightduration extends the duration of a backlight for a specified period of time. If the duration is greater than zero, this command specifies the amount of time in seconds (maximum of 60 seconds) that the backlight should ...

Page 229

Fscommand2 commands 229 some sample results and the devices they signify follow: d506i a mitsubishi 506i phone. Dfoma1 a mitsubishi foma1 phone. F506i a fujitsu 506i phone. Ffoma1 a fujitsu foma1 phone. N506i an nec 506i phone. Nfoma1 an nec foma1 phone. Nokia3650 a nokia 3650 phone. P506i a panason...

Page 231

Fscommand2 commands 231 getmaxvolumelevel fscommand2 command getmaxvolumelevel returns the maximum volume level of the device as a numeric value. Availability: actionscript 1.0; flash lite 1.1 example the following example sets the maxvolume variable to the maximum volume level of the device: maxvol...

Page 233

Fscommand2 commands 233 getnetworkgeneration fscommand2 command getnetworkgeneration returns the generation of the current mobile wireless network, such as 2g (second generation of mobile wireless). Availability: actionscript 1.0; flash lite 2.0 example the following example shows syntax for returni...

Page 235

Fscommand2 commands 235 case 2: _root.Mytext += "pending request, contacting network" + ""; break; case 3: _root.Mytext += "pending request, resolving domain" + ""; break; case 4: _root.Mytext += "failed, network error" + ""; break; case 5: _root.Mytext += "failed, couldn't reach server" + "...

Page 237

Fscommand2 commands 237 getpowersource fscommand2 command getpowersource returns a value that indicates whether the power source is currently supplied from a battery or from an external power source. Availability: actionscript 1.0; flash lite 1.1 example the following example sets the mypower variab...

Page 239

Fscommand2 commands 239 quit fscommand2 command quit causes the flash lite player to stop playback and exit. This command is supported only when flash lite is running in stand-alone mode. It is not supported when the player is running in the context of another application (for example, as a plug-in ...

Page 241

Fscommand2 commands 241 the following table shows what effect each mode has, and what modes are substituted: availability: actionscript 1.0; flash lite 1.1 example the following line of code sets the input text type of the field associated with the input1 variable to receive numeric data: status = f...

Page 243

Fscommand2 commands 243 startvibrate fscommand2 command startvibrate starts the phone's vibration feature. If a vibration is already occurring, flash lite stops that vibration before starting the new one. Vibrations also stop when playback of the flash application is stopped or paused, and when the ...

Page 245

245 2 chapter 2 actionscript classes documentation for actionscript classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners that belong to a specific class in actionscript (as opposed to global functions or properties). The classes are l...

Page 248

248 actionscript classes the array class should not be used to create associative arrays, which are different data structures that contain named elements instead of numbered elements. You should use the object class to create associative arrays (also called hashes). Although actionscript permits you...

Page 250

250 actionscript classes method summary modifiers signature description concat ([value: object ]) : array concatenates the elements specified in the parameters with the elements in an array and creates a new array. Join ([delimiter: string ]) : string converts the elements in an array to strings, in...

Page 252

252 actionscript classes if (my_array[0] == undefined) { // no quotation marks around undefined. Trace("undefined is a special value, not a string"); } // traces: undefined is a special value, not a string. Usage 3: the following example creates the new array object go_gos_array with an initial leng...

Page 254

254 actionscript classes descending (array.Descending property) public static descending : number represents a descending sort order. You can use this constant for the options parameter in the sort() or sorton() method. The value of this constant is 2. Availability: actionscript 1.0; flash lite 2.0 ...

Page 256

256 actionscript classes my_array.Length = 5; trace(my_array.Length); // my_array.Length is updated to 5 trace(my_array); // outputs: a,b,undefined,undefined,undefined numeric (array.Numeric property) public static numeric : number represents numeric sorting instead of string-based sorting. String-b...

Page 258

258 actionscript classes reverse (array.Reverse method) public reverse() : void reverses the array in place. Availability: actionscript 1.0; flash lite 2.0 example the following example uses this method to reverse the array numbers_array : var numbers_array:array = new array(1, 2, 3, 4, 5, 6); trace...

Page 260

260 actionscript classes sort (array.Sort method) public sort([comparefunction: object ], [options: number ]) : array sorts the elements in an array. Flash sorts according to unicode values. (ascii is a subset of unicode.) by default, array . Sort() works as described in the following list: ■ sortin...

Page 262

262 actionscript classes } } trace("unsorted:"); //displays unsorted: trace(passwords_array); //displays mom:glam,ana:ring,jay:mag,anne:home,regina:silly. //writes mom:glam,ana:ring,jay:mag,anne:home,regina:silly passwords_array.Sort(order); trace("sorted:"); //displays sorted: trace(passwords_array...

Page 264

264 actionscript classes var rec_array:array = new array(); rec_array.Push({name: "john", city: "omaha", zip: 68144}); rec_array.Push({name: "john", city: "kansas city", zip: 72345}); rec_array.Push({name: "bob", city: "omaha", zip: 94010}); for(i=0; i trace(rec_array[i].Name + ", " + rec_array[i].C...

Page 267

Array 267 tostring (array.Tostring method) public tostring() : string returns a string value representing the elements in the specified array object. Every element in the array, starting with index 0 and ending with the highest index, is converted to a concatenated string and separated by commas. To...

Page 269

Boolean 269 property summary properties inherited from class object constructor summary method summary methods inherited from class object boolean constructor public boolean([value: object ]) creates a boolean object. If you omit the value parameter, the boolean object is initialized with a value of...

Page 272

272 actionscript classes property summary modifiers property description _alpha : number the alpha transparency value of the button specified by my_btn. Enabled : boolean a boolean value that specifies whether a button is enabled. _focusrect : boolean a boolean value that specifies whether a button ...

Page 274

274 actionscript classes method summary methods inherited from class object _alpha (button._alpha property) public _alpha : number the alpha transparency value of the button specified by my_btn . Valid values are 0 (fully transparent) to 100 (fully opaque). The default value is 100. Objects in a but...

Page 276

276 actionscript classes _focusrect (button._focusrect property) public _focusrect : boolean a boolean value that specifies whether a button has a yellow rectangle around it when it has input focus. This property can override the global _focusrect property. By default, the _focusrect property of a b...

Page 278

278 actionscript classes _height (button._height property) public _height : number the height of the button, in pixels. Availability: actionscript 1.0; flash lite 2.0 example the following example sets the height and width of a button called my_btn to a specified width and height. My_btn._width = 50...

Page 280

280 actionscript classes ondragover (button.Ondragover handler) ondragover = function() {} invoked when the user presses the mouse button outside of the button and then drags the pointer over the button. You must define a function that is executed when the event handler is invoked. Note: the ondrago...

Page 282

282 actionscript classes example in the following example, a function that sends text to the output panel is defined for the onkeydown handler . Create a button called my_btn on the stage, and enter the following actionscript in a frame on the timeline: my_btn.Onkeydown = function() { trace("onkeydo...

Page 284

284 actionscript classes example in the following example, a function that sends a trace() statement to the output panel is defined for the onrelease handler: my_btn.Onrelease = function () { trace ("onrelease called"); }; onreleaseoutside (button.Onreleaseoutside handler) onreleaseoutside = functio...

Page 286

286 actionscript classes example the following example demonstrates how you can execute statements when the user of a swf file moves focus from one button to another. Create two buttons, btn1_btn and btn2_btn , and enter the following actionscript in frame 1 of the timeline: selection.Setfocus(btn1_...

Page 288

288 actionscript classes example the following example rotates two buttons on the stage. Create two buttons on the stage called control_btn and my_btn . Make sure that my_btn is not perfectly round, so you can see it rotating. Then enter the following actionscript in frame 1 of the timeline: var con...

Page 290

290 actionscript classes the tabindex property may be a non-negative integer. The objects are ordered according to their tabindex properties, in ascending order. An object with a tabindex value of 1 precedes an object with a tabindex value of 2 . If two objects have the same tabindex value, the one ...

Page 292

292 actionscript classes example the following example demonstrates how to track two buttons as a menu. Place two button instances called one_btn and two_btn on the stage. Enter the following actionscript in the timeline: var one_btn:button; var two_btn:button; one_btn.Trackasmenu = true; two_btn.Tr...

Page 294

294 actionscript classes see also _width (movieclip._width property) _x (button._x property) public _x : number an integer that sets the x coordinate of a button relative to the local coordinates of the parent movie clip. If a button is on the main timeline, then its coordinate system refers to the ...

Page 296

296 actionscript classes example the following example scales a button called my_btn. When you click and release the button, it grows 10% on the x and y axis. Enter the following actionscript in frame 1 of the timeline: my_btn.Onrelease = function(){ this._xscale ~= 1.1; this._yscale ~= 1.1; }; see ...

Page 298

298 actionscript classes _yscale (button._yscale property) public _yscale : number the vertical scale of the button as applied from the registration point of the button, expressed as a percentage. The default registration point is (0,0). Availability: actionscript 1.0; flash lite 2.0 example the fol...

Page 300

300 actionscript classes property summary modifiers property description static audiomimetypes : array [read-only] returns an array of mime types for audio codecs supported by a mobile device. Static avhardwaredisable : boolean [read-only] a boolean value that specifies whether access to the user's ...

Page 302

302 actionscript classes static hasscreenplayback : boolean [read-only] a boolean value that is true if the player supports the playback of screen broadcast applications that are being run through flash media server; false otherwise. Static hassharedobjects : boolean [read-only] returns true if the ...

Page 304

304 actionscript classes method summary methods inherited from class object audiomimetypes (capabilities.Audiomimetypes property) public static audiomimetypes : array [read-only] returns an array of mime types for audio codecs supported by a mobile device. Availability: actionscript 1.0; flash lite ...

Page 306

306 actionscript classes example the following example traces the value of this read-only property: trace(system.Capabilities.Hasaudio); hasaudioencoder (capabilities.Hasaudioencoder property) public static hasaudioencoder : boolean [read-only] specifies if the flash player can encode an audio strea...

Page 308

308 actionscript classes availability: actionscript 1.0; flash lite 2.0 example the following example traces the value of this read-only property: trace(system.Capabilities.Hasemail); hasembeddedvideo (capabilities.Hasembeddedvideo property) public static hasembeddedvideo : boolean [read-only] a boo...

Page 310

310 actionscript classes example the following example traces the value of this read-only property: trace(system.Capabilities.Hasmouse); hasmp3 (capabilities.Hasmp3 property) public static hasmp3 : boolean [read-only] specifies if the mobile device has a mp3 decoder. A boolean value that is true if ...

Page 312

312 actionscript classes otherwise, this property returns false . Availability: actionscript 1.0; flash lite 2.0 example the following example traces the value of this read-only property: trace(system.Capabilities.Hassharedobjects); hassmaf (capabilities.Hassmaf property) public static hassmaf : boo...

Page 314

314 actionscript classes specifies if the flash player can encode a video stream. A boolean value that is true if the player can encode a video stream, such as that coming from a web camera; false otherwise. The server string is ve . Note: for flash lite 2.0, the value returned is always false . Ava...

Page 316

316 actionscript classes availability: actionscript 1.0; flash lite 2.0 example the following example traces the value of this read-only property: trace(system.Capabilities.Language); localfilereaddisable (capabilities.Localfilereaddisable property) public static localfilereaddisable : boolean [read...

Page 318

318 actionscript classes example the following example traces the value of this read-only property: trace(system.Capabilities.Screenorientation); screenresolutionx (capabilities.Screenresolutionx property) public static screenresolutionx : number [read-only] an integer that indicates the maximum hor...

Page 320

320 actionscript classes property summary properties inherited from class object constructor summary method summary methods inherited from class object color constructor public color(target: object ) creates a color object for the movie clip specified by the target_mc parameter. You can then use the...

Page 322

322 actionscript classes returns object - an object whose properties contain the current offset and percentage values for the specified color. Example the following example gets the transform object, and then sets new percentages for colors and alpha of my_mc relative to their current values. To see...

Page 324

324 actionscript classes example this example creates a new color object for a target swf file, creates a generic object called mycolortransform with the properties defined above, and uses the settransform() method to pass the colortransformobject to a color object. To use this code in a flash (fla)...

Page 326

326 actionscript classes method summary modifiers signature description getdate () : number returns the day of the month (an integer from 1 to 31) of the specified date object according to local time. Getday () : number returns the day of the week (0 for sunday, 1 for monday, and so on) of the speci...

Page 328

328 actionscript classes getyear () : number returns the year of the specified date object, according to local time. Setdate (date: number ) : number sets the day of the month for the specified date object, according to local time, and returns the new time in milliseconds. Setfullyear (year: number ...

Page 330

330 actionscript classes date constructor public date([yearortimevalue: number ], [month: number ], [date: number ], [hour: number ], [minute: number ], [second: number ], [millisecond: number ]) constructs a new date object that holds the specified date and time. The date() constructor takes up to ...

Page 332

332 actionscript classes example the following example creates a new date object and concatenates the returned values of date.Getmonth() , date.Getdate() , and date.Getfullyear(): var today_date:date = new date(); var date_str:string = (today_date.Getdate()+"/ "+(today_date.Getmonth()+1)+"/"+today_d...

Page 334

334 actionscript classes getlocalelongdate (date.Getlocalelongdate method) public getlocalelongdate() : string returns a string representing the current date, in long form, formatted according to the currently defined locale. Note: the format of the date depends on the mobile device and the locale. ...

Page 336

336 actionscript classes returns number - an integer. Example the following example uses the constructor to create a date object based on the current time and uses the getmilliseconds() method to return the milliseconds value from that object: var my_date:date = new date(); trace(my_date.Getmillisec...

Page 338

338 actionscript classes availability: actionscript 1.0; flash lite 2.0 returns number - an integer. Example the following example uses the constructor to create a date object based on the current time, and uses the gettime() method to return the number of milliseconds since midnight january 1, 1970...

Page 340

340 actionscript classes getutcfullyear (date.Getutcfullyear method) public getutcfullyear() : number returns the four-digit year of the specified date object, according to universal time. Availability: actionscript 1.0; flash lite 2.0 returns number - an integer. Example the following example creat...

Page 342

342 actionscript classes returns number - an integer. Example the following example creates a new date object and uses getutcminutes() to return the minutes value from the date object: var today_date:date = new date(); trace(today_date.Getutcminutes()); getutcmonth (date.Getutcmonth method) public g...

Page 344

344 actionscript classes returns number - an integer. Example the following example creates a date object with the month and year set to may 2004. The date.Getyear() method returns 104, and date.Getfullyear() returns 2004: var today_date:date = new date(2004,4); trace(today_date.Getyear()); // outpu...

Page 346

346 actionscript classes sethours (date.Sethours method) public sethours(hour: number ) : number sets the hours for the specified date object according to local time and returns the new time in milliseconds. Local time is determined by the operating system on which flash player is running. Availabil...

Page 348

348 actionscript classes parameters month: number - an integer from 0 (january) to 11 (december). Date: number [optional] - an integer from 1 to 31. If you omit this parameter, the date field of the specified date object will not be modified. Returns number - an integer. Example the following exampl...

Page 350

350 actionscript classes returns number - an integer. Example the following example initially creates a new date object with today's date, uses date.Setutcdate() to change the date value to 10, and changes it again to 25: var my_date:date = new date(); my_date.Setutcdate(10); trace(my_date.Getutcdat...

Page 352

352 actionscript classes example the following example initially creates a new date object with today's date, uses date.Setutchours() to change the time to 8:30 a.M., and changes the time again to 5:30:47 p.M.: var my_date:date = new date(); my_date.Setutchours(8,30); trace(my_date.Getutchours()); /...

Page 354

354 actionscript classes parameters month: number - an integer from 0 (january) to 11 (december). Date: number [optional] - an integer from 1 to 31. If you omit this parameter, the date field of the specified date object will not be modified. Returns number - an integer. Example the following exampl...

Page 356

356 actionscript classes tostring (date.Tostring method) public tostring() : string returns a string value for the specified date object in a readable format. Availability: actionscript 1.0; flash lite 2.0 returns string - a string. Example the following example returns the information in the dateof...

Page 358

358 actionscript classes property summary properties inherited from class object constructor summary method summary methods inherited from class object modifiers property description message : string contains the message associated with the error object. Name : string contains the name of the error ...

Page 360

360 actionscript classes example in the following example, a function throws a specified message depending on the parameters entered into thenum . If two numbers can be divided, success and the number are shown. Specific errors are shown if you try to divide by 0 or enter only 1 parameter: function ...

Page 363

Extendedkey 363 see also getcode (key.Getcode method) property summary properties inherited from class object method summary methods inherited from class object modifiers property description static soft1 : string the key code value for the soft1 soft key. Static soft10 : string the key code value f...

Page 365

Extendedkey 365 soft2 (extendedkey.Soft2 property) public static soft2 : string the key code value for the soft2 soft key. The soft2 key code always corresponds to the right soft key; the soft1 key code always corresponds to the left soft key. Availability: actionscript 2.0; flash lite 2.0 see also ...

Page 367

Function 367 method summary methods inherited from class object apply (function.Apply method) public apply(thisobject: object , [argarray: array ]) specifies the value of thisobject to be used within any function that actionscript calls. This method also specifies the parameters to be passed to any ...

Page 369

Function 369 see also call (function.Call method) call (function.Call method) public call(thisobject: object , [parameter1: object ]) invokes the function represented by a function object. Every function in actionscript is represented by a function object, so all functions support this method. In al...

Page 371

Key 371 property summary properties inherited from class object event summary modifiers property description static backspace : number the key code value for the backspace key (8). Static capslock : number the key code value for the caps lock key (20). Static control : number the key code value for ...

Page 373

Key 373 example the following example creates a new listener object and defines a function for onkeydown and onkeyup . The last line uses addlistener() to register the listener with the key object so that it can receive notification from the key down and key up events. Var mylistener:object = new ob...

Page 375

key.Isdown(key.Backspace)) { canvas_mc.Clear(); } }; key.Addlistener(keylistener); when using this example, make sure that you select control > disable keyboard shortcuts in the test environment. Down (key.Down property) p...

Page 377

Key 377 when using this example, make sure that you select control > disable keyboard shortcuts in the test environment. Escape (key.Escape property) public static escape : number the key code value for the escape key (27). Availability: actionscript 1.0; flash lite 2.0 example the following example...

Page 379

Key 379 example the following example calls the getcode() method any time a key is pressed. The example creates a listener object named keylistener and defines a function that responds to the onkeydown event by calling key.Getcode() . The keylistener object is then registered to the key object, whic...

Page 381

Key 381 example the following example creates a new listener object and defines a function for onkeydown . The last line uses addlistener() to register the listener with the key object so that it can receive notification from the key down event and display information in the output panel. Var keylis...

Page 383

Key 383 _listeners (key._listeners property) public static _listeners : array [read-only] a list of references to all listener objects registered with the key object. This property is intended for internal use, but may be useful if you want to ascertain the number of listeners currently registered w...

Page 385

Key 385 pgup (key.Pgup property) public static pgup : number the key code value for the page up key (33). Availability: actionscript 1.0; flash lite 2.0 example the following example rotates a movie clip called car_mc when you press the page down and page up keys. Var keylistener:object = new object...

Page 387

Key 387 break; case key.Right : car_mc._x += distance; break; case key.Down : car_mc._y += distance; break; } }; key.Addlistener(keylistener_obj); shift (key.Shift property) public static shift : number the key code value for the shift key (16). Availability: actionscript 1.0; flash lite 2.0 example...

Page 389

Key 389 date_txt.Text = today_date.Tostring(); } }; key.Addlistener(keylistener); when using this example, make sure that you select control > disable keyboard shortcuts in the test environment. Up (key.Up property) public static up : number the key code value for the up arrow key (38). Availability...

Page 392

392 actionscript classes method summary methods inherited from class object addrequestheader (loadvars.Addrequestheader method) public addrequestheader(header: object , headervalue: string ) : void modifiers signature description addrequestheader (header: object , headervalue: string ) : void adds o...

Page 394

394 actionscript classes contenttype (loadvars.Contenttype property) public contenttype : string the mime type that is sent to the server when you call loadvars.Send() or loadvars.Sendandload() . The default is application/x-www-form-urlencoded. Availability: actionscript 1.0; flash lite 2.0 example...

Page 396

396 actionscript classes trace("an error occurred while loading variables."); } }; my_lv.Load("[place a valid url pointing to a text file here]"); see also load (loadvars.Load method) , sendandload (loadvars.Sendandload method) getbytestotal (loadvars.Getbytestotal method) public getbytestotal() : n...

Page 398

398 actionscript classes parameters url: string - a string; the url from which to download the variables. If the swf file issuing this call is running in a web browser, url must be in the same domain as the swf file; for details, see the description section. Returns boolean - false if no parameter (...

Page 400

400 actionscript classes ondata (loadvars.Ondata handler) ondata = function(src: string ) {} invoked when data has completely downloaded from the server or when an error occurs while data is downloading from a server. This handler is invoked before the data is parsed and can be used to call a custom...

Page 402

402 actionscript classes to view a more robust example, see the login.Fla file in the actionscript samples folder. Typical paths to the actionscript samples folder are: ■ windows: boot drive\program files\macromedia\flash 8\samples and tutorials\samples\actionscript ■ macintosh: macintosh hd/applica...

Page 404

404 actionscript classes sendandload (loadvars.Sendandload method) public sendandload(url: string , target: object , [method: string ]) : boolean posts variables in the my_lv object to the specified url. The server response is downloaded, parsed as variable data, and the resulting variables are plac...

Page 406

406 actionscript classes returns string - a string. Example the following example instantiates a new loadvars() object, creates two properties, and uses tostring() to return a string containing both properties in url encoded format: var my_lv:loadvars = new loadvars(); my_lv.Name = "gary"; my_lv.Age...

Page 408

408 actionscript classes adddelayedinstance (locale.Adddelayedinstance method) public static adddelayedinstance(instance: object , stringid: string ) add the {instance, string id} pair into the internal array for later use. This is primarily used by flash when the strings replacement method is "auto...

Page 410

410 actionscript classes parameters langcode: string - a string representing a language code. Setloadcallback (locale.Setloadcallback method) public static setloadcallback(loadcallback: function ) set the callback function that will be called after the xml file is loaded. Availability: actionscript ...

Page 412

412 actionscript classes method summary modifiers signature description static abs (x: number ) : number computes and returns an absolute value for the number specified by the parameter x. Static acos (x: number ) : number computes and returns the arc cosine of the number specified in the parameter ...

Page 414

414 actionscript classes acos (math.Acos method) public static acos(x: number ) : number computes and returns the arc cosine of the number specified in the parameter x , in radians. Availability: actionscript 1.0; flash lite 2.0 - in flash player 4, the methods and properties of the math class are e...

Page 416

416 actionscript classes atan2 (math.Atan2 method) public static atan2(y: number , x: number ) : number computes and returns the angle of the point y / x in radians, when measured counterclockwise from a circle's x axis (where 0,0 represents the center of the circle). The return value is between pos...

Page 418

418 actionscript classes see also acos (math.Acos method) , asin (math.Asin method) , atan (math.Atan method) , atan2 (math.Atan2 method) , sin (math.Sin method) , tan (math.Tan method) e (math.E property) public static e : number a mathematical constant for the base of natural logarithms, expressed...

Page 420

420 actionscript classes ln10 (math.Ln10 property) public static ln10 : number a mathematical constant for the natural logarithm of 10, expressed as loge10, with an approximate value of 2.302585092994046. Availability: actionscript 1.0; flash lite 2.0 - in flash player 4, the methods and properties ...

Page 422

422 actionscript classes max (math.Max method) public static max(x: number , y: number ) : number evaluates x and y and returns the larger value. Availability: actionscript 1.0; flash lite 2.0 - in flash player 4, the methods and properties of the math class are emulated using approximations and mig...

Page 424

424 actionscript classes mc.Curveto(r+x, -math.Tan(math.Pi/8)*r+y, r+x, y); } pow (math.Pow method) public static pow(x: number , y: number ) : number computes and returns x to the power of y . Availability: actionscript 1.0; flash lite 2.0 - in flash player 4, the methods and properties of the math...

Page 426

426 actionscript classes example the following example returns a random number between two specified integers. Function randrange(min:number, max:number):number { var randomnum:number = math.Round(math.Random() * (max-min+1) + (min- .5)); return randomnum; } for (var i = 0; i trace(randrange(4, 11))...

Page 428

428 actionscript classes example the following example uses math.Pow and math.Sqrt to calculate the length of a line. This.Createemptymovieclip("canvas_mc", this.Getnexthighestdepth()); var mouselistener:object = new object(); mouselistener.Onmousedown = function() { this.Origx = _xmouse; this.Origy...

Page 430

430 actionscript classes example the following example draws a circle using the mathematical constant pi, the tangent of an angle, and the drawing api. Drawcircle(this, 100, 100, 50); // function drawcircle(mc:movieclip, x:number, y:number, r:number):void { mc.Linestyle(2, 0xff0000, 100); mc.Moveto(...

Page 432

432 actionscript classes addlistener (mouse.Addlistener method) public static addlistener(listener: object ) : void registers an object to receive notifications of the onmousedown , onmousemove , and onmouseup listeners. The listener parameter should contain an object that has a defined method for a...

Page 434

434 actionscript classes example the following example uses the drawing api to draw a rectangle when the user presses the mouse button, moves the mouse, and then releases the mouse button at runtime. This.Createemptymovieclip("canvas_mc", this.Getnexthighestdepth()); var mouselistener:object = new o...

Page 436

436 actionscript classes the following example sets the x and y positions of the pointer_mc movie clip instance to the x and y pointer positions. The device must support a stylus or mouse for this example to work. To use the example, you create a movie clip and set its linkage identifier to pointer_...

Page 438

438 actionscript classes example the following example attaches three buttons to the stage, and lets the user draw lines in the swf file at runtime, using the mouse pointer. One button clears all of the lines from the swf file. The second button removes the mouse listener so the user cannot draw lin...

Page 441

Movieclip 441 _rotation : number specifies the rotation of the movie clip, in degrees, from its original orientation. _soundbuftime : number specifies the number of seconds a sound prebuffers before it starts to stream. Tabchildren : boolean determines whether the children of a movie clip are includ...

Page 443

Movieclip 443 onreleaseoutside = function() {} invoked when the mouse button is pressed inside the movie clip area and then released outside the movie clip area. Onrollout = function() {} invoked when the pointer moves outside a movie clip area. Onrollover = function() {} invoked when the pointer mo...

Page 445

Movieclip 445 getbytesloaded () : number returns the number of bytes that have already loaded (streamed) for the movie clip. Getbytestotal () : number returns the size, in bytes, of the movie clip. Getdepth () : number returns the depth of the movie clip instance. Getinstanceatdepth (depth: number )...

Page 447

Movieclip 447 methods inherited from class object _alpha (movieclip._alpha property) public _alpha : number the alpha transparency value of the movie clip. Valid values are 0 (fully transparent) to 100 (fully opaque). The default value is 100. Objects in a movie clip with _alpha set to 0 are active,...

Page 449

Movieclip 449 initobject: object [optional] - (supported for flash player 6 and later) an object containing properties with which to populate the newly attached movie clip. This parameter allows dynamically created movie clips to receive clip parameters. If initobject is not an object, it is ignored...

Page 451

Movieclip 451 parameters filltype: string - either the string " linear " or the string " radial ". Colors: array - an array of rgb hex color values to be used in the gradient (for example, red is 0xff0000, blue is 0x0000ff, and so on). Alphas: array - an array of alpha values for the corresponding c...

Page 453

Movieclip 453 this code draws the following image on the screen: see also beginfill (movieclip.Beginfill method) , endfill (movieclip.Endfill method) , linestyle (movieclip.Linestyle method) , lineto (movieclip.Lineto method) , moveto (movieclip.Moveto method) clear (movieclip.Clear method) public c...

Page 455

Movieclip 455 createtextfield (movieclip.Createtextfield method) public createtextfield(instancename: string , depth: number , x: number , y: number , width: number , height: number ) : textfield creates a new, empty text field as a child of the movie clip on which you call this method. You can use ...

Page 457

Movieclip 457 an example is also in the animations.Fla file in the actionscript samples folder. The following list gives typical paths to this folder: ■ windows: windows: boot drive\program files\macromedia\flash 8\samples and tutorials\samples\actionscript ■ macintosh: macintosh hd/applications/mac...

Page 459

Movieclip 459 the following script uses the curveto() method and the math class to create a circle: this.Createemptymovieclip("circle2_mc", 2); circle2_mc.Linestyle(0, 0x000000); drawcircle(circle2_mc, 100, 100, 100); function drawcircle(mc:movieclip, x:number, y:number, r:number):void { mc.Moveto(x...

Page 461

Movieclip 461 duplicatemovieclip (movieclip.Duplicatemovieclip method) public duplicatemovieclip(name: string , depth: number , [initobject: object ]) : movieclip creates an instance of the specified movie clip while the swf file is playing. Duplicated movie clips always start playing at frame 1, no...

Page 463

Movieclip 463 the enabled property only governs the button-like properties of a movie clip. You can change the enabled property at any time; the modified movie clip is immediately enabled or disabled. The enabled property can be read out of a prototype object. If enabled is set to false , the object...

Page 465

Movieclip 465 example this example demonstrates how to hide the yellow rectangle around a specified movie clip instance in a swf file when the instance has focus in a browser window. Create three movie clips called mc1_mc , mc2_mc , and mc3_mc , and add the following actionscript to frame 1 of the t...

Page 467

Movieclip 467 example the following example creates a movie clip called square_mc . The code draws a square for that movie clip and uses movieclip.Getbounds() to display the coordinate values of the instance in the output panel. This.Createemptymovieclip("square_mc", 1); square_mc._x = 10; square_mc...

Page 469

Movieclip 469 enter the following actionscript in frame 1 of the timeline: var pctloaded:number = math.Round(this.Getbytesloaded()/ this.Getbytestotal()*100); bar_mc._xscale = pctloaded; add the following code to frame 2: if (this._framesloaded this.Gotoandplay(1); } else { this.Gotoandstop(3); } pl...

Page 471

Movieclip 471 see also attachmovie (movieclip.Attachmovie method) , duplicatemovieclip (movieclip.Duplicatemovieclip method) , createemptymovieclip (movieclip.Createemptymovieclip method) , getdepth (movieclip.Getdepth method) , getnexthighestdepth (movieclip.Getnexthighestdepth method) , swapdepths...

Page 473

Movieclip 473 returns number - an integer that specifies the flash player version that was targeted when the swf file loaded into the movie clip was published. Example the following example creates a new container and outputs the value of getswfversion() . It then uses moviecliploader to load an ext...

Page 475

Movieclip 475 you must first create a generic object that has two properties, x and y. These x and y values (and they must be called x and y) are called the global coordinates because they relate to the top-left corner of the stage. The x property represents the horizontal offset from the top-left c...

Page 477

Movieclip 477 gotoandplay (movieclip.Gotoandplay method) public gotoandplay(frame: object ) : void starts playing the swf file at the specified frame. To specify a scene as well as a frame, use gotoandplay() . You can extend the methods and event handlers of the movieclip class by creating a subclas...

Page 479

Movieclip 479 example the following code example displays the height and width of a movie clip in the output panel: this.Createemptymovieclip("image_mc", this.Getnexthighestdepth()); var image_mcl:moviecliploader = new moviecliploader(); var mcllistener:object = new object(); mcllistener.Onloadinit ...

Page 481

Movieclip 481 usage 2: evaluates the bounding boxes of the target and specified instance, and returns true if they overlap or intersect at any point. Parameters x: number the x coordinate of the hit area on the stage. Y: number the y coordinate of the hit area on the stage. The x and y coordinates a...

Page 483

Movieclip 483 see also beginfill (movieclip.Beginfill method) , begingradientfill (movieclip.Begingradientfill method) , clear (movieclip.Clear method) , curveto (movieclip.Curveto method) , lineto (movieclip.Lineto method) , moveto (movieclip.Moveto method) lineto (movieclip.Lineto method) public l...

Page 485

Movieclip 485 parameters url: string - the absolute or relative url of the swf or jpeg file to be loaded. A relative path must be relative to the swf file at level 0. Absolute urls must include the protocol reference, such as http:// or file:/// . Method: string [optional] - specifies an http method...

Page 487

Movieclip 487 example the following example loads information from a text file called params.Txtinto the target_mc movie clip that is created by using createemptymovieclip() . The setinterval() function is used to check the loading progress. The script checks for a variable in the params.Txt file na...

Page 489

Movieclip 489 parameters pt: object - the name or identifier of an object created with the object class, specifying the x and y coordinates as properties. Example the following example converts x and y coordinates of the my_mc object, from the movie clip's (local) coordinates to the stage (global) c...

Page 491

Movieclip 491 the lockroot.Swf file has _ lockroot applied to it, and nolockroot.Swf does not. After the files are loaded, each file dumps variables from their _root scopes. Place the following actionscript on the main timeline of a fla document: this.Createemptymovieclip("lockroot_mc", this.Getnext...

Page 493

Movieclip 493 example the following example draws a triangle with a 5-pixel, solid magenta line and a partially transparent blue fill: this.Createemptymovieclip("triangle_mc", 1); triangle_mc.Beginfill(0x0000ff, 30); triangle_mc.Linestyle(5, 0xff00ff, 100); triangle_mc.Moveto(200, 200); triangle_mc....

Page 495

Movieclip 495 the last function uses onclipevent(data). The onclipevent() event handler is invoked for any movie clip that receives data, whether the movie clip is in the library or not. Therefore, the last function in this example is invoked when symbol_mc is instantiated and also when replacement....

Page 497

Movieclip 497 you must define a function that executes when the event handler is invoked. You can define the function on the timeline or in a class file that extends the movieclip class or that is linked to a symbol in the library. Availability: actionscript 1.0; flash lite 2.0 example the following...

Page 499

Movieclip 499 the following example sets input focus: my_mc.Focusenabled = true; selection.Setfocus(my_mc); see also getascii (key.Getascii method) , getcode (key.Getcode method) , focusenabled (movieclip.Focusenabled property) , setfocus (selection.Setfocus method) , onkeydown (key.Onkeydown event ...

Page 501

Movieclip 501 onmousedown (movieclip.Onmousedown handler) onmousedown = function() {} invoked when the mouse button is pressed. You must define a function that executes when the event handler is invoked. You can define the function on the timeline or in a class file that extends the movieclip class ...

Page 503

Movieclip 503 example the following example defines a function for the onrelease method that sends a trace() action to the output panel: my_mc.Onrelease = function () { trace ("onrelease called"); } onreleaseoutside (movieclip.Onreleaseoutside handler) onreleaseoutside = function() {} invoked when t...

Page 505

Movieclip 505 example the following example displays information about the movie clip that receives input focus, and the instance that previously had focus. Two movie clips, called my_mc and other_mc are on the stage. Add the following actionscript to your as or fla document: my_mc.Onrelease = void;...

Page 507

Movieclip 507 use the following actionscript to play the timeline of a movie clip in a swf file. This actionscript is for a button called my_btn on the main timeline that plays a movie clip called animation_mc : animation_mc.Stop(); my_btn.Onrelease = function(){ animation_mc.Play(); }; see also pla...

Page 509

Movieclip 509 removemovieclip (movieclip.Removemovieclip method) public removemovieclip() : void removes a movie clip instance created with duplicatemovieclip() , movieclip.Duplicatemovieclip() , movieclip.Createemptymovieclip() , or movieclip.Attachmovie() . This method does not remove a movie clip...

Page 511

Movieclip 511 example the following example creates a triangle movie clip instance dynamically. When you run the swf file, click the movie clip to rotate it: this.Createemptymovieclip("triangle", this.Getnexthighestdepth()); triangle.Beginfill(0x0000ff, 100); triangle.Moveto(100, 100); triangle.Line...

Page 513

Movieclip 513 left: number [optional] - value relative to the coordinates of the movie clip's parent that specify a constraint rectangle for the movie clip. Top: number [optional] - value relative to the coordinates of the movie clip's parent that specify a constraint rectangle for the movie clip. R...

Page 515

Movieclip 515 see also _droptarget (movieclip._droptarget property) , startdrag (movieclip.Startdrag method) , stopdrag function swapdepths (movieclip.Swapdepths method) public swapdepths(target: object ) : void swaps the stacking, or depth level (z-order), of this movie clip with the movie clip spe...

Page 517

Movieclip 517 tabenabled (movieclip.Tabenabled property) public tabenabled : boolean specifies whether the movie clip is included in automatic tab ordering. It is undefined by default. If the tabenabled property is undefined , the object is included in automatic tab ordering only if it defines at le...

Page 519

Movieclip 519 _totalframes (movieclip._totalframes property) public _totalframes : number [read-only] returns the total number of frames in the movie clip instance specified in the movieclip parameter. Availability: actionscript 1.0; flash lite 2.0 example in the following example, two movie clip bu...

Page 521

Movieclip 521 example the following example unloads a movie clip instance called box when a user clicks the box movie clip: this.Createemptymovieclip("box", 1); with (box) { linestyle(1, 0xcccccc); beginfill(0x4827cf); moveto(0, 0); lineto(80, 0); lineto(80, 60); lineto(0, 60); lineto(0, 0); endfill...

Page 523

Movieclip 523 _width (movieclip._width property) public _width : number the width of the movie clip, in pixels. Availability: actionscript 1.0; flash lite 2.0 - as a read-only property. Example the following code example displays the height and width of a movie clip in the output panel: this.Createe...

Page 525

Movieclip 525 example the following example creates a movie clip called box_mc at runtime. The drawing api is used to draw a box in this instance, and when the mouse rolls over the box, horizontal and vertical scaling is applied to the movie clip. When the mouse rolls off the instance, it returns to...

Page 527

Movieclip 527 see also mouse , _xmouse (movieclip._xmouse property) _yscale (movieclip._yscale property) public _yscale : number sets the vertical scale ( percentage ) of the movie clip as applied from the registration point of the movie clip. The default registration point is (0,0). Scaling the loc...

Page 530

530 actionscript classes method summary methods inherited from class object addlistener (moviecliploader.Addlistener method) public addlistener(listener: object ) : boolean registers an object to receive notification when a moviecliploader event handler is invoked. Availability: actionscript 1.0; fl...

Page 532

532 actionscript classes getprogress (moviecliploader.Getprogress method) public getprogress(target: object ) : object returns the number of bytes loaded and total number of bytes for a file that is being loaded by using moviecliploader.Loadclip() ; for compressed movies, the getprogress method refl...

Page 534

534 actionscript classes you can use the loadclip() method to load one or more files into a single movie clip or level; moviecliploader listener objects are passed to the loading target movie clip instance as a parameter. Alternatively, you can create a different moviecliploader object for each file...

Page 536

536 actionscript classes when you use the onloadcomplete and onloadinit events with the moviecliploader class, it's important to understand how this differs from the way they work with your swf file. The onloadcomplete event is called after the swf or jpeg file is loaded, but before the application ...

Page 538

538 actionscript classes var image_mcl:moviecliploader = new moviecliploader(); image_mcl.Addlistener(mcllistener); image_mcl.Loadclip("http://www.Fakedomain.Com/images/bad_hair_day.Jpg", image_mc); see also addlistener (moviecliploader.Addlistener method) , loadclip (moviecliploader.Loadclip method...

Page 540

540 actionscript classes parameters target_mc: movieclip [optional] a movie clip loaded by a moviecliploader.Loadclip() method. Loadedbytes: number the number of bytes that had been loaded when the listener was invoked. Totalbytes: number the total number of bytes in the file being loaded. Availabil...

Page 542

542 actionscript classes see also addlistener (moviecliploader.Addlistener method) , loadclip (moviecliploader.Loadclip method) , onloaderror (moviecliploader.Onloaderror event listener) , onloadinit (moviecliploader.Onloadinit event listener) , onloadcomplete (moviecliploader.Onloadcomplete event l...

Page 544

544 actionscript classes example the following example loads an image into a movie clip called image_mc . If you click the movie clip, the movie clip is removed and information is displayed in the output panel. This.Createemptymovieclip("image_mc", this.Getnexthighestdepth()); var mcllistener:object...

Page 546

546 actionscript classes method summary methods inherited from class object max_value (number.Max_value property) public static max_value : number the largest representable number (double-precision ieee-754). This number is approximately 1.79e+308. Availability: actionscript 1.0; flash lite 2.0 exam...

Page 548

548 actionscript classes number constructor public number(num: object ) creates a new number object. The new number constructor is primarily used as a placeholder. A number object is not the same as the number() function that converts a parameter to a primitive value. Availability: actionscript 1.0;...

Page 550

550 actionscript classes object object public class object the object class is at the root of the actionscript class hierarchy. This class contains a small subset of the features provided by the javascript object class. Availability: actionscript 1.0; flash lite 2.0 - (became a native object in flas...

Page 552

552 actionscript classes if invoked incorrectly, object.Addproperty() can fail with an error. The following table describes errors that can occur: availability: actionscript 1.0; flash lite 2.0 - in actionscript 2.0 classes, you can use get or set instead of this method. Parameters name: string - a ...

Page 554

554 actionscript classes the following example shows how to use the implicit getter and setter functions available in actionscript 2.0. Rather than defining the book function and editing book.Prototype , you define the book class in an external file named book.As. The following code must be in a sep...

Page 556

556 actionscript classes properties that you create are enumerable, but built-in properties are generally not enumerable. Availability: actionscript 1.0; flash lite 2.0 parameters name: string - returns boolean - a boolean value: true if the property specified by the name parameter is enumerable. Ex...

Page 558

558 actionscript classes the following trace statements show that the __proto_ property of both instances refers to the prototype property of the circle class. Trace(circle.Prototype == onecircle.__proto__); // output: true trace(circle.Prototype == twocircle.__proto__); // output: true see also pro...

Page 560

560 actionscript classes parameters name: string - string; the linkage identifier of the movie clip symbol or the string identifier for the actionscript class. Theclass: function - a reference to the constructor function of the actionscript class or null to unregister the symbol. Returns boolean - a...

Page 562

562 actionscript classes this.Myfunction(name); }; // create a new object method and assign it the reference this[name] = f; // return the reference return f; }; // test __resolve using undefined method names // __resolve will only be called once for each method name myobject.Somemethod(); // calls ...

Page 564

564 actionscript classes example this example shows the return value for tostring() on a generic object: var myobject:object = new object(); trace(myobject.Tostring()); // output: [object object] this method can be overridden to return a more meaningful value. The following examples show that this m...

Page 566

566 actionscript classes example the following example shows the return value of valueof() for a generic object (which does not have a primitive value) and compares it to the return value of tostring(). First, create a generic object. Second, create a new date object set to february 1, 2004, 8:15 am...

Page 568

568 actionscript classes userdata: object [optional] - an arbitrary piece of actionscript data that is passed to the callback method. If the userdata parameter is omitted, undefined is passed to the callback method. Returns boolean - a boolean value: true if the watchpoint is created successfully, f...

Page 571

Security (system.Security) 571 also, for files running in flash player 7 or later, you can't use this method to let swf files hosted using a secure protocol (https) allow access from swf files hosted in nonsecure protocols; you must use system.Security.Allowinsecuredomain() instead. Occasionally, yo...

Page 573

Security (system.Security) 573 example in the following example, you host a math test on a secure domain so that only registered students can access it. You have also developed a number of swf files that illustrate certain concepts, which you host on an insecure domain. You want students to access t...

Page 575

Selection 575 a policy file obtained from the old default location--/crossdomain.Xml on an http server on port 80—implicitly authorizes access to all ports 1024 and above. There is no way to retrieve a policy file to authorize xmlsocket operations from any other location on an http server; any custo...

Page 577

Selection 577 example in the following example, you create two input text fields at runtime, setting the borders for each text field to true . This code creates a new (generic) actionscript object named focuslistener . This object defines for itself an onsetfocus property, to which it assigns a func...

Page 579

Selection 579 parameters oldfocus: [optional] - the object losing focus. Newfocus: [optional] - the object receiving focus. Example the following example demonstrates how to determine when input focus changes in a swf file between several dynamically created text fields. Enter the following actionsc...

Page 581

Selection 581 setfocus (selection.Setfocus method) public static setfocus(newfocus: object ) : boolean gives focus to the selectable (editable) text field, button, or movie clip, specified by the newfocus parameter. You can use dot or slash notation to specify the path. You can also use a relative o...

Page 583

Sharedobject 583 the following examples describe the potential of using shared objects: ■ a flash application can be used as a user interface for a service that enables the user to search used car listings. The application connects to a server that provides listings of cars based on the search terms...

Page 585

Sharedobject 585 property summary properties inherited from class object event summary modifiers property description data : object the collection of attributes assigned to the data property of the object. Constructor (object.Constructor property) , __proto__ (object.__proto__ property) , prototype ...

Page 587

Sharedobject 587 availability: actionscript 2.0; flash lite 2.0 parameters objectname: string - a string that represents the name of the shared object. Notifyfunction: function - the name of a function the player calls to notify the application that the getlocal() method has executed and the data is...

Page 589

Sharedobject 589 the shared object contains the following data: favoritesong: my world is blue favoritenightclub: the bluenote tavern favoritecolor: blue data: [object object] availability: actionscript 1.0; flash lite 2.0 example the following example saves text to a shared object named my_so (for ...

Page 591

Sharedobject 591 getlocal (sharedobject.Getlocal method) public static getlocal(name: string ) : sharedobject returns a reference to a locally persistent shared object that is available only to the current client. If the shared object does not already exist, getlocal() creates one. This method is a ...

Page 593

Sharedobject 593 if the shared object listener has not yet been called, getsize() returns 0. For details about using the listener, see the addlistener() method. Availability: actionscript 1.0; flash lite 2.0 returns number - a numeric value specifying the size of the shared object, in bytes. Example...

Page 595

Sound 595 var flushresult = my_so.Flush(1000001); switch (flushresult) { case 'pending' : message_txt.Text = "flush is pending, waiting on user interaction."; break; case true : message_txt.Text = "flush was successful. Requested storage space approved."; break; case false : message_txt.Text = "flus...

Page 597

Sound 597 method summary modifiers signature description attachsound (id: string ) : void attaches the sound specified in the id parameter to the specified sound object. Getbytesloaded () : number returns the number of bytes loaded (streamed) for the specified sound object. Getbytestotal () : number...

Page 599

Sound 599 example the following example loads a sound and displays the duration of the sound file in the output panel. Add the following actionscript to your fla or as file. Var my_sound:sound = new sound(); my_sound.Onload = function(success:boolean) { var totalseconds:number = this.Duration/1000; ...

Page 601

Sound 601 example the following example dynamically creates two text fields that display the bytes that are loaded and the total number of bytes for a sound file that loads into the swf file. A text field also displays a message when the file finishes loading. Add the following actionscript to your ...

Page 603

Sound 603 you can use the following example to start the device sound. Because flash lite does not support streaming sound, it is a good practice to load the sound before playing it. Var my_sound:sound = new sound(); my_sound.Onload = function(success) { if (success) { my_sound.Start(); } else { out...

Page 605

Sound 605 function pressknob() { this.Startdrag(false, this.Left, this.Top, this.Right, this.Bottom); } function releaseknob() { this.Stopdrag(); updatetransformtxt(); } function updatetransformtxt() { var ll_num:number = 30+100-knob_ll._y; var lr_num:number = 30+100-knob_lr._y; var rl_num:number = ...

Page 607

Sound 607 see also setvolume (sound.Setvolume method) id3 (sound.Id3 property) public id3 : object [read-only] provides access to the metadata that is part of an mp3 file. Mp3 sound files can contain id3 tags, which provide metadata about the file. If an mp3 sound that you load using sound.Attachsou...

Page 609

Sound 609 example the following example traces the id3 properties of song.Mp3 to the output panel: var my_sound:sound = new sound(); my_sound.Onid3 = function(){ for( var prop in my_sound.Id3 ){ trace( prop + " : "+ my_sound.Id3[prop] ); } } my_sound.Loadsound("song.Mp3", false); see also attachsoun...

Page 611

Sound 611 see also attachsound (sound.Attachsound method) , id3 (sound.Id3 property) , loadsound (sound.Loadsound method) onload (sound.Onload handler) onload = function(success: boolean ) {} invoked automatically when a sound loads. You must create a function that executes when the this handler is ...

Page 613

Sound 613 example for a sample usage of this property, see sound.Duration . See also duration (sound.Duration property) setpan (sound.Setpan method) public setpan(value: number ) : void determines how the sound is played in the left and right channels (speakers). For mono sounds, pan determines whic...

Page 615

Sound 615 example the following example illustrates a setting that can be achieved by using settransform() , but cannot be achieved by using setvolume() or setpan() , even if they are combined. The following code creates a new soundtransformobject object and sets its properties so that sound from bo...

Page 617

Sound 617 parameters secondoffset: number [optional] - a parameter that lets you start playing the sound at a specific point. For example, if you have a 30-second sound and want the sound to start playing in the middle, specify 15 for the secondoffset parameter. The sound is not delayed 15 seconds, ...

Page 619

Stage 619 property summary properties inherited from class object event summary method summary methods inherited from class object modifiers property description static align : string indicates the current alignment of the swf file in the player or browser. Static height : number property (read-only...

Page 621

Stage 621 the following table lists the values for the align property. Any value not listed here centers the swf file in flash player or browser area, which is the default setting. Availability: actionscript 1.0; flash lite 2.0 example the following example demonstrates different alignments of the s...

Page 623