startDrag()

Availability

Flash Player 4.

Usage

startDrag(target,[lock, left, top, right, bottom])

Parameters

target The target path of the movie clip to drag.

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

Function; makes the target movie clip draggable while the movie is playing. Only one movie clip can be dragged at a time. Once a startDrag() operation is executed, the movie clip remains draggable until explicitly stopped by stopDrag(), or until a startDrag() action for another movie clip is called.

Example

To create a movie clip that users can position in any location, attach the startDrag() and stopDrag() actions to a button inside the movie clip.

on(press) {
  startDrag(this,true);
}
on(release) {
  stopDrag();
}

See also

MovieClip._droptarget, MovieClip.startDrag(), stopDrag()