MovieClip.hitTest()

my_mc.hitTest(x:Number, y:Number, shapeFlag:Boolean) : Boolean
my_mc.hitTest(target:Object) : Boolean

square_mc.onPress = function() {
   this.startDrag();
};
square_mc.onRelease = function() {
   this.stopDrag();
   if (this.hitTest(circle_mc)) {
      trace("you hit the circle");
   }
};

MovieClip.getBounds(), MovieClip.globalToLocal(), MovieClip.localToGlobal() 

Comments

helentriolo said on Aug 27, 2005 at 11:39 AM :

Why is the target parameter described like this on this page? "The target path of the hit area that may intersect or overlap with the instance specified by my_mc. The target parameter usually represents a button or text-entry field." When I've used this form of hitTest, target is another movieclip and never a 'button or text-entry field' -- can you provide an example of what you mean?

No screen name said on Sep 2, 2005 at 5:51 AM :

It would be nice to see an example of hitTest() used with the x, y and shapeflag parameters.

swartz1999 said on Oct 20, 2005 at 11:51 PM :

Hi, helentriolo. You are correct: you can specify a movie clip as the target parameter. The example provided illustrates this.

Here's an example that shows how to specify a text field as a target:

createEmptyMovieClip("square_mc", getNextHighestDepth());
createTextField("sampleText", getNextHighestDepth(), 150, 75, 100, 100);
sampleText.text = "Sample text"
square_mc.beginFill(0x006090);
square_mc.moveTo(50, 50);
square_mc.lineTo(50, 100);
square_mc.lineTo(100, 100);
square_mc.lineTo(100, 50);
square_mc.lineTo(50, 50);

square_mc.onPress = function() {
this.startDrag();
};
square_mc.onRelease = function() {
this.stopDrag();
if (this.hitTest(sampleText)) {
trace("Hit.");
}
};

swartz1999 said on Oct 20, 2005 at 11:57 PM :

Here is the signature of the first usage described:

public hitTest(x:Number, y:Number, [shapeFlag:Boolean]):Boolean

The second usage takes only one parameter: the target object.

Here is an example that shows the first usage (with three parameters). It uses the hitTest() method to determine if the triangle_mc movie clip overlaps the point (100, 75) (about 50 pixels to the right of the center of the initial position of the triangle) when the user releases the mouse button:

createEmptyMovieClip("triangle_mc", getNextHighestDepth());
triangle_mc.beginFill(0x006090);
triangle_mc.moveTo(50, 50);
triangle_mc.lineTo(100, 150);
triangle_mc.lineTo(0, 150);
triangle_mc.lineTo(50, 50);

var hit_X = 100;
var hit_Y = 75;
var shapeFlag = true;

triangle_mc.onPress = function() {
this.startDrag();
};

triangle_mc.onRelease = function() {
this.stopDrag();
if (this.hitTest(hit_X, hit_Y, shapeFlag)) {
trace("Hit.");
}
};