User Guide

MovieClip 867
getNextHighestDepth
(MovieClip.getNextHighestDepth method)
public getNextHighestDepth() : Number
Determines a depth value that you can pass to MovieClip.attachMovie(),
MovieClip.duplicateMovieClip(), or MovieClip.createEmptyMovieClip() to ensure
that Flash renders the movie clip in front of all other objects on the same level and layer in the
current movie clip. The value returned is 0 or larger (that is, negative numbers are not
returned).
You can extend the methods and event handlers of the MovieClip class by creating a subclass.
Availability: ActionScript 1.0; Flash Player 7
Returns
Number - An integer that reflects the next available depth index that would render above all
other objects on the same level and layer within the movie clip.
Example
The following example draws three movie clip instances, using the
getNextHighestDepth()
method as the
depth parameter of the createEmptyMovieClip() method, and labels each
movie clip them with its depth:
for (i = 0; i < 3; i++) {
drawClip(i);
}
function drawClip(n:Number):Void {
this.createEmptyMovieClip("triangle" + n, this.getNextHighestDepth());
var mc:MovieClip = eval("triangle" + n);
mc.beginFill(0x00aaFF, 100);
mc.lineStyle(4, 0xFF0000, 100);
mc.moveTo(0, 0);
mc.lineTo(100, 100);
mc.lineTo(0, 100);
mc.lineTo(0, 0);
mc._x = n * 30;
mc._y = n * 50
mc.createTextField("label", this.getNextHighestDepth(), 20, 50, 200, 200)
NOTE
If you are using version 2 components, do not use this method. If you place a version 2
component either on the Stage or in the Library, the
getNextHighestDepth() method can
sometimes return depth 1048676, which is outside the valid range, If you are using
version 2 components, you should always use the version 2 components DepthManager
class.