User manual MACROMEDIA DIRECTOR MX - LINGO DICTIONARY

Lingo Dictionary Macromedia Director MX Trademarks Afterburner, AppletAce, Attain, Attain Enterprise Learning System, Attain Essentials, Attain Objects for Dreamweaver, Authorware, Authorware Attain, Authorware Interactive Studio, Authorware Star, Authorware Synergy, Backstage, Backstage Designer, Backstage Desktop Studio, Backstage Enterprise Studio, Backstage Internet Studio, Contribute, Design in Motion, Director, Director Multimedia Studio, Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat, Drumbeat 2000, Extreme 3D, Fireworks, Flash, Fontographer, FreeHand, FreeHand Graphics Studio, Generator, Generator Developer's Studio, Generator Dynamic Graphics Server, Knowledge Objects, Knowledge Stream, Knowledge Track, Lingo, Live Effects, Macromedia, Macromedia M Logo & Design, Macromedia Contribute, Macromedia Flash, Macromedia Xres, Macromind, Macromind Action, MAGIC, Mediamaker, Object Authoring, Power Applets, Priority Access, Roundtrip HTML, Scriptlets, SoundEdit, ShockRave, Shockmachine, Shockwave, Shockwave Remote, Shockwave Internet Studio, Showcase, Tools to Power Your Ideas, Universal Media, Virtuoso, Web Design 101, Whirlwind and Xtra are 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, servicemarks, or tradenames of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. This guide contains links to third-party Web sites 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 Web site 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. 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 © 2002 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. Third Party Software Notices and/or Additional Terms and Conditions can be found at http://www.macromedia.com/go/thirdparty/. Part Number ZDR90M200 Acknowledgments Writing: Jay Armstrong, George Brown, Stephanie Gowin, and, Tim Statler Editing: Rosana Francescato, Mary Ferguson, Mary Kraemer, and Noreen Maher Project Management: Stuart Manning Production: Chris Basmajian, Caroline Branch, John Francis, and Patrice O'Neill Multimedia: Aaron Begley and Benjamin Salles First Edition: December 2002 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103 CHAPTER 1 Lingo by Feature This chapter lists various Macromedia Director MX features and the corresponding Lingo elements that you can use to implement those features. Accessibility These terms are useful for making movies accessible to the disabled: Text-to-speech voiceCount() voiceGet() voiceGetPitch() voiceGetRate() voiceGetVolume() voiceInitialize() voicePause() voiceResume() voiceSet() voiceSetPitch() voiceSetRate() voiceSetVolume() voiceSpeak() voiceState() voiceStop() voiceWordPos() Keyboard navigation autoTab hilite (command) keyboardFocusSprite selection (text cast member property) selection() (function) selection (cast property) selectedText selEnd selStart 3 Animated GIFs These terms are useful for working with animated GIFs: directToStage frameRate linked moviePath pause (movie playback) playBackMode resume sprite rewind sprite Animation These terms are useful for creating animation with Lingo: blend ink loc locH locV member (sprite property) regPoint tweened Behaviors The terms in this section are useful for authoring behaviors and using behaviors while the movie plays. Authoring behaviors Use these terms to set up behaviors and the behavior's Parameters dialog box: ancestor on runPropertyDialog on getBehaviorTooltip on isOKToAttach on getBehaviorDescription on getPropertyDescriptionList property Sending messages to behaviors Use these commands to send messages to behaviors attached to sprites: call callAncestor sendSprite sendAllSprites Identifying behaviors Use these terms to identify the behaviors attached to sprites: currentSpriteNum me scriptInstanceList spriteNum 4 Chapter 1 Bitmaps The terms in this section are useful for working with bitmaps. Bitmap properties Use these terms to check and set bitmap properties: alphaThreshold backColor blend depth dither trimWhiteSpace (property) imageQuality movieImageQuality foreColor palette picture (cast member property) pictureP() rect (member) imageCompression movieImageCompression Alpha channel Use these terms to control alpha channel effects: alphaThreshold depth createMask() extractAlpha() dither useAlpha createMatte() setAlpha() Image objects Use these terms to create and control image objects: copyPixels() crop() (image object command) draw() duplicate() (image function) getPixel() fill() image image() rect (image) setPixel() Buttons See Buttons and check boxes in the Interface Elements section. Lingo by Feature 5 Cast members The terms in this section are useful for working with cast members. Creating cast members Use importFileInto and new() to create cast members. Authoring Use duplicate member, erase during authoring. Graphic cast members Use these terms to check and set the images assigned to graphic cast members: center crop (cast member property) depth media palette picture (cast member property) pictureP() regPoint member, and pasteClipBoardInto to work with cast members General cast member properties Use these terms to check and set cast member properties: fileName (cast member property) media modified name (cast member property) number (cast member property) preLoadMode type (cast member property) URL Graphic cast member dimensions Use height, rect (member), and width to check and set dimensions for graphic cast members. Casts The terms in this section are useful for working with casts. Loading casts Use preLoadMode to check and set when Director preloads a cast. Cast properties Use these terms to specify cast properties: castLib fileName (cast property) name (cast property) number (cast property) number (system property) 6 Chapter 1 Cast management Use these terms to manage casts: activeCastLib duplicate member erase member findEmpty() move member number of members pasteClipBoardInto save castLib selection (cast property) Computer and operating system Use these terms to check and control the computer: beep beepOn cpuHogTicks emulateMultiButtonMouse floatPrecision freeBlock() freeBytes() maxInteger multiSound romanLingo Operating system control Use restart and shutDown to control the operating system. Data types These terms are useful for specifying data types: # (symbol) float() floatP() integer() integerP() objectP() string() stringP() symbol() symbolP() VOID voidP() Digital video These terms are useful for working with AVI and QuickTime digital video: controller digitalVideoTimeScale digitalVideoType directToStage duration frameRate loop (cast member property) movieRate trackNextSampleTime trackPreviousKeyTime trackPreviousSampleTime trackStartTime (sprite property) trackStartTime (cast member property) trackStopTime (sprite property) trackStopTime (cast member property) trackText Lingo by Feature 7 movieTime pausedAtStart (Flash, digital video) quickTimeVersion() timeScale trackEnabled trackNextKeyTime trackType (cast member property) trackType (sprite property) trackCount (cast member property) trackCount (sprite property) video (QuickTime, AVI) videoForWindowsPresent QuickTime Use these terms to work with QuickTime: enableHotSpot fieldOfView getHotSpotRect() hotSpotExitCallback hotSpotEnterCallback invertMask isVRMovie loopBounds mask motionQuality mouseLevel node nodeEnterCallback nodeExitCallback nodeType nudge pan (QTVR property) ptToHotSpotID() quickTimeVersion() rotation scale swing() staticQuality tilt translation triggerCallback warpMode RealMedia video Use these terms to with RealMedia video: audio (RealMedia) currentTime (RealMedia) displayRealLogo duration (RealMedia) image (RealMedia) lastError mediaStatus password pause (RealMedia) pausedAtStart (RealMedia) percentBuffered play realPlayerNativeAudio() realPlayerPromptToInstall() realPlayerVersion() seek soundChannel (RealMedia) state (RealMedia) stop (RealMedia) userName (RealMedia) video (RealMedia) 8 Chapter 1 Events Use these event handlers for Lingo that runs when a specific event occurs: activeCastLib close window on cuePassed on deactivateWindow on enterFrame on EvalScript on exitFrame on idle on keyDown on keyUp on mouseDown (event handler) on mouseEnter on mouseLeave on mouseUp (event handler) on stopMovie on endSprite on moveWindow on mouseWithin open window on prepareFrame on prepareMovie on resizeWindow on mouseUpOutside on rightMouseDown (event handler) on rightMouseUp (event handler) on startMovie on stepFrame on streamStatus on timeOut on zoomWindow on beginSprite on hyperlinkClicked Use the pass and stopEvent commands to override the way that Director passes messages along the message hierarchy. External files The terms in this section are useful for working with external files. Path names and filenames Use these terms to check and set path names and filenames: @ (pathname) applicationPath fileName (cast property) fileName (cast member property) getNthFileNameInFolder() moviePath searchCurrentFolder URL Obtaining external media Use these terms to obtain external media: downloadNetThing importFileInto preloadNetThing() Lingo by Feature 9 Managing external files Use these terms to manage external files: closeXlib open openXlib showXlib sound playFile Flash These terms are useful for working with Flash cast members: actionsEnabled broadcastProps bufferSize buttonsEnabled bytesStreamed callFrame() centerRegPoint clearError clickMode defaultRect defaultRectMode directToStage endTellTarget() See tellTarget() eventPassMode findLabel() fixedRate flashRect flashToStage() frame() (function) frame (sprite property) frameCount frameRate frameReady() getError() getFlashProperty() getFrameLabel() getVariable() goToFrame originV pathName (movie property) pausedAtStart (Flash, digital video) percentStreamed play playBackMode playing posterFrame print() printAsBitmap() quality rewind sprite rotation scale scaleMode on sendXML setCallback() settingsPanel() setFlashProperty() setVariable() showProps() sound the soundMixMedia sourceFileName stageToFlash() state (Flash, SWA) static stop (Flash) 10 Chapter 1 hitTest() hold imageEnabled linked loop (keyword) mouseOverButton newObject() obeyScoreRotation originH originMode originPoint stream streamMode streamSize tellTarget() URL viewH viewPoint viewScale viewV volume (cast member property) These terms are useful for working with global Flash objects, which do not require a Flash cast member: clearAsObjects() newObject() setCallback() Frames The Lingo terms in this section let you work with frames. Frame events Use the on enterFrame, on exitFrame, and on that runs at specific events within a frame. prepareFrame event handlers to contain Lingo Frame properties Use these Lingo terms to check and set frame properties: frameLabel framePalette frameScript frameSound1 frameSound2 the markerList frameTempo frameTransition label() labelList marker() Lingo by Feature 11 Interface elements The Lingo terms in this section are useful for working with interface elements. Menus Use these terms to create menus: enabled installMenu menu name (menu property) name (menu item property) number (menu items) number (menus) script Buttons and check boxes Use these terms to specify buttons and check boxes: alert buttonStyle buttonType checkBoxAccess checkBoxType checkMark hilite (cast member property) Keys The Lingo terms in this section are related to using the keyboard. Identifying keys Use these terms to identify keys: charToNum() commandDown controlDown key() keyCode() keyPressed() mouseChar numToChar() optionDown shiftDown Keyboard interaction Use keyPressed(), lastEvent(), and lastKey to detect what the user types at the keyboard. Keyboard events Use these terms to set up handlers that respond to pressing keys: on keyDown on keyUp flushInputEvents keyDownScript keyUpScript 12 Chapter 1 Lingo The Lingo terms in this section are important language elements that you use to construct scripts. Boolean values Use these terms to test whether a condition exists: · · · · FALSE TRUE not or (0 is the numerical equivalent of FALSE). (1 is the numerical equivalent of TRUE). Script control Use these terms to control how a script executes: abort do exit halt nothing pass result scriptsEnabled scriptText stopEvent Code structures Use if to create if..then statements. Use case, end case, and otherwise in case statements. Use these terms for repeat loops: end repeat exit repeat next repeat repeat while repeat with repeat with...down to repeat with...in list Syntax elements Use these terms as part of Lingo's syntax: # (symbol) " (string) ¬ (continuation) -- (comment) () (parentheses) castLib end global member (keyword) of or property sprite the window Lingo by Feature 13 Lists The terms in this section are useful for working with lists. Creating lists Use [ ] (list), duplicate() (list function), or list() to create a list. Adding list items Use these terms to add items to a list: [ ] (bracket access) add addVertex addVertex append Deleting list items Use these terms to delete items from a list: deleteAll deleteAt deleteOne deleteProp Retrieving values from a list Use these terms to retrieve values from a list: [ ] (bracket access) deleteProp deleteProp getLast() getOne() getPos() getProp() getPropAt() Getting information about lists Use these terms to get information about lists: count() findPos findPosNear ilk() listP() max() min param() paramCount() Setting values in a list Use these terms to set values in a list: [ ] (bracket access) setaProp setAt setProp 14 Chapter 1 Media synchronization Use these terms to synchronize animation and sound: cuePointNames cuePointTimes mostRecentCuePoint on cuePassed isPastCuePoint() Memory management The terms in this section are useful for determining memory requirements and controlling when the movie loads and unloads cast members. Idle events Use the on Idle loading Use these terms to control idle loading: cancelIdleLoad finishIdleLoad idleHandlerPeriod idleLoadDone() idleLoadPeriod idleLoadTag idleReadChunkSize netThrottleTicks idle event handler for Lingo that runs when the movie is idle. Preloading and querying media Use these terms to load media into memory and check whether media are available: frameReady() loaded mediaReady preLoad (command) preLoad (cast member property) preLoadBuffer member preLoadEventAbort preLoadMode preloadNetThing() preLoadMember preLoadMovie preLoadRAM purgePriority unLoad unLoadMember unloadMovie Available memory Use these terms to check how much memory is available: freeBlock() freeBytes() memorySize movieFileFreeSize movieFileSize Lingo by Feature 15 Memory requirements Use ramNeeded() and size to determine how much memory required for a cast member or a range of frames. Menus See Menus in the Interface elements section. Message window Use these terms to work in the Message window: put showXlib trace traceLoad traceLogFile appMinimize Monitor Use colorDepth, deskTopRectList, and switchColorDepth to check and control the monitor. Mouse interaction The terms in this section are useful for Lingo related to using the mouse. Mouse clicks Use these terms to detect what the user does with the mouse: clickOn doubleClick emulateMultiButtonMouse lastClick() lastEvent() lastRoll mouseChar on mouseDown (event handler) mouseH mouseItem mouseLevel mouseLine mouseLoc mouseMember mouseOverButton on mouseUp (event handler) mouseV mouseWord on rightMouseDown (event handler) on rightMouseUp (event handler) rollOver() stillDown 16 Chapter 1 Mouse events Use these terms to set up handlers that respond to mouse events: mouseDownScript mouseUpScript on mouseDown (event handler) on mouseEnter on mouseLeave on mouseUp (event handler) on mouseUpOutside on mouseWithin on rightMouseDown (event handler) on rightMouseUp (event handler) Cursor control Use cursor (command), cursor pointer (cursor). (sprite property), and cursorSize to control the Movies in a window The terms in this section are useful for working with movies in a window. Movie in a window events Use these event handlers to contain Lingo that you want to run in response to events in a movie in a window: activeCastLib on closeWindow on moveWindow on openWindow on resizeWindow on zoomWindow Opening and closing movies in a window Use these terms for opening and closing windows: close window forget open window windowList Window appearance Use these terms to check and set the appearance of a movie's window: drawRect fileName (window property) frontWindow modal moveToBack moveToFront name (window property) rect (window) sourceRect tell title titleVisible visible (window property) windowPresent() windowType appMinimize Lingo by Feature 17 Communication between movies Use the tell command to send messages between movies. Movies The terms in this section are useful for managing movies. Stopping movies Use these terms to stop or quit the movie or projector: exitLock halt pauseState quit restart shutDown Movie information Use these terms to obtain information about the movie and the movie's environment: environment lastFrame movie movieFileFreeSize movieFileSize movieName moviePath number (system property) runMode safePlayer version movieFileVersion Source control Use these terms to manage Director projects being worked on by more than one person: comments modifiedBy linkAs() creationDate modifiedDate seconds Saving movies Use saveMovie and updateMovieEnabled to save changes to a movie. Error checking Use the alertHook event to post alerts that describe errors in a projector. Movie events Use the on prepareMovie, on responds to movie events. startMovie, and on stopMovie event handlers for Lingo that 18 Chapter 1 Multiuser server Director MX users should use Macromedia Flash Communication Server MX for communication among Director movies and with application servers. For more information about using Flash Communication Server MX, see Using Flash Communication Server MX in Using Director. Navigation Use these terms to jump to different locations: delay go go loop go next go previous goToFrame gotoNetMovie gotoNetPage play play done Network Lingo The terms in this section are useful for working with the network. Downloading and streaming media Use these terms to obtain or stream media from the network: downloadNetThing (For projectors and authoring only) getNetText() gotoNetMovie gotoNetPage postNetText preloadNetThing() Checking availability Use frameReady() and mediaReady to check whether specific media are completely downloaded. Using network operations Use these terms to check the progress of a network operation or get information regarding network media: getStreamStatus() getLatestNetID netAbort netDone() netError() netPresent netLastModDate() netMIME() netTextResult() on streamStatus proxyServer tellStreamStatus() URLEncode Lingo by Feature 19 Working with the local computer Use these terms to work with the user's computer: browserName() cacheDocVerify() (For projectors and authoring only) cacheSize() (For projectors and authoring only) clearCache (For projectors and authoring only) getPref() setPref Browsers Use on EvalScript, externalEvent, and netStatus to interact with browsers. For additional information about browser scripting using languages such as JavaScript, see "Shockwave Publishing" on the Director Support Center at www.macromedia.com/support/director/ internet.html. Accessing EMBED and OBJECT tag parameters Use externalParamCount(), externalParamName(), EMBED and OBJECT parameter tags: and externalParamValue() to access Operators The terms in this section are operators available in Lingo. Math operators Use these terms for math statements: * (multiplication) / (division) + (addition) - (minus) = (equals) <> (not equal) > (greater than) >= (greater than or equal to) < (less than) <= (less than or equal to) Comparison operators Use and, not, and or to compare expressions. Palettes and color Use these terms to check and set palettes for movies and for cast members: color() depth palette paletteMapping puppetPalette rgb() 20 Chapter 1