setMask()
Top  Previous  Next


SWiSH Player Support
SWF6 or later - Not Supported (Use File | Test | Browser/Player)

Syntax
mySprite.setMask(maskSprite)

Arguments
mySprite; The instance name of a Sprite that will be masked.
maskSprite;
The instance name of a Sprite to be used as a mask.

Returns
Nothing.

Description
Method; makes the Sprite specified in the maskSprite argument a mask that reveals the Sprite specified in the mySprite argument.

Method; makes the movie clip in the parameter maskMovieClip into a mask that reveals the movie clip specified by the myMovieClip parameter. A Sprite cannot be used as its own mask, eg. mySprite.setMask(mySprite). The setMask method will allow Sprites with complex content to be used as a mask; however, device fonts will not be masked.

To disable a mask created with the setMask method, set the maskSprite argument to 'null', eg. mySprite.setMask(null)