My account
Shopping cart
Knowledge base
Support


MCTE V3 Properties



Overview | Properties | Methods | Events | Built in Patterns | XML | Data Model Diagram

Most these properties can be set in the Component Inspector (Alt + F7), also be set from XML, using the xmlPath optional parameter.

Property Type
Component Inspector
Description
_targetInstanceName String
Yes
A string, linking to the instance on which the effect will be applied.

When drag&dropping the MCTE to the stage, over a MovieClip, it automatically updates this property to the MovieClip’s instance name.

Usage:
mcteInstance._targetInstanceName = "myMcName";
autoPlay Boolean
Yes
A boolean parameter that handles the automated transition.

This should be set to true, if you use frame animation, and/or if you are not using actionscript to start the transition effect.

Also when using the MCTE along with the Loader Pro V3, autoPlay should be left "true" and the Loader’s transitionType should be set to "none".

Default: true

Usage:
mcteInstance.autoPlay = false;
customParam1
customParam2

customParam3
customParam4
customParam5
String
Yes
customParams are used by every pattern in order to create the transition effect. depending on the type of the pattern, the customParams may be used for a different type of parameter.

Think about the customParam like a free slot, where you can plug your params in order to use the effect.

Usage:
mcteInstance.customParam1 = "30";
mcteInstance.customParam1 = "false";
customPattern String
Yes
The name of the custom pattern that will be used to perform the transition effect.

In order to use this parameter you need to set the patternName property value to customPattern.

Usage
mcteInstance.patternName = "customPattern";
mcteInstance.customPattern = "Genie";
easeType String
Yes
Sets the ease type for the sliding transition tween. Values: [easeOut, easeIn, easeInOut, none].

Default: easeOut

Usage:
mcteInstance.easeType = "easeOut";
gain Number
Yes
Most patterns will mainly depend on the gain param, the gain is a number, that will be used by every pattern differently.

In some cases the gain signifies the speed of an effect, in others it may signify the height of a mask that is applied during the effect, the percentage of effect applied, and so on.

gain is separately documented for each effect, however a value of 50 will work for most of them.

Default:100

Usage:
mcteInstance.gain = 50;
patternName String
Yes
The name of the pattern that will be used to perform the transition effect. Values: [ customPattern, Alpha, Blur, Color, Scale, Slide, SquareScale, Waves, Stripes, AlphaBars]

Default: SquareScale

Usage:
mcteInstance.patternName = "AlphaBars";
preset Polymorphic (String,Number)
Yes
The value of the preset that will be used for the selected pattern.

Since the values may differ from a pattern to another, we used polymorphism, and the preset dataType is not set.

Presets are usually numbers, and are documented separately for each pattern. You can use "random" value in order to have a random preset each time you use the MCTE.

Usage:
mcteInstance.preset = 12;
mcteInstance.preset = "random";
transitionType String
Yes
The type of the transition that MCTE will do based on the selected pattern and preset. Values: [show, hide, transitionTo, transitionFrom].

Default: show

show will perform an appearing transition from invisible state to the visible one.

hide will perform a disappearing transition from the visible state to the invisible one.

transitionTo will perform a transition from the current state to a different one, based on customParams and the rest of the params, depending on the pattern type.

transitionFrom will perform a transition from the param setting to the current state.
transitionTo and transitionFrom also may be used by patterns that make transitions between MovieClips, not just between states.

Usage:
mcteInstance.transitionType = "show";
tweenDuration Number
Yes
Sets the duration of the slide tweening in frames.

Default: 15

Usage:
mcteInstance.tweenDuration = 10;
tweenType String
Yes
Sets the tweening type. Values: [Regular, Strong, Bounce, Back, Elastic, None]

Default: Regular

Usage:
mcteInstance.tweenType = "Back";
xmlPath String
Yes
Optional parameter, sets the path to a XML file that can configure the MCTE V3.

If the xmlPath is set, all parameters set from script or Component Inspector will be overwritten by their correspondents from XML.

Usage:
mcteInstance.xmlPath = "config/loaderConfig.xml";

Overview | Properties | Methods | Events | Built in Patterns | XML | Data Model Diagram