MovieClip.startDrag()

Availability

Flash Player 5.

Usage

my_mc.startDrag([lock:Boolean, [left:Number, top:Number, right:Number, bottom:Number]]) : Void

Parameters

lock A Boolean value specifying whether the draggable movie clip is locked to the center of the mouse position (true), or locked to the point where the user first clicked on the movie clip (false). This parameter is optional.

left, top, right, bottom Values relative to the coordinates of the movie clip's parent that specify a constraint rectangle for the movie clip. These parameters are optional.

Returns

Nothing.

Description

Method; lets the user drag the specified movie clip. The movie clip remains draggable until explicitly stopped through a call to MovieClip.stopDrag(), or until another movie clip is made draggable. Only one movie clip is draggable at a time.

You can extend the methods and event handlers of the MovieClip class by creating a subclass. For more information, see "Assigning a class to a movie clip symbol" in Using ActionScript in Flash.

Example

The following example creates a draggable movie clip instance called image_mc. A MovieClipLoader object is used to load an image into image_mc.

this.createEmptyMovieClip("image_mc", 1);
var mclListener:Object = new Object();
mclListener.onLoadInit = function(target_mc:MovieClip) {
   target_mc.onPress = function() {
      this.startDrag();
   };
   target_mc.onRelease = function() {
      this.stopDrag();
   };
};
var image_mcl:MovieClipLoader = new MovieClipLoader();
image_mcl.addListener(mclListener);
image_mcl.loadClip("http://www.macromedia.com/devnet/blueprint/articles/nielsen/spotlight_jnielsen.jpg", image_mc);