Macromedia FLASH MX FLASH JAVASCRIPT DICTIONARY User Manual

Flash JavaScript Dictionary

Trademarks

Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware,
Authorware Star, Backstage, Bright Tiger, Clustercats, ColdFusion, Contribute, Design In Motion, Director, Dream Templates,
Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, Flash Lite, Flex, Fontographer, FreeHand,
Generator, HomeSite, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track,
LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Breeze,
Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel,
Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic,
Open Sesame!, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, SoundEdit, Titlemaker, UltraDev, Web Design 101, what
the web can be, and Xtra are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United
States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned
within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be
registered in certain jurisdictions including internationally.

Third-Party Information

This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not
responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your
own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia
endorses or accepts any responsibility for the content on those third-party sites.

Speech compression and decompression technology licensed from Nellymoser, Inc. (www.nellymoser.com).

Sorenson™ Spark™ video compression and decompression technology licensed from Sorenson Media, Inc.

Opera ® browser Copyright © 1995-2002 Opera Software ASA and its suppliers. All rights reserved.

Apple Disclaimer

APPLE COMPUTER, INC. MAKES NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING THE
ENCLOSED COMPUTER SOFTWARE PACKAGE, ITS MERCHANTABILITY OR ITS FITNESS FOR ANY
PARTICULAR PURPOSE. THE EXCLUSION OF IMPLIED WARRANTIES IS NOT PERMITTED BY SOME STATES.
THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH SPECIFIC
LEGAL RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU MAY HAVE WHICH VARY FROM STATE TO
STATE.

Copyright © 2004 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced,
translated, or converted to any electronic or machine-readable form in whole or in part without prior written approval of
Macromedia, Inc.

Acknowledgments

Director: Erick Vera

Project Management: Julee Burdekin, Erick Vera

Writing: Jay Armstrong, Jody Bleyle, Mary Burger, Francis Cheng, Jen deHaan, Stephanie Gowin, Phillip Heinz, Shimul Rahim,
Samuel R. Neff

Managing Editor: Rosana Francescato

Editing: Mary Ferguson, Mary Kraemer, Noreen Maher, Antonio Padial, Lisa Stanziano, Anne Szabla

Production Management: Patrice O’Neill

Media Design and Production: Adam Barnett, Christopher Basmajian, Aaron Begley, John Francis

Second Edition: June 2004

Macromedia, Inc.
600 Townsend St.

San Francisco, CA 94103

CONTENTS

CHAPTER 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Overview of the Macromedia Flash JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . 17

The Flash Document Object Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

The Document object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Specifying the target of an action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Summary of the DOM structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

The PolyStar example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

CHAPTER 2: Top-level functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

CHAPTER 3: Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

BitmapInstance object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

bitmapInstance.getBits(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

bitmapInstance.hPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

bitmapInstance.setBits() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

bitmapInstance.vPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

BitmapItem object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

bitmapItem.allowSmoothing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

bitmapItem.compressionType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

bitmapItem.quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

bitmapItem.useImportedJPEGQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

CompiledClipInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

compiledClipInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

compiledClipInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

compiledClipInstance.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

compiledClipInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

compiledClipInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

compiledClipInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

compiledClipInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ComponentInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

componentInstance.parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

componentsPanel object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

componentsPanel.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

3

Contour object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

contour.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

contour.interior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

contour.orientation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Document object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

document.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

document.addDataToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

document.addDataToSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

document.addItem(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

document.addNewLine() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

document.addNewOval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

document.addNewPublishProfile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

document.addNewRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

document.addNewScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

document.addNewText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

document.align() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

document.allowScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

document.arrange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

document.autoLabel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

document.backgroundColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

document.breakApart(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

document.canEditSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

document.canRevert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

document.canTestMovie() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

document.canTestScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

document.clipCopy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

document.clipCut() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

document.clipPaste() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

document.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

document.convertLinesToFills() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

document.convertToSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

document.currentPublishProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

document.currentTimeline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

document.deletePublishProfile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

document.deleteScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

document.deleteSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

document.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

document.distribute(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

document.distributeToLayers(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

document.documentHasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

document.duplicatePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

document.duplicateScene(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

document.duplicateSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

document.editScene(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

document.enterEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

document.exitEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

document.exportPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

document.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

document.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

document.frameRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

4 Contents

document.getAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

document.getCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

document.getCustomStroke(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

document.getDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

document.getElementProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

document.getElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

document.getSelectionRect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

document.getTextString(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

document.getTimeline(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.getTransformationPoint(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.group() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

document.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

document.importPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

document.importSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

document.library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

document.livePreview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

document.match() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.mouseClick() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.mouseDblClk() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

document.moveSelectedBezierPointsBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.moveSelectionBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.optimizeCurves() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.publish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.publishProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

document.removeDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

document.removeDataFromSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.renamePublishProfile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.renameScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

document.reorderScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

document.resetTransformation(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

document.revert(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

document.rotateSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.saveAndCompact() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

document.scaleSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

document.screenOutline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

document.selectAll(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

document.selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

document.selectNone(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

document.setAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

document.setCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

document.setCustomStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.setElementProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.setElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

document.setFillColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.setInstanceAlpha() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.setInstanceBrightness(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

document.setInstanceTint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Contents 5

document.setSelectionBounds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

document.setSelectionRect(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

document.setStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

document.setStrokeColor(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

document.setStrokeSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

document.setStrokeStyle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.setTextRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.setTextSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

document.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.setTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

document.skewSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.smoothSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.space() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

document.straightenSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.swapElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.testMovie(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

document.testScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

document.timelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.traceBitmap(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.transformSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.unGroup(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.unlockAllElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.viewMatrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

document.xmlPanel() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

drawingLayer object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

drawingLayer.beginDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

drawingLayer.beginFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

drawingLayer.cubicCurveTo(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

drawingLayer.curveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

drawingLayer.drawPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

drawingLayer.endDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

drawingLayer.endFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

drawingLayer.lineTo(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

drawingLayer.moveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

drawingLayer.newPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

drawingLayer.setColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Edge object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

edge.getControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

edge.getHalfEdge(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

edge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

edge.isLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

edge.setControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

edge.splitEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

6 Contents

Effect object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

effect.effectName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

effect.groupName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.sourceFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.symbolType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.useXMLToUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Element object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

element.depth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

element.elementType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

element.getPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

element.hasPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

element.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

element.left. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

element.locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

element.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

element.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.removePersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.setPersistentData(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

element.width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

EmbeddedVideoInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Fill object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

fill.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

fill.colorArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.posArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

flash object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

fl.activeEffect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

fl.browseForFileURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

fl.closeAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

fl.closeDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

fl.componentsPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

fl.configDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

fl.configURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

fl.createDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

fl.createNewDocList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.createNewDocListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.createNewTemplateList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

fl.drawingLayer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

fl.effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

fl.enableImmediateUpdates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

fl.fileExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

fl.findDocumentIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

fl.getDocumentDOM() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

fl.mapPlayerURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

fl.Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

fl.mruRecentFileList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

fl.mruRecentFileListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Contents 7

fl.openDocument(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

fl.openProject(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

fl.openScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

fl.outputPanel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

fl.quit(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

fl.reloadEffects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

fl.reloadTools() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

fl.revertDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

fl.runScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

fl.saveAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

fl.saveDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

fl.saveDocumentAs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

fl.setActiveWindow() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

fl.tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.xmlui. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

folderItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

fontItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Frame object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

frame.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

frame.duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

frame.elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

frame.labelType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

frame.motionTweenOrientToPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

frame.motionTweenRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

frame.motionTweenRotateTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenSnap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.shapeTweenBlend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.soundEffect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLibraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLoopMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

frame.soundName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

frame.soundSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.startFrame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.tweenEasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.tweenType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

HalfEdge object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

halfEdge.getEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

halfEdge.getNext() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

halfEdge.getOppositeHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

halfEdge.getPrev() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

halfEdge.getVertex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

halfEdge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

8 Contents

Instance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

instance.instanceType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

instance.libraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Item object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

item.addData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

item.getData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

item.hasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

item.itemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

item.linkageClassName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportForAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportForRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportInFirstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

item.linkageIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

item.linkageImportForRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.linkageURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.removeData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Layer object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

layer.color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

layer.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

layer.frames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

layer.height. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.layerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.locked. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

layer.outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

layer.parentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

layer.visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

library object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

library.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

library.addNewItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

library.deleteItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

library.duplicateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

library.editItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

library.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

library.findItemIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

library.getItemProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

library.getItemType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

library.getSelectedItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

library.importEmbeddedSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

library.itemExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

library.items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

library.moveToFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

library.newFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

library.renameItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

library.selectAll(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

library.selectItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

library.selectNone(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

library.setItemProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

library.updateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Contents 9

LinkedVideoInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Math object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Math.concatMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Math.invertMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Math.pointDistance(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Matrix object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

matrix.a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

matrix.b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

matrix.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

matrix.d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

matrix.tx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

matrix.ty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

outputPanel object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

outputPanel.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

outputPanel.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

outputPanel.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Parameter object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

parameter.category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

parameter.insertItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

parameter.listIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

parameter.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

parameter.removeItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

parameter.value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

parameter.valueType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

parameter.verbose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Path object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

path.addCubicCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

path.addCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

path.addPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

path.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

path.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

path.makeShape(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

path.newContour(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

path.nPts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Screen object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

screen.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

screen.childScreens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

screen.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

screen.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

screen.hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

screen.instanceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

screen.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

screen.nextScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

screen.parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

screen.parentScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

screen.prevScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

screen.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

screen.tabIndex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

screen.timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

10 Contents

ScreenOutline object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

screenOutline.copyScreenFromFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

screenOutline.currentScreen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

screenOutline.deleteScreen(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

screenOutline.duplicateScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

screenOutline.getSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

screenOutline.insertNestedScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

screenOutline.insertScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

screenOutline.moveScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

screenOutline.renameScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

screenOutline.rootScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

screenOutline.screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

screenOutline.setCurrentScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

screenOutline.setScreenProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

screenOutline.setSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Shape object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

shape.beginEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

shape.contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

shape.deleteEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

shape.edges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

shape.endEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

shape.isGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

shape.vertices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

SoundItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

soundItem.bitRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

soundItem.bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

soundItem.compressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

soundItem.convertStereoToMono. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.sampleRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.useImportedMP3Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Stroke object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

stroke.breakAtCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.dash1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

stroke.dash2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

stroke.density . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

stroke.dotSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

stroke.dotSpace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

stroke.hatchThickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

stroke.jiggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

stroke.length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

stroke.pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

stroke.rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

stroke.space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

stroke.style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

stroke.thickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

Contents 11

stroke.variation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

stroke.waveHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

stroke.waveLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

SymbolInstance object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

symbolInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

symbolInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

symbolInstance.buttonTracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

symbolInstance.colorAlphaAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorAlphaPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorBlueAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorBluePercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorGreenAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorGreenPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

symbolInstance.colorRedAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

symbolInstance.colorRedPercent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.firstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

symbolInstance.loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

symbolInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

symbolInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

symbolInstance.symbolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

symbolInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

SymbolItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

symbolItem.convertToCompiledClip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

symbolItem.exportSWC(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

symbolItem.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

symbolItem.sourceAutoUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

symbolItem.sourceFilePath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

symbolItem.sourceLibraryName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

symbolItem.symbolType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

symbolItem.timeline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

TextAttrs object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

textAttrs.aliasText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.autoKern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

textAttrs.characterPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

textAttrs.characterSpacing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.face. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.fillColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.indent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.leftMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.lineSpacing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

textAttrs.rightMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

textAttrs.rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

12 Contents

textAttrs.size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

textAttrs.target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

textAttrs.url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Text object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

text.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

text.autoExpand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

text.border . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

text.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.embeddedCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.embedRanges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.getTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

text.getTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

text.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.lineType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.maxCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.orientation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

text.renderAsHTML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

text.scrollable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

text.setTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

text.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

text.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

text.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

text.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

text.textRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.textType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.useDeviceFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.variableName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

TextRun object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

textRun.characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

textRun.textAttrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Timeline object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

timeline.addMotionGuide() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

timeline.addNewLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

timeline.clearFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

timeline.clearKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

timeline.convertToBlankKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

timeline.convertToKeyframes(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

timeline.copyFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

timeline.createMotionTween() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

timeline.currentFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

timeline.currentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

timeline.cutFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

timeline.deleteLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

timeline.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

timeline.findLayerIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

timeline.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

timeline.getFrameProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Contents 13

timeline.getLayerProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

timeline.getSelectedFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

timeline.getSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

timeline.insertBlankKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

timeline.insertFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

timeline.insertKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

timeline.layerCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

timeline.layers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.pasteFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.removeFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

timeline.reorderLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

timeline.reverseFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

timeline.selectAllFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

timeline.setFrameProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

timeline.setLayerProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

timeline.setSelectedFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

timeline.setSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

timeline.showLayerMasking(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

ToolObj object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

toolObj.enablePIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

toolObj.position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

toolObj.setIcon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

toolObj.setMenuString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

toolObj.setOptionsFile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

toolObj.setPI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

toolObj.setToolName(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

toolObj.setToolTip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

toolObj.showPIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

toolObj.showTransformHandles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Tools object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

tools.activeTool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.altIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.constrainPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.ctlIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.getKeyDown() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.mouseIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.penDownLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.penLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

tools.setCursor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

tools.shiftIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

tools.snapPoint(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

tools.toolObjs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Vertex object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.getHalfEdge(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.setLocation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

vertex.y. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

VideoItem object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

14 Contents

XMLUI object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

xmlui.accept(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

xmlui.cancel(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

xmlui.get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

xmlui.set() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

CHAPTER 4: C-Level Extensibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

How integrating C functions works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

C-level extensibility and the JavaScript interpreter . . . . . . . . . . . . . . . . . . . . . 370

Sample implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

The C-level API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

JSBool JS_DefineFunction(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

unsigned short *JS_ValueToString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

JSBool JS_ValueToInteger() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

JSBool JS_ValueToDouble(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

JSBool JS_ValueToBoolean() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

JSBool JS_ValueToObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

JSBool JS_StringToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

JSBool JS_DoubleToValue(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_BooleanToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_BytesToValue(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_IntegerToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

JSVal JS_ObjectToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

unsigned short *JS_ObjectType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

JSObject *JS_NewArrayObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

long JS_GetArrayLength() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

JSBool JS_GetElement(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

JSBool JS_SetElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

JSBool JS_ExecuteScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Contents 15

16 Contents

CHAPTER 1

Introduction

The documents on this site assume you are familiar with JavaScript or ActionScript syntax and
with basic programming concepts such as functions, parameters, and data types. They also
assume that you understand the concept of working with objects and properties. For a reference
on JavaScript, see the Netscape JavaScript documentation.

Netscape DevEdge Online has a JavaScript Developer Central site (http://

developer.netscape.com/tech/javascript/index.html) that contains documentation and articles

useful for understanding JavaScript. The most valuable resource is the Core JavaScript Guide.

This chapter contains the following sections:

Overview of the Macromedia Flash JavaScript API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

The Flash Document Object Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

The PolyStar example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Overview of the Macromedia Flash JavaScript API

The ActionScript language lets you write scripts to perform actions in the Macromedia Flash
Player environment (that is, while a SWF file is playing). The Flash JavaScript API (JSAPI) lets
you write scripts to perform several actions in the Flash authoring environment (that is, while a
user has the Flash program open). You can write scripts that act like commands and scripts that
add tools to the Tools panel. These scripts can be used to help automate the authoring process.

The Flash JSAPI is designed to resemble the Macromedia Dreamweaver and Macromedia
Fireworks JavaScript API (which were designed based on the Netscape JavaScript API). The Flash
JSAPI is based on a Document Object Model (DOM), which allows Flash documents to be
accessed using JavaScript objects. The Flash JSAPI includes all elements of the Netscape
JavaScript API, plus the Flash DOM. These added objects and their methods and properties are
described in this document. You can use any of the elements of the native JavaScript language in a
Flash script, but only elements that make sense in the context of a Flash document will have
an effect.

17

You can use Macromedia Flash MX 2004 Professional or your preferred text editor to write or
edit Flash JavaScript (JSFL) files. If you use Flash Professional, these files have a .jsfl extension by
default. To make a script appear in the Commands menu, save its JSFL file in the following
folder:

• Windows 2000 or Windows XP:

C:\Documents and Settings\user\Local Settings\ Application Data\Macromedia\
Flash MX2004\language\Configuration\Commands

• Windows 98:

C:\Windows\Application Data\Macromedia\Flash MX 2004\language\
Configuration\Commands

• Mac OS X:

Hard Drive/Users/userName/Library/Application Support/Macromedia/Flash MX 2004/
language/Configuration/Commands

JSFL files that create tools need to be stored in the Tools folder, which can be found in the
following location:

• Windows 2000 or Windows XP:

C:\Documents and Settings\user\Local Settings\ Application Data\Macromedia\
Flash MX2004\language\Configuration\Tools

• Windows 98:

C:\Windows\Application Data\Macromedia\Flash MX 2004\language\Configuration\Tools

• Mac OS X:

Hard Drive/Users/userName/Library/Application Support/Macromedia/Flash MX 2004/
language/Configuration/Tools

If a JSFL file has other files that go with it, such as XML files, they should be stored in the same
directory as the JSFL file.

You can also create a JSFL file by selecting one or more commands in the History panel and then
clicking the Save As Command button in the History panel or selecting the Save As Command
from the Options pop-up menu. The command (JSFL) file is saved in the Commands folder. You
can then open the file and edit it the same as any other script file.

To run a script, do one of the following:

• Select Commands > Command Name.

• Select Commands > Run Command and then select the script to run.

To add a tool implemented in a JSFL file to the Flash Tools panel:

1.

Copy the JSFL file for the tool and any other associated files to the Tools folder.

2.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh).

3.

Add the tool to the list of available tools.

4.

Click OK.

18 Chapter 1: Introduction

You can embed individual JSAPI commands in ActionScript files by using the MMExecute()
command, which is documented in the Flash MX 2004 ActionScript Language Reference. However,
the

MMExecute() command has an effect only when it is used in the context of a custom user-

interface element, such as a component Property inspector, or a SWF panel within the authoring
environment. Even if called from ActionScript, JSAPI commands have no effect in Flash Player or
outside the authoring environment.

The JSAPI also contains a number of methods that let you implement extensibility using a
combination of JavaScript and custom C code. For more information, see Chapter 4, “C-Level

Extensibility,” on page 369.

Flash JavaScript objects contain properties and methods. Properties, each defined as a primitive
type such as Boolean, integer, array, float, or reference data types such as color, object, point, rect,
and String, are used to describe the object. Methods are used to perform a function on the object.
To access the properties or methods of an object, dot notation is used. Also, most objects have

getProperty() and setProperty() methods, which get the value for a specified property or set

the value for a specified property. Most methods take parameters that are used to specify different
options for the method.

The JavaScript interpreter in Flash is the Mozilla SpiderMonkey engine, version 1.5, which is
available on the web at http://www.mozilla.org/js/spidermonkey/. SpiderMonkey is one of the
two reference implementations of the JavaScript language developed by Mozilla.org. It is the same
engine that is embedded in the Mozilla browser.

SpiderMonkey implements the entire core JavaScript language as defined in the ECMA-262
specification. It is fully compliant with ECMA-262 Edition 3. Only the browser-specific host
objects, which are not part of the ECMA-262 specification, are not supported.

All “Core JavaScript” sections of Netscape’s JavaScript documentation at http://

devedge.netscape.com/central/javascript/ apply to the Flash JavaScript interpreter. All “Client-

Side JavaScript” sections do not apply because they only apply to browser environments.

SpiderMonkey is also used in Fireworks MX 2004, Dreamweaver MX 2004, Director MX 2004
and Flash Communication Server MX.

The Flash Document Object Model

The DOM for the Flash JavaScript API consists of a set of top-level functions (see “Top-level

functions” on page 25) and the top-level flash object. The

available to a script because it always exists when the Flash authoring environment is open. When
referring to this object, you can use

flash or fl. For example, to close all open files, you can use

either of the following statements:

flash.closeAll();
fl.closeAll();

flash object is guaranteed to be

The Flash Document Object Model 19

The flash object contains the following child objects:

Object How to access

componentsPanel object Use fl.componentsPanel to access the componentsPanel object. This

object corresponds to the Components panel in the Flash authoring
environment.

Document object Use

drawingLayer object Use

Effect object Use

Math object Use

outputPanel object Use

Tools object

ToolObj object Use fl.

XMLUI object Use

fl.documents to retrieve an array of all the open documents; use

fl.documents[index] to access a particular document; use

fl.getDocumentDOM() to access the current document (the one with

focus).

fl.drawingLayer to access the drawingLayer object.

fl.effects to retrieve an array of effect descriptors that

corresponds to the effects registered when Flash starts; use

fl.effects[index] to access a particular effect; use fl.activeEffect to

access the effect descriptor for the current effect being applied.

fl.Math to access the Math object.

fl.outputPanel to access the outputPanel object. This object

corresponds to the Output panel in the Flash authoring environment.

fl.tools is an object that has a toolObjs property. The toolObjs

property is an array of
a tool in the Flash Tools panel.

tools.toolObjs to retrieve an array of all tool objects (see

tools.toolObjs); use fl.tools.activeTool to access the currently

active tool object (see

fl.xmlui to access an XML User Interface (XMLUI) object. The

XMLUI object provides the ability to get and set properties of an XMLUI
dialog box.

toolObj objects. Each toolObj object represents

tools.activeTool).

The Document object

An important property of the top-level

flash object is the documents property. The documents

property contains an array of Document objects that each represent one of the FLA files currently
open in the authoring environment. The properties of each Document object represent most of
the elements that a FLA file can contain. Therefore, a large portion of the DOM is composed of
child objects and properties of the

To refer to the first open document, for example, use the statement

fl.documents[0]. The first document is the first Flash document that was opened during the

Document object.

flash.documents[0]. or

current session in the authoring environment. When the first opened document is closed, the
indexes of the other open documents are decremented.

To find a particular document's index use

To access the document that is currently focused, use the statement

fl.getDocumentDOM(). The latter is the syntax used in most of the examples in this document.

To find a particular document in the
document for its

20 Chapter 1: Introduction

name property.

fl.findDocumentIndex(nameOfDocument).

flash.getDocumentDOM() or

documents array, iterate through the array and test each

All the objects in the DOM that aren’t listed in the previous table (see “The Flash Document

Object Model” on page 19) are accessed from the

library of a document, you use the

library property of the Document object, which retrieves a

Document object. For example, to access the

library object:

fl.getDocumentDOM().library

To access the array of items in the library, you use the items property of the Library object; each
element in the array is an Item object:

fl.getDocumentDOM().library.items

To access a particular item in the library, you specify a member of the items array:

fl.getDocumentDOM().library.items[0]

In other words, the Library object is a child of the Document object, and the Item object is a
child of the

Library object.

Specifying the target of an action

Unless otherwise specified, methods affect the current focus or selection. For example, the
following script doubles the size of the current selection because no particular object is specified:

fl.getDocumentDOM().scaleSelection(2, 2);

In some cases, you might want an action to specifically target the currently selected item in the
Flash document. To do this, use the array that the

Document.selection property contains. The

first element in the array represents the currently selected item, as shown in the following
example:

var accDescription = fl.getDocumentDOM().selection[0].description;

The following script doubles the size of the first element on the Stage that is stored in the element
array, instead of the current selection:

var element =

fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements[0];

if (element) {

element.width = element.width*2;
element.height = element.height*2;

}

You can also do something such as loop through all the elements on the Stage and increase the
width and height by a specified amount, as shown in the following example:

var elementArray =

fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements;
for (var i=0; i < elementArray.length; i++) {

var offset = 10;
elementArray[i].width += offset;
elementArray[i].height += offset;

}

The Flash Document Object Model 21

Summary of the DOM structure

The following list displays the DOM structure in outline format. Numbers at the beginning of
each line represent the level of an object. For example, an object preceded by “03” is a child of
next highest “02” object, which, in turn, is a child of the next highest “01” object.

In some cases, an object is available by specifying a property of its parent object. For example, the

document.timelines property contains an array of Timeline objects. These properties are

noted in the following outline.

Finally, some objects are subclasses of other objects, rather than being children of other objects.
An object that is a subclass of another object has methods and/or properties of its own in addition
to the methods and properties of the other object (the superclass). Subclasses share the same level
in the hierarchy as their superclass. For example, Item is a superclass of BitmapItem. These
relationships are illustrated in the following outline:

01 Top-level functions
01 flash object

02 componentsPanel object
02 Document object (fl.documents array)

03 Matrix object
03 Fill object
03 Stroke object
03 library object

04 Item object (library.items array)
04 BitmapItem object (subclass of Item object)
04 folderItem object (subclass of Item object)
04 fontItem object (subclass of Item object)
04 SoundItem object (subclass of Item object)
04 SymbolItem object (subclass of Item object)
04 VideoItem object (subclass of Item object)

03 Timeline object (document.timelines array)

04 Layer object (timeline.layers array)

05 Frame object (layer.frames array)

06 Element object (frame.elements array)

07 Matrix object (Element.matrix)
06 Instance object (abstract class, subclass of Element object)
06 BitmapInstance object (subclass of Instance object)
06 CompiledClipInstance object (subclass of Instance object)
06 ComponentInstance object (subclass of SymbolInstance object)

07 Parameter object (ComponentInstance.parameters)
06 EmbeddedVideoInstance object (subclass of Instance object)
06 LinkedVideoInstance object (subclass of Instance object)
06 SymbolInstance object (subclass of Instance object)
06 Text object (subclass of Element object)

07 TextRun object (text.textRuns array)

08 TextAttrs object (textRun.textAttrs array)

06 Shape object (subclass of Element object)

07 Contour object (shape.contours array)

08 HalfEdge object

09 Vertex object
09 Edge object

07 Edge object (shape.edges array)

08 HalfEdge object

22 Chapter 1: Introduction

09 Vertex object
09 Edge object

07 Vertex object (shape.vertices array)

08 HalfEdge object

09 Vertex object
09 Edge object

03 ScreenOutline object

04 Screen object (screenOutline.screens array)

05 Parameter object (screen.parameters array)

02 drawingLayer object

03 Path object

04 Contour object
02 Effect object (fl.effects array)
02 Math object
02 outputPanel object
02 Tools object (fl.tools array)

03 ToolObj object (tools.toolObjs array)

02 XMLUI object

The PolyStar example

Included with this documentation is a sample Flash JSAPI script named PolyStar.jsfl. (You can
download the file at www.macromedia.com/go/jsapi_info_en.) This script replicates the PolyStar
tool that can be found in the Flash Tools panel. The PolyStar.jsfl file demonstrates how to build
the PolyStar tool using the JSAPI. It includes detailed comments that describe what the lines of
code are doing. Read this file to gain a better understanding of how the JSAPI can be used.

Flash MX 2004 includes an earlier version of the PolyStar.jsfl script that must be removed in order
to use the updated PolyStar.jsfl file.

To remove the earlier version of the PolyStar.jsfl that was installed with Flash MX 2004:

1.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh).

2.

In the Customize Tools Panel dialog box, click the Rectangle tool on the left side of the dialog
box.

The Rectangle tool and the PolyStar tool should now be listed in the Current Selection list on
the right side of the dialog box.

3.

Select the PolyStar tool in the Current Selection list.

4.

Click Remove.

5.

Click OK.

6.

Quit Flash.

7.

Remove only the PolyStar.jsfl file from the appropriate Tools folder listed in “Overview of the

Macromedia Flash JavaScript API” on page 17. The PolyStar.xml and PolyStar.png files are

needed by the new PolyStar.jsfl file that you will install later. When you restart Flash, the
PolyStar tool no longer appears in the Customize Tools Panel dialog box.

The PolyStar example 23

To install the updated PolyStar example files:

1.

Copy the new PolyStar.jsfl file to the Tools folder. The PolyStar.xml and PolyStar.png files that
you see in this folder are needed by the new PolyStar.jsfl file.

2.

Restart Flash.

3.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh). You should see PolyStar tool in the available tools list.

4.

Click the Rectangle tool at the left side of the Customize Tools Panel dialog box. The Rectangle
Tool should appear in the Current Selection list at the right side of the dialog box.

5.

Select the PolyStar tool from the Available Tools list.

6.

Click Add.

7.

Click OK.

The PolyStar tool now appears in the Rectangle tool pop-up menu.

24 Chapter 1: Introduction

CHAPTER 2

Top-level functions

This chapter describes the top-level functions that are available when creating extensible tools.
The following list shows the functions in alphabetical order:

activate()
configureEffect()
configureTool()
deactivate()
executeEffect()
keyDown()
keyUp()
mouseDoubleClick()
mouseDown()
mouseMove()
mouseUp()
notifySettingsChanged()
removeEffect()
setCursor()

25

activate()

Availability

Flash MX 2004.

Usage

function activate() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the extensible tool becomes active (that is, when the tool is selected
in the Tools panel). Any setup the tool needs to do should be performed in this function.

Example

function activate() {

fl.trace( "Tool is active" );

}

26 Chapter 2: Top-level functions

configureEffect()

Availability

Flash MX 2004.

Usage

function configureEffect() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called once at load time of Flash and is a good place for global initialization of
your effect. The per instance parameter data for an effect cannot be accessed here.

See also

executeEffect()

, removeEffect()

configureEffect() 27

configureTool()

Availability

Flash MX 2004.

Usage

function configureTool() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when Macromedia Flash opens and the tool is loaded. Use this function to
set any information Flash needs to know about the tool.

Example

The following examples show two possible implementations of this function:

function configureTool() {

theTool = fl.tools.activeTool;
theTool.setToolName("myTool");
theTool.setIcon("myTool.png");
theTool.setMenuString("My Tool's menu string");
theTool.setToolTip("my tool's tool tip");
theTool.setOptionsFile( "mtTool.xml" );

}

function configureTool() {

theTool = fl.tools.activeTool;
theTool.setToolName("ellipse");
theTool.setIcon("Ellipse.png");
theTool.setMenuString("Ellipse");
theTool.setToolTip("Ellipse");
theTool.showTransformHandles( true );

}

28 Chapter 2: Top-level functions

deactivate()

Availability

Flash MX 2004.

Usage

function deactivate() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the tool becomes inactive (that is, when the active tool changes from
this tool to another one). Use this function to perform any cleanup the tool needs.

Example

function deactivate() {

fl.trace( "Tool is no longer active" );

}

deactivate() 29

executeEffect()

Availability

Flash MX 2004.

Usage

function executeEffect() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the user first applies an effect or changes an effect's properties. The
code contained in this function is responsible for modifying the original object(s) to accomplish
the desired effect. It is also responsible for copying the original to another hidden layer if
necessary for the

See also

configureEffect()

removeEffect function

, removeEffect()

30 Chapter 2: Top-level functions