MovieClip Class Extensions

hitTest () method

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

Scaleform version: 2.1.51

The standard 3-parameters hitTest has an optional boolean parameter as an extension, indicating whether to ignore invisible children clips or not. The default Flash behavior of hitTest is to return true, even if the point at x, y coordinates belongs to an invisible child clip (i.e. its _visible property is set to false; child clips with _alpha set to zero are not treated as invisible).

Parameters
ignoreInvisibleChildren:Boolean – Should be set to true to ignore all invisible child clips.

hitTestDisable property

hitTestDisable:Boolean [read-write]

Scaleform version: 1.2.32

When set to true, the MovieClip.hitTest function will ignore this movie clip during hit test detection. In addition, all other mouse events are not propagated to the movie clip.

The default value is false.

See also:

TextField.hitTestDisable
Button.hitTestDisable

noAdvance property

noAdvance : Boolean

Scaleform version: 2.1.52

If set to true, this property turns off advancing of this movie clip and all of its children. This might be used to improve performance. Note: Flash always advances movie clips (executes timeline animation, invokes frame’s ActionScript code and so on). Thus, setting this property to true may lead to differences in behavior between Scaleform and Flash.

See also:

_global.noInvisibleAdvance

topmostLevel property

topmostLevel:Boolean [read-write]

Scaleform version: 2.1.50

If the property is set to true then this character will be displayed on the top of all other ones regardless of its depth. This might be useful for implementing custom mouse cursors when the cursor should be drawn above objects from all levels. The default value is false.

In case of marking several characters as "topmostLevel", the draw order is as follows:

• Up to Scaleform 3.0.71, the draw order of characters marked as "topmostLevel" depend on the order of setting this property to true (thus, the character first marked as topmost will be drawn first);
• Starting from Scaleform 3.0.72, the draw order is the same as it would be without marking the characters topmost, i.e. if objectA was drawn underneath the objectB, then after making them topmost the objectA will still be under objectB, regardless of the order of setting "topmostLevel" property to true. Note: Once a character is marked as "topmostLevel", the swapDepth ActionScript function will not have any effect on this character.

Note: Only transformation properties will be inherited from the character's current parent while this property is set to true. This means that other properties of the parent and ancestor nodes will no longer be applied to the topmostLevel node, including visibility, ColorTransform, filters, etc. If these properties are desired, they should be propagated on a case-by-case basis by querying them from the parent, and applying them to the topmostLevel child in Actionscript.

See also:

TextField.topmostLevel
Button.topmostLevel

rendererString property

rendererString:String [read-write]

Scaleform version: 2.2.55

This property allows custom directives to be sent to the renderer from ActionScript for any MovieClip instance. If the property is set, the string value will be sent to the renderer as user data.

There is no default value.

Example:

myMovieInstance.rendererString = "SHADER_Blur"

rendererFloat property

rendererFloat:Number [read-write]

Scaleform version: 2.2.55

This property allows custom directives to be sent to the renderer from ActionScript for any MovieClip instance. If the property is set, the float value will be sent to the renderer as user data.

There is no default value.

Example: myMovieInstance.rendererFloat = 4; // eg: C++ enum value

disableBatching property

disableBatching:Boolean

Scaleform version: 4.0.17

This property disables batching of mesh generation for custom drawing.

focusGroupMask property

focusGroupMask : Number

Scaleform version: 3.3.84

This property sets a bitmask to a stage character and ALL of its children. This bitmask assigns focus group ownership to the character, meaning only the controllers denoted in the bitmask are able to move focus into and within the character. Focus groups can be associated with controllers by using setControllerFocusGroup extension method.

For example, let’s assume that “button1” is to be focusable only by controller 0 and “movieclip2” by controllers 0 and 1. To achieve this behavior, associate focus groups with the controllers:

Selection.setControllerFocusGroup(0, 0);
Selection.setControllerFocusGroup(1, 1);

button1.focusGroupMask = 0x1; // bit 0 – focus group 0
movieclip2.focusGroupMask = 0x1 | 0x2 // bits 0 and 1 – focus groups 0 and 1

The “focusGroupMask” bitmask may be set to the parent movieclip. This will propogate the mask value to all of its children.