The horizontal registration of each TextAnimBlock.

It can be TextAnimAnchor.CENTER, TextAnimAnchor.LEFT, TextAnimAnchor.RIGHT

The default value is TextAnimAnchor.CENTER;.

See also

The vertical registration of each TextAnimBlock.

It can be TextAnimAnchor.CENTER, TextAnimAnchor.TOP, TextAnimAnchor.BOTTOM

The default value is TextAnimAnchor.CENTER;.

See also

Sets the visibility of all blocks.

Change the visible property of each block. In some animations the blocks must be hidden, to show them gradually.

Sets the delay (in milliseconds) before start.

The default value is 0.

Are the effect functions that will be called for all blocks, according to the interval specified.

It can be an Array of functions or just one. These functions must receives a TextAnimBlock as a parameter.

Example:

or

The first block reference.

TextAnim has a singly linked list of blocks, and this is the head of the list.

The default value is null.

Sets a html as text. Like text, all the blocks will be recreated.

See also

Sets the interval (in milliseconds) between each effect dispatch.

If the interval is 300, it means that the TextAnim will dispatch an effect each 300 milliseconds, until all the blocks are animated.

The default value is 100.

Amount of TextAnimBlocks.

Is the way of the effects dispatches will be occurs.

TextAnim dispatch effects in five diferent ways:

• TextAnimMode.FIRST_LAST - Begins with the first char and ends with last (left to right).
• TextAnimMode.LAST_FIRST - Begins with the last char and ends with first.
• TextAnimMode.EDGES_CENTER - Begins with the first and last, then evolues to center.
• TextAnimMode.CENTER_EDGES - Begins in the central chars and evolues to edges.
• TextAnimMode.RANDOM - Animate randomly.

The default value is TextAnimMode.FIRST_LAST.

Callback function called when the blocks are created, or recreated.

It occurs when the split or text changes.

The default value is null.

Callback function called when the last effect was dispatched.

		import flupie.textanim.TextAnim;
		
		var myTextAnim:TextAnim = new TextAnim(myTextField);
		myTextAnim.effects = myEffect;
		myTextAnim.onComplete = function():void {
			trace("text animation completed!");
		}
		myTextAnim.start();
		

The default value is null.

Callback function called when each effect dispatch.

		import flupie.textanim.TextAnim;
		
		var myTextAnim:TextAnim = new TextAnim(myTextField);
		myTextAnim.effects = myEffect;
		myTextAnim.onProgress = function():void {
			trace("effect was dispatched.");
		}
		myTextAnim.start();
		

The default value is null.

Callback function called when the TextAnim starts.

Runs only after delay setted.

		import flupie.textanim.TextAnim;
		
		var myTextAnim:TextAnim = new TextAnim(myTextField);
		myTextAnim.effects = myEffect;
		myTextAnim.delay = 1000;
		myTextAnim.onStart = function():void {
			trace("textAnim starts after 1 second");
		}
		myTextAnim.start();
		

The default value is null.

The original TextField instance thats TextAnim will use as reference.

Can be any textField, since it has an embed font.

To specify how the TextAnim will break the text: in chars, words or lines.

Everytime split changes, the blocks will be recreated automatically, keeping the text and appearance.

myTextAnim.split = TextAnimSplit.WORDS; //this instance will be splitted in words.

See also

Changes the text. All the blocks will be recreated.

The first value will be the same of the source's text. If you need use html as text, use htmlText.

See also

Indicates a fixed total time (in milliseconds) of effects dispatches.

A value of 5000 means the last dispatch will occurs 5 seconds after the first dispatch. Interval is ignored if time has a value higher than 0.

The default value is 0.

Constructor. Receives a TextField instance and instruction to replace that automatically.

The source TextField must have the font embbeded.

TextAnim will use the source as reference to create and organize TextAnimBlocks to looks identical to the source text. If the source already is in displayList, TextAnim can self add in displayList in the same position/depth with autoReplace setted as true.

By default, TextAnim creates the first set of blocks with the source text, but you can change this text everytime you want, using text or htmlText properties.

Auto-replacement if the source textField is in displayList: var anim:TextAnim = new TextAnim(myTextField);

		var anim:TextAnim = new TextAnim(myTextField);
		myTextField.x = 50;
		myTextField.y = 100;
		addChild(myTextField);
		

To apply the effects to a single block.

Use when you need play the effects just to one block: myTextAnim.applyEffect(myTextAnimBlock);

Parameters

Creates an instance of TextAnim in a fast way.

If you needs a fast text animation, hit:

or:

		var anim:TextAnim = TextAnim.create(myTextField, {effects:myEffect, interval:50, split:TextAnimSplit.WORDS});
		anim.start(500); //delay to start (in milliseconds)
		

Parameters

Clear all blocks, internal references, stops the progress and kill the TextAnim instance.

Do it when the instance of TextAnim is not needed anymore. Delete blocks, remove references and clear memory.

		myTextAnim.dispose();
		myTextAnim = null;
		

Apply a function to each block of this TextAnim.

Offers access to all blocks of textAnim instance.

		myTextAnim.forEachBlocks = function(block:TextAnimBlock):void {
			block.alpha = .5;
			trace(block.index, block.text); //index number of block (ID)
		};
		

Parameters

Modify the registration x and y of all blocks.

Parameters

Starts the flow of effects dispatches, with delay specified.

myTextAnim.start(2000); //This instance will start after 2 seconds.

Parameters

See also

Stops the flow of effects dispatches.

The effects, onProgress and textAnimEvent.PROGRESS dispatches stops. The onComplete will not be dispatched, except that animation starts again.

See also