ADOBE® DIRECTOR® 11.5 Scripting Dictionary doc

3 Chapter 2: Director Scripting Essentials Types of scripts.. 64 Chapter 4: Debugging Scripts in Director About debugging scripts.. 273 breakLoop Sound Object.. 476 mute Sound Object...

Scripting Dictionary

Systems Incorporated Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement.

The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide.

Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law The unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner Please be sure to obtain any permission required from the copyright owner.

Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization This work is licensed under the Creative Commons Attribution Non-Commercial 3.0 License To view a copy of this license, visit

Bitstream is a trademark or a registered trademark of Bitstream Inc.

This product contains either BSAFE and/or TIPEM software by RSA Security, Inc.

This product includes software developed by the Apache Software Foundation (http://www.apache.org).

Adobe Flash 9 video compression and decompression is powered by On2 TrueMotion video technology © 1992-2005 On2 Technologies, Inc All Rights Reserved http://www.on2.com.

Portions of this product contain code that is licensed from Gilles Vollant.

Portions of this product contain code that is licensed from Nellymoser, Inc (www.nellymoser.com)

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

Copyright © 1995-2002 Opera Software ASA and its supplier All rights reserved.

MPEG Layer-3 audio coding technology licensed from Fraunhofer IIS and Thomson mp3 Surround audio coding technology licensed from Fraunhofer IIS, Agere Systems and Thomson mp3PRO audio coding technologies licensed from Coding Technologies, Fraunhofer IIS and Thomson Multimedia PhysX is a trademark or registered trademark of NVIDIA Corporation in the United States and/or other countries.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

Notice to U.S Government End Users The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R §2.101, consisting of

“Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R §12.212 or 48 C.F.R §227.7202,

as applicable Consistent with 48 C.F.R §12.212 or 48 C.F.R §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S Government end users (a) only as Commercial Items and (b) with only those rights

as are granted to all other end users pursuant to the terms and conditions herein Unpublished-rights reserved under the copyright laws of the United States Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA For U.S Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741 The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Chapter 1: Introduction

Intended audience 1

What’s new with Director scripting 1

What’s new in this documentation 3

Finding information about scripting in Director 3

Chapter 2: Director Scripting Essentials Types of scripts 4

Scripting terminology 5

Scripting syntax 7

Data types 10

Literal values 12

Variables 14

Operators 18

Conditional constructs 21

Events, messages, and handlers 26

Linear lists and property lists 31

JavaScript syntax arrays 38

Chapter 3: Writing Scripts in Director Choosing between Lingo and JavaScript syntax 42

Scripting in dot syntax format 43

Introducing the Director objects 44

Object model diagrams 45

Top-level functions and properties 46

Introduction to object-oriented programming in Director 47

Object-oriented programming with Lingo syntax 48

Object-oriented programming with JavaScript syntax 57

Writing scripts in the Script window 64

Chapter 4: Debugging Scripts in Director About debugging scripts 77

Good scripting habits 77

Basic debugging 78

Debugging in the Script window 80

Debugging in the Message window 81

Debugging in the Object inspector 84

Debugging in the Debugger window 87

Debugging projectors and Shockwave movies 91

Advanced debugging 92

Chapter 5: Director Core Objects Cast Library 94

Global 95

Key 96

Member 97

Mixer 98

Mouse 99

Movie 100

Player 102

Sound 104

Sound Channel 106

Sprite 107

Sprite Channel 109

System 110

Window 111

Chapter 6: Media Types Animated GIF 114

Bitmap 115

Button 115

ByteArray 116

Color Palette 116

Cursor 117

DVD 118

Field 119

Film Loop 120

Flash Component 121

Flash Movie 121

Font 123

Linked Movie 123

MP4Media/FLV 124

QuickTime 125

RealMedia 126

Shockwave 3D 127

Shockwave Audio 128

Sound 129

Text 129

Vector Shape 130

Windows Media 131

Chapter 7: Scripting Objects Audio filters 133

ByteArray 147

Fileio 152

MUI Xtra 153

NetLingo 154

SpeechXtra 155

XML Parser 155

Chapter 8: 3D Objects

About 3D Objects 157

Camera 157

Group 158

Light 159

Member 160

Model 162

Model Resource 163

Motion 163

Renderer Services 164

Shader 164

Sprite 168

Texture 169

Chapter 9: Constants " (string) 170

BACKSPACE 170

EMPTY 171

ENTER 171

FALSE 172

PI 173

QUOTE 173

RETURN (constant) 174

SPACE 174

TAB 175

TRUE 176

VOID 176

Chapter 10: Events and Messages on activateApplication 178

on activateWindow 179

on beginSprite 179

on closeWindow 180

on cuePassed 181

on deactivateApplication 182

on deactivateWindow 183

on DVDeventNotification 184

on endSprite 187

on enterFrame 188

on EvalScript 189

on exitFrame 191

on getBehaviorDescription 192

on getBehaviorTooltip 193

on getPropertyDescriptionList 193

on hyperlinkClicked 195

on idle 196

on isOKToAttach 197

on keyDown 198

on keyUp 199

on mouseDown (event handler) 200

on mouseEnter 202

on mouseLeave 203

on mouseUp (event handler) 204

on mouseUpOutside 206

on mouseWithin 206

on moveWindow 207

on openWindow 208

on prepareFrame 208

on prepareMovie 209

on resizeWindow 210

on rightMouseDown (event handler) 211

on rightMouseUp (event handler) 211

on runPropertyDialog 212

on savedLocal 213

on sendXML 214

on startMovie 215

on stepFrame 216

on stopMovie 217

on streamStatus 218

on timeOut 219

trayIconMouseDoubleClick 220

trayIconMouseDown 221

trayIconRightMouseDown 221

on zoomWindow 222

Chapter 11: Keywords \ (continuation) 224

case 224

char of 225

end 226

end case 227

exit 227

exit repeat 228

field 228

global 229

if 230

INF 231

item of 232

line of 233

loop (keyword) 233

me 234

menu 235

next 236

next repeat 237

on 237

otherwise 238

property 239

put after 240

put before 240

put into 241

repeat while 241

repeat with 242

repeat with down to 243

repeat with in list 244

return (keyword) 245

set to, set = 246

sprite intersects 246

sprite within 247

version 248

word of 248

Chapter 12: Methods _system.gc() 250

abort 250

abs() 251

activateAtLoc() 252

activateButton() 252

add 253

add (3D texture) 254

addAt 255

addBackdrop 255

addCamera 256

addChild 257

addModifier 258

addOverlay 259

addProp 259

addToWorld 260

addVertex() 261

alert() 262

Alert() 263

append 264

applyFilter() 265

appMinimize() 265

atan() 266

beep() 267

beginRecording() 268

bitAnd() 269

bitNot() 270

bitOr() 271

bitXor() 272

breakLoop() 273

breakLoop (Sound Object) 273

browserName() 274

ByteArray 274

ByteArray(str) 275

build() 275

bumpMapToNormalMap() 277

cacheDocVerify() 277

cacheSize() 278

call 279

callAncestor 281

callFrame() 282

camera() 283

cameraCount() 284

cancelIdleLoad() 284

castLib() 285

channel() (Top level) 285

channel() (Sound) 286

chapterCount() 287

charPosToLoc() 287

chars() 288

charToNum() 289

clearAsObjects() 290

clearCache 290

clearError() 291

clearFrame() 292

clearGlobals() 293

clone 294

cloneDeep 295

cloneModelFromCastmember 295

cloneMotionFromCastmember 296

close() 297

closeFile() 298

closeXlib 298

color() 299

compress() 300

constrainH() 300

constrainV() 301

copyPixels() 302

copyToClipBoard() 304

cos() 305

count() 305

createMatte() 307

createSoundObject 308

crop() (Image) 309

crop() (Bitmap) 310

cross 310

crossProduct() 311

cursor() 312

date() (formats) 315

date() (System) 317

delay() 318

delete() 319

delete() (FileIO) 319

deleteFile() 320

deleteAt 320

deleteCamera 321

deleteFrame() 322

deleteGroup 323

deleteLight 323

deleteModel 324

deleteModelResource 324

deleteMotion 325

deleteOne 325

deleteProp 326

deleteShader 327

deleteSoundObject 327

deleteTexture 328

deleteVertex() 329

displayOpen() 329

displaySave() 330

do 330

doneParsing() 331

dot() 331

dotProduct() 332

downloadNetThing 333

draw() 334

duplicate() (Image) 335

duplicate() (list function) 335

duplicate() (Member) 336

duplicateFrame() 337

enableHotSpot() 338

enableSoundTrack(trackNum) 338

endRecording() 339

erase() 340

error() 341

externalEvent() 342

extrude3D 343

externalParamName() 344

externalParamValue() 346

extractAlpha() 347

fadeIn() 348

fadeOut() 348

fadeTo() 349

fileName() 350

fileOpen() 350

fileSave() 351

fill() 352

filter() 353

findLabel() 354

findEmpty() 354

findPos 355

findPosNear 356

finishIdleLoad() 357

flashToStage() 357

float() 358

floatP() 359

flushInputEvents() 360

forget() (Window) 360

forget() (Timeout) 361

framesToHMS() 362

frameReady() (Movie) 363

frameStep() 364

freeBlock() 364

freeBytes() 365

generateNormals() 365

getaProp 366

getAt 367

getCharSet 368

getError() (Flash, SWA) 369

getError() (XML) 371

getErrorString() 372

getFinderInfo() 373

getFlashProperty() 374

getFrameLabel() 374

getHardwareInfo() 375

getHotSpotRect() 376

getInstalledCharSets 376

GetItemPropList 377

getLast() 378

getLatestNetID 378

getLength() 379

getNormalized 381

getNthFileNameInFolder() 382

getOne() 383

getOSDirectory() 384

getPixel() 385

getPixels() 386

getPlayList() 388

getPos() 389

getPosition() 390

getPref() 391

getPref() (Player) 391

getProp() 392

getPropAt() 393

getPropRef() (JavaScript only) 393

getRendererServices() 394

getSoundObject() 395

getSoundObjectList 396

getStreamStatus() 397

getSystemCharSet 397

getURL() 398

getVal() 398

getVariable() 399

GetWidgetList() 401

GetWindowPropList 402

getWorldTransform() 403

go() 404

goLoop() 405

goNext() 406

goPrevious() 406

goToFrame() 407

gotoNetMovie 408

gotoNetPage 408

group() 409

halt() 410

handler() 410

handlers() 411

hilite (command) 411

hitTest() 412

HMStoFrames() 413

hold() 414

importByteArrayInto() 415

identity() 416

idleLoadDone() 416

ignoreWhiteSpace() 417

ilk() 418

ilk (3D) 420

image() 421

importFileInto() 422

Initialize 424

insertBackdrop 424

insertFrame() 425

insertOverlay 426

inside() 427

installMenu 427

integer() 428

integerP() 429

Interface() 429

interpolate() 430

interpolateTo() 430

intersect() 431

inverse() 432

invert() 432

isBusy() 433

isCharSetInstalled 434

isInWorld() 434

isPastCuePoint() 435

ItemUpdate() 436

keyPressed() 437

label() 439

last() 439

lastClick() 440

lastEvent() 440

length() 441

light() 442

lineHeight() 442

linePosToLocV() 443

linkAs() 443

list() 444

listP() 445

loadFile() 445

loadPolicyFile() 446

locToCharPos() 448

locVToLinePos() 449

log() 449

makeList() 450

makeScriptedSprite() 451

makeSubList() 452

map() 452

map (3D) 453

mapMemberToStage() 454

matrixAddition() 456

matrixMultiply() 456

matrixMultiplyScalar() 457

matrixTranspose() 458

max() 458

maximize() 459

mci 460

member() 460

mergeDisplayTemplate() 461

mergeProps() 462

mesh (property) 462

meshDeform (modifier) 464

min 465

minimize() 465

model (3D) 466

modelResource 467

modelsUnderLoc 467

modelsUnderRay 469

modelUnderLoc 470

motion() 471

move() 472

moveTo 472

moveToBack() 473

moveToFront() 474

moveVertex() 474

moveVertexHandle() 475

multiply() 476

mute (Mixer) 476

mute (Sound Object) 477

neighbor 477

netAbort 478

netByteArrayResult 479

netDone() 479

netError() 480

netLastModDate() 482

netMIME() 483

netStatus 484

netTextResult() 485

new() 486

newCamera 489

newColorRatio 489

newCurve() 490

newGroup 491

newLight 491

newMatrix() 492

newMember() 492

newMesh 493

newModel 495

newModelResource 495

newMotion() 496

newObject() 497

newProxyCallback() 498

newShader 499

newTexture 500

normalize 501

nothing 502

nudge() 503

numColumns() 504

numRows() 505

numToChar() 506

objectP() 507

offset() (string function) 507

offset() (rectangle function) 509

open() (Player) 509

open() (Window) 510

openFile() 511

openXlib 512

param() 512

paramCount() 513

parseByteArray 514

parseString() 514

parseString (XML Xtra) 515

parseURL() 515

parseURL (XML Xtra) 518

pass 518

pasteClipBoardInto() 519

pause() (DVD) 520

pause() (Mixer) 521

pause (MP4Media/FLV) 521

pause() (3D) 522

pause() (RealMedia, SWA, Windows Media) 523

pause() (Sound Channel) 523

pause (Sound Object) 524

perlinNoise() 524

perpendicularTo 526

pictureP() 527

play() (3D) 527

play() (DVD) 529

play() (Mixer) 530

play() (MP4Media/FLV) 531

play (Sound Object) 533

playFile() 534

playNext() (Sound Channel) 535

playNext() (3D) 535

playerParentalLevel() 536

point() 537

pointAt 538

pointInHyperlink() 539

pointToChar() 539

pointToItem() 540

pointToLine() 541

pointToParagraph() 542

pointToWord() 543

postNetByteArray 544

postNetText 545

power() 546

preLoad() (Member) 547

preLoad() (Movie) 548

preLoadBuffer() 549

preLoadMember() 550

preLoadMovie() 551

preloadNetThing() 551

preMultiply 552

preRotate 553

preScale() 554

preTranslate() 555

print() 556

printAsBitmap() 557

printFrom() 557

propList() 558

proxyServer 559

ptToHotSpotID() 560

puppetPalette() 561

puppetSprite() 562

puppetTempo() 563

puppetTransition() 564

put() 566

qtRegisterAccessKey() 567

qtUnRegisterAccessKey() 567

queue() 567

queue() (3D) 569

QuickTimeVersion() 570

quit() 570

ramNeeded() 571

random() 572

randomVector() 573

randomVector 574

rawNew() 574

readBoolean 575

readByteArray 575

readByteArray (FileIO Xtra) 576

readChar() 576

readFile() 577

readFloat32 578

readFloat64 578

readInt8 579

readInt16 579

readInt32 579

readLine() 580

readRawString 581

readString 581

readToken() 582

readWord() 582

realPlayerNativeAudio() 583

realPlayerPromptToInstall() 584

realPlayerVersion() 585

recordFont 586

rect() 587

registerByteArrayCallback 589

registerCuePointCallback 591

registerEndOfSpoolCallback() 592

registerForEvent() 593

registerScript() 595

removeBackdrop 596

removeFromWorld 597

removeLast() 597

removeModifier 598

removeOverlay 598

removeScriptedSprite() 599

renderToTexture 599

replaceMember 600

reset (Mixer) 601

resetWorld 601

resolveA 602

resolveB 602

restart() 603

restore() 603

result 604

resume() 605

returnToTitle() 605

rewind() (Sound Channel) 607

rewind() (Windows Media) 607

rewind() (Animated GIF, Flash) 608

rollOver() 608

rootMenu() 610

rotate 611

run 612

runMode 612

save (Mixer) 613

Save (Sound Object) 614

save castLib 614

saveMovie() 615

scale (command) 616

script() 617

scrollByLine() 618

scrollByPage() 618

seek() 619

seek(mSec) (MP4Media/FLV) 620

seek (Sound Object) 621

selectAtLoc() 621

selectButton() 622

selectButtonRelative() 622

selection() (function) 623

sendAllSprites() 624

sendEvent 625

sendSprite() 625

setAlpha() 626

setaProp 627

setAt 628

setCallback() 629

setCharSet 630

setCollisionCallback() 631

setFilterMask() 631

setFinderInfo() 632

setFlashProperty() 633

setNewLineConversion() 633

setPixel() 634

setPixels() 635

setPlayList() 637

setPosition() 638

setPref() 638

setPref() (Player) 640

setProp 641

setScriptList() 641

settingsPanel() 642

setTrackEnabled() 643

setVal() 643

setVariable() 644

showLocals() 646

showProps() 646

showGlobals() 647

shutDown() 648

sin() 648

sort 649

sound() 649

sprite() 650

spriteSpaceToWorldSpace 651

sqrt() 651

stageBottom 652

stageLeft 653

stageRight 653

stageToFlash() 654

stageTop 655

startSave (Mixer) 656

startSave (Sound Object) 656

status() 657

stop() (DVD) 657

stop() (Flash) 658

stop() (Mixer) 659

stop() (MP4Media/FLV) 660

stop() (RealMedia, SWA, Windows Media) 660

stop() (Sound Channel) 661

stop (Sound Object) 661

stop 662

stopEvent() 662

stopSave (Mixer) 663

stopSave (Sound Object) 664

stream() 664

string() 666

stringP() 666

subPictureType() 667

substituteFont 668

swing() 668

symbol() 669

symbolP() 670

tan() 670

tellStreamStatus() 671

tellTarget() 672

time() (System) 673

timeout() 674

top (3D) 676

topCap 676

topRadius 677

trace() 677

transform (command) 678

translate 679

uncompress() 680

union() 680

unLoad() (Member) 681

unLoad() (Movie) 682

unLoadMember() 683

unLoadMovie() 684

unmute (Mixer) 684

unmute (Sound Object) 685

unregisterAllEvents 685

unregisterByteArrayCallback 686

unregisterCuePointCallback 687

unregisterEndOfSpoolCallback() 687

update 688

updateFrame() 688

updateStage() 689

URLEncode 690

value() 691

vector() 692

version() 693

voiceCount() 693

voiceGet() 694

voiceGetAll() 695

voiceGetPitch() 696

voiceGetRate() 696

voiceGetVolume() 697

voiceInitialize() 697

voicePause() 698

voiceResume() 699

voiceSet() 699

voiceSetPitch() 700

voiceSetRate() 701

voiceSetVolume() 701

voiceSpeak() 702

voiceState() 702

voiceStop() 703

voiceWordPos() 704

voidP() 705

window() 705

WindowOperation 706

windowPresent() 707

worldSpaceToSpriteSpace 707

writeBoolean 708

writeByteArray 708

writeByteArray (FileIO Xtra) 709

writeChar() 709

writeFloat32 710

writeFloat64 711

writeInt8 711

writeInt16 711

writeInt32 712

writeRawString 712

writeReturn() 713

writeString() 714

writeString (byte array) 714

xtra() 715

zoomBox 716

Chapter 13: Operators # (symbol) 717

(dot operator) 718

- (minus) 719

(comment) 720

&, + (concatenation operator) 720

&&, + (concatenation operator) 721

() (parentheses) 722

* (multiplication) 723

+ (addition) 724

+ (addition) (3D) 724

- (minus) (3D) 725

* (multiplication (3D)) 725

/ (division) 725

/ (division) (3D) 726

< (less than) 726

<= (less than or equal to) 727

<> (not equal) 727

= (equals) 728

> (greater than) 728

>= (greater than or equal to) 728

[ ] (bracket access) 729

[ ] (list) 729

@ (pathname) 731

and 732

contains 733

mod 734

not 736

Random Access Operator 737

starts 738

String 738

Chapter 14: Properties _global 740

_key 740

_mouse 741

_movie 742

_player 742

_sound 743

_system 744

aboutInfo 744

actionsEnabled 745

active3dRenderer 746

activeCastLib 746

activeWindow 747

actorList 748

alertHook 749

alignment 750

allowCustomCaching 751

allowGraphicMenu 751

allowSaveLocal 752

allowTransportControl 752

allowVolumeControl 753

allowZooming 753

alphaSort (shader) 754

alphaThreshold 754

ambient 754

ambientColor 755

ancestor 756

angle (3D) 757

angle (DVD) 757

angleCount 758

animationEnabled 758

antiAlias 759

antiAliasingEnabled 760

antiAliasingMode 760

antiAliasingSupported 761

antiAliasThreshold 761

antiAliasType 762

appearanceOptions 763

applicationName 764

applicationPath 765

aspectRatio 765

attenuation 766

attributeName 766attributeValue 767audio (DVD) 768audio (MP4Media/FLV) 768audio (RealMedia) 769audio (Windows Media) 770audioChannelCount 770audioExtension 771audioFormat 771audioSampleRate 772audioStream 772audioStreamCount 773auto 773autoblend 774autoCameraPosition 774autoMask 775autoTab 776axisAngle 776back 777backColor 777backdrop 778backgroundColor 779beepOn 780bevelDepth 781bevelType 781bgColor (Window) 782bgColor (Sprite, 3D Member) 783bias 783bitDepth (Mixer) 784bitDepth (Sound Object) 784bitmapSizes 785bitRate 785bitsPerSample 786blend (3D) 787blend (Sprite) 787blendConstant 788blendConstantList 789blendFactor 789blendFunction 790blendFunctionList 791blendLevel 792blendRange 792blendSource 793blendSourceList 793

bonesPlayer (modifier) 795border 797bottom 797bottom (3D) 798bottomCap 798bottomRadius 799bottomSpacing 799boundary 800boundingSphere 800boxDropShadow 801boxType 801brightness 802broadcastProps 802bufferSize 803bufferSize (Mixer) 804buttonCount 805buttonsEnabled 805buttonStyle 806buttonType 806byteArray 807BytesRemaining 807bytesStreamed 808bytesStreamed (3D) 809camera 809cameraPosition 810cameraRotation 810castLib 811castLibNum 811castMemberList 812center 813centerRegPoint 813centerStage 814changeArea 815channel 815channelCount (Mixer) 816channelCount (Sound Channel) 817channelCount (Sound Object) 817chapter 818chapterCount 818characterSet 819charSpacing 819checkMark 820child (3D) 821child (XML) 822chunkSize 822clearAtRender 823

clearValue 823clickLoc 824clickMode 824clickOn 825closed 826closedCaptions 827collision (modifier) 827collisionData 828collisionNormal 829color() 831color (fog) 832color (light) 833colorBufferDepth 833colorDepth 834colorList 835colorRange 836colors 836colorSteps 837commandDown 838comments 839compressed 839connectionStatus (MP4Media/FLV) 840connectionStatus (Sound Object) 840constraint 841controlDown 842controller 843copyrightInfo (Movie) 844copyrightInfo (SWA) 844count 845count (3D) 846count (castLib) 847cpuHogTicks 847creaseAngle 848creases 849creationDate 849crop 850cuePointNames 850cuePointTimes 851currentLoopState 851currentSpriteNum 852currentTime (3D) 853currentTime (DVD) 854currentTime (QuickTime, AVI) 854currentTime (MP4Media/FLV) 855

currentTime (Sprite) 857cursor 858cursorSize 861curve 862debug 863debugPlaybackEnabled 863decayMode 864defaultRect 864defaultRectMode 865density 866depth (3D) 867depth (Bitmap) 868depthBufferDepth 869deskTopRectList 869diffuse 870diffuseColor 871diffuseLightMap 871digitalVideoTimeScale 872digitalVideoType 873direction 873directionalColor 874directionalPreset 874directToStage 875directToStage (MP4Media/FLV) 876disableImagingTransformation 877displayFace 877displayMode 878displayRealLogo 879displayTemplate 879distribution 881dither 881dockingEnabled 882domain 883doubleClick 883drag 884drawRect 884dropShadow 885duration (3D) 886duration (DVD) 886duration (Member) 887duration (MP4Media/FLV) 887duration (RealMedia, SWA) 888editable 889editShortCutsEnabled 890elapsedTime 890elapsedTime (Mixer) 891

elapsedTime (Sound Object) 891emissive 892emitter 893emulateMultibuttonMouse 894enabled 894enabled (collision) 895enabled (filter) 895enabled (fog) 896enabled (sds) 896enableFlashLingo 897endAngle 897endColor 898endFrame 899endian 899endTime (Sound Channel) 900endTime (Sound Object) 900environmentPropList 901error 902eventPassMode 903exitLock 904externalParamCount 905face 906face[ ] 907far (fog) 907fieldOfView 908fieldOfView (3D) 908fileFreeSize 909fileName (Cast) 909fileName (Member) 910fileName (MP4Media/FLV) 911fileName (Window) 912fileSize 913fileVersion 913fillColor 914fillCycles 915fillDirection 915filled 916fillMode 917fillOffset 917fillScale 918filterlist 919filterList (Mixer) 919filterList (Sound Object) 920firstIndent 920

fixStageSize 922flashRect 923flat 924flipH 924flipV 925floatPrecision 925fog 927folder 927font 929fontSize 929fontStyle 930foreColor 932frame 932frameCount 933frameLabel 933framePalette 934frameRate 935frameRate (DVD) 936frameRate (MP4Media/FLV) 937frameScript 937frameSound1 938frameSound2 938frameTempo 939frameTransition 939front 940frontWindow 940fullScreen 941getBoneID 941globals 942glossMap 942gravity 943gradientType 944group 944height 945height (3D) 946height (MP4Media/FLV) 946heightVertices 947highlightPercentage 947highlightStrength 948hilite 949hinting 949hither 950hotSpot 950hotSpotEnterCallback 951hotSpotExitCallback 952HTML 952

hyperlink 953hyperlinkRange 954hyperlinks 954hyperlinkState 955idleHandlerPeriod 956idleLoadMode 957idleLoadPeriod 957idleLoadTag 958idleReadChunkSize 959image (Image) 959image (RealMedia) 960image (Render to Texture) 960image (MP4Media/FLV) 961image (Window) 961imageCompression 962imageEnabled 963imageQuality 964immovable 965ink 965inker (modifier) 966inlineImeEnabled 967interval 968invertMask 969isPlayable (MP4Media/FLV) 969isSaving (Mixer) 970isSaving (Sound Object) 970isVRMovie 971itemDelimiter 972kerning 973kerningThreshold 973key 974keyboardFocusSprite 975keyCode 976keyDownScript 977keyframePlayer (modifier) 978keyUpScript 979labelList 980lastChannel 980lastClick 981lastError 981lastEvent 982lastFrame 983lastKey 983lastRoll 984

leftIndent 985length (byte array) 986length (3D) 986lengthVertices 987level 987lifetime 988light 988lightInclusionList 989lightExclusionList 989lineColor 990lineCount 991lineDirection 991lineHeight 992lineOffset 992lineSize 993linked 993loaded 994loc (backdrop and overlay) 995locH 995lockTranslation 996locV 996locZ 997lod (modifier) 998loop (3D) 999loop (emitter) 999loop (Member) 1000loop (MP4Media/FLV) 1000loop (Flash) 1000loop (Windows Media) 1001loopBounds 1002loopCount 1003loopCount (Sound Object) 1004loopEndTime (Sound Channel) 1004loopEndTime (Sound Object) 1005loopsRemaining 1006loopsRemaining (Sound Object) 1006loopStartTime 1007loopStartTime (Sound Object) 1007magnitude 1008margin 1008markerList 1009mask 1009maxInteger 1010maxSpeed 1011media 1011mediaReady 1012

mediaStatus (DVD) 1013mediaStatus (MP4Media/FLV) 1013mediaStatus (RealMedia, Windows Media) 1014mediaXtraList 1015member 1016member (Cast) 1016member (Movie) 1017member (Sound Channel) 1017member (Sound Object) 1018member (Sprite) 1018memorySize 1020meshDeform (modifier) 1020milliseconds 1021minSpeed 1022missingFonts 1022mixer 1023mode (emitter) 1023mode (collision) 1024model 1024modelA 1025modelB 1026modelResource 1027modified 1027modifiedBy 1028modifiedDate 1029modifier 1029modifier[] 1030modifiers 1030mostRecentCuePoint 1031mostRecentCuePoint (Sound Object) 1031motion 1032motionQuality 1033mouseChar 1033mouseDown 1034mouseDownScript 1035mouseH 1036mouseItem 1037mouseLevel 1038mouseLine 1039mouseLoc 1039mouseMember 1040mouseOverButton 1041mouseUp 1042mouseUpScript 1043

moveableSprite 1046movie 1047multiSound 1047name 1048name (3D) 1048name (menu property) 1049name (menu item property) 1049name (Mixer) 1050name (Sound Object) 1050name (Sprite) 1051name (Sprite Channel) 1052name (timeout) 1052name (XML) 1053near (fog) 1053nearFiltering 1054netPresent 1055netThrottleTicks 1055node 1056nodeEnterCallback 1056nodeExitCallback 1057nodeType 1058normalList 1058normals 1059number (Cast) 1060number (characters) 1060number (items) 1061number (lines) 1061number (Member) 1062number (menus) 1063number (menu items) 1064number (Sprite Channel) 1064number (system) 1065number (words) 1065number of members 1066number of xtras 1066numBuffersToPreload 1066numChannels 1067numParticles 1068numSegments 1068obeyScoreRotation 1069optionDown 1069organizationName 1070originalFont 1071originH 1072originMode 1073originPoint 1074

originV 1075orthoHeight 1076overlay 1076pageHeight 1077palette 1077paletteMapping 1078paletteRef 1079pan 1079pan (QTVR property) 1080panMatrix, toChannels, and useMatrix (Mixer) 1080panMatrix, toChannels, and useMatrix (Sound Object) 1082paragraph 1083parent 1084password 1084path (Movie) 1085path (3D) 1086pathName (Flash member) 1086pathStrength 1087pattern 1088pausedAtStart (Flash, Digital video) 1088pausedAtStart (MP4Media/FLV) 1089pausedAtStart (RealMedia, Windows Media) 1089percentBuffered 1091percentPlayed 1092percentStreamed (3D) 1092percentStreamed (Member) 1093percentStreamed (MP4Media/FLV) 1094percentStreamed (Sound Object) 1094period 1095persistent 1095picture (Member) 1096picture (Window) 1097platform 1097playBackMode 1098playing 1099playing (3D) 1099playlist 1100playRate (3D) 1100playRate (DVD) 1101playRate (QuickTime, AVI, MP4, FLV) 1101playRate (Sound Object) 1102playRate (Windows Media) 1103pointAtOrientation 1103pointOfContact 1104

positionReset 1106posterFrame 1106preferred3dRenderer 1107preLoad (3D) 1108preLoad (Member) 1108preLoadEventAbort 1109preLoadMode 1109preLoadRAM 1110preLoadTime 1111primitives 1112productName 1112productVersion 1113projection 1113purgePriority 1114quad 1115quality 1115quality (3D) 1116radius 1117randomSeed 1118recordFont 1118rect (camera) 1119rect (Image) 1120rect (Member) 1121rect (Sprite) 1121rect (Window) 1122ref 1122reflectionMap 1123reflectivity 1124region 1124regPoint 1125regPoint (3D) 1126regPointVertex 1126renderer 1127rendererDeviceList 1127renderFormat 1128renderStyle 1129resizable 1129resolution (3D) 1130resolution (DVD) 1130resolve 1131resource 1131right 1132right (3D) 1132rightIndent 1133rightMouseDown 1133rightMouseUp 1134

romanLingo 1134rootLock 1135rootNode 1135rotation 1136rotation (backdrop and overlay) 1137rotation (engraver shader) 1138rotation (transform) 1138rotationReset 1139RTF 1139safePlayer 1140sampleCount (Sound Channel) 1141sampleCount (Sound Object) 1142sampleRate (Mixer) 1142sampleRate (Sound Channel) 1143sampleRate (Sound Object) 1143sampleSize 1144savew3d 1145saveWorld 1145scale (3D) 1146scale (backdrop and overlay) 1146scaleX (backdrop and overlay) 1147scaleY (backdrop and overlay) 1147scale (Member) 1147scale (transform) 1149scaleMode 1149score 1150scoreColor 1151scoreSelection 1151script 1152scripted 1153scriptingXtraList 1154scriptInstanceList 1154scriptList 1155scriptNum 1155scriptsEnabled 1156scriptSyntax 1156scriptText 1157scriptType 1157scrollTop 1158sds (modifier) 1159searchCurrentFolder 1160searchPathList 1161selectedButton 1162selectedText 1162

selEnd 1164selStart 1165serialNumber 1166shader 1166shaderList 1167shadowPercentage 1168shadowStrength 1169shapeType 1169shiftDown 1170shininess 1170silhouettes 1171size 1171sizeRange 1172sizeState 1172skew 1173smoothness 1174sound (Member) 1175sound (Player) 1175soundChannel (SWA) 1176soundChannel (RealMedia) 1177soundDevice 1178soundDeviceList 1178soundEnabled 1179soundKeepDevice 1179soundLevel 1180soundMixMedia 1181soundObjectList 1182source 1182sourceFileName 1183sourceRect 1183specular (light) 1184specular (shader) 1184specularColor 1185specularLightMap 1185spotAngle 1186spotDecay 1187sprite (Movie) 1187sprite (Sprite Channel) 1188spriteNum 1188stage 1189stage (Flash Sprite property) 1190startAngle 1190startFrame 1191startTime (Sound Channel) 1192startTime (Sound Object) 1192startTimeList 1193

state (3D) 1194state (Flash, SWA) 1195state (RealMedia) 1196static 1197staticQuality 1198status 1199status (Mixer) 1199status (Sound Object) 1200stillDown 1201stopTime 1201stopTimeList 1202streamMode 1203streamName 1204streamSize 1204streamSize (3D) 1205strokeColor 1205strokeWidth 1206style 1206subdivision 1207subPicture 1208subPictureCount 1208suspendUpdates 1208switchColorDepth 1209systemTrayIcon 1210systemTrayTooltip 1211tabCount 1211tabs 1212target 1212targetFrameRate 1213tension 1213text 1214texture 1215textureCoordinateList 1216textureCoordinates 1216textureLayer 1217textureList 1217textureMember 1218textureMode 1218textureModeList 1219textureRenderFormat 1220textureRepeat 1221textureRepeatList 1222textureTransform 1223textureTransformList 1225

tilt 1228time (timeout object) 1228timeoutHandler 1229timeoutList 1230timeScale 1230title (DVD) 1231title (Window) 1231titlebarOptions 1232titleCount 1233toolXtraList 1233toon (modifier) 1234top 1235topSpacing 1235traceLoad 1236traceLogFile 1237traceScript 1237trackCount (Member) 1238trackCount (Sprite) 1238trackEnabled 1239trackInfo 1239trackNextKeyTime 1240trackNextSampleTime 1241trackPreviousKeyTime 1241trackPreviousSampleTime 1242trackStartTime (Member) 1242trackStartTime (Sprite) 1243trackStopTime (Member) 1243trackStopTime (Sprite) 1244trackText 1244trackType (Member) 1245trackType (Sprite) 1245trails 1246transform (property) 1247transitionType 1248transitionXtraList 1248translation 1249transparent 1250triggerCallback 1251trimWhiteSpace 1252tunnelDepth 1253tweened 1253tweenMode 1254type (light) 1254type (Member) 1255type (model resource) 1256type (motion) 1257

type (shader) 1258type (sprite) 1258type (texture) 1259type (Window) 1259updateLock 1260updateMovieEnabled 1261updateRTImageOnRender 1261URL 1262useAlpha 1262useDiffuseWithTexture 1263useFastQuads 1264useHypertextStyles 1264useLineOffset 1265userData 1265userName 1266userName (RealMedia) 1267useTargetFrameRate 1268vertex 1269vertexList 1269vertexList (mesh generator) 1270vertexList (mesh deform) 1271vertices 1271video (QuickTime, AVI) 1272video (MP4Media/FLV) 1272video (RealMedia, Windows Media) 1273videoFormat 1274videoForWindowsPresent 1274viewH 1275viewPoint 1276viewScale 1277viewV 1278visible 1279visible (sprite) 1280visibility 1280volume (DVD) 1281volume (Member) 1281volume (Mixer) 1282volume (MP4Media/FLV) 1282volume (Sound Channel) 1283volume (Sound Object) 1283volume (Sprite) 1284volume (Windows Media) 1285warpMode 1285width 1286

widthVertices 1288wind 1288window 1288windowBehind 1289windowInFront 1290windowList 1290wordWrap 1291worldPosition 1291worldTransform 1292wrapTransform 1292wrapTransformList 1293

x (vector) 1294xAxis 1294xtra 1295xtraList (Movie) 1295xtraList (Player) 1296

y (vector) 1297yAxis 1297yon 1297

z (vector) 1298zAxis 1298

Chapter 15: Physics Engine

Physics World properties 1300Physics World methods 1306Rigid Body management methods 1310Rigid Body properties 1318Rigid Body methods 1329Constraint methods 1332Constraint properties 1338Spring properties 1342Collision and Collision Callback methods 1346Terrain methods 1352Terrain properties 1354

6 DOF joint methods 13586DOF properties 1359Character Controller methods 1376Character Controller Callback methods 1379Character Controller properties 1382Cloth methods 1384Cloth properties 1391RayCasting methods 1401Error Codes 1403

Index 1405

Chapter 1: Introduction

This reference provides conceptual and how-to information about scripting in Adobe® Director® 11, and also provides reference descriptions and examples for the scripting application programming interfaces (APIs) that you use to write scripts.

The scripting APIs are the means by which you access the functionality of Director through script to add interactivity

to a movie By using these APIs, you can create interactive functionality that is identical to that provided by the prewritten behaviors that are shipped with Director, in addition to functionality that is more powerful and more varied than that provided by the prewritten behaviors.

The prewritten behaviors enable you to add basic interactive functionality to a movie, such as moving the playhead to

a frame number or marker, or zooming in when a user clicks a sprite They also enable non-interactive functionality such as sprite animation, media loading, and frame navigation The scripting APIs enable you to extend and customize these types of functionality.

Intended audience

This reference is intended for you if you want to do any of the following:

• Extend the existing functionality of prewritten behaviors by using script.

• Add functionality to a movie by using script instead of prewritten behaviors.

• Add more powerful, varied, and custom functionality to a movie than that provided by prewritten behaviors This reference is intended to provide all the information, from basic to advanced, you need to add interactivity to your movies by using script Therefore, you do not need to have any prior scripting experience to write effective scripts in Director.

Regardless of your experience level with Director, Lingo, or JavaScript™ syntax, take a few moments to browse

“ Director Scripting Essentials ” on page 4 and “ Writing Scripts in Director ” on page 42 before you begin writing scripts Like any product, Director has its own unique set of scripting conventions, types of data, and so on You will need to

be comfortable with these unique characteristics of Director before you can write effective scripts.

What’s new with Director scripting

If you have written scripts in previous versions of Director, you should note some new and important changes about scripting in this latest release.

Parallax mapping Parallax mapping is an enhancement of Normal/Bump Mapping technique This technique

provides more apparent depth and greater realism with less impact on the performance For more information, see Parallax Mapping

Cube mapping Cube mapping is a method of using a six-sided cube as the shape of the map The model is projected onto the six faces of a cube and stored as six square textures, or unfolded into six regions of a single texture For more information, see Cube Mapping