- movieclip
- duration
- callback

- blinkInterval
- blinkTimes
- blinkFast
- animationStyle
- stop
- pause
- resume
- lock
- unlock
- isTweening
- getDurationElapsed
- getDurationRemaining
- addEventListener
- removeEventListener
- removeAllEventListeners
- eventListenerExists
- getID
- toString

movieclip

(MovieClip) Movieclip to animate.

duration

(Number) Duration of animation in milliseconds or frames. Default is milliseconds.

callback

(String) Function to invoke after animation. See APCore class.

blinkInterval

description: Every interval, the movieclip will be invisible and visible again till speed expires. This process stops when duration of animationStyle expires.

Example 1: Every second the movieclip is 100 milliseconds invisible. Lasts for 10 seconds.

				var myBlink:Blink = new Blink(mc);
				myBlink.animationStyle(10000);
				myBlink.blinkInterval(1000,100);
				

usage:

myBlink.blinkInterval(interval);

myBlink.blinkInterval(interval, speed);

parameters:

• interval (Number) Every interval in millisecond or frames the movieclip is set to invisible.
• speed (Number) Optional. How long shall the movieclip be invisible. Defaults to 10 milliseconds.

returns: void

blinkTimes

description: Force the number of blinks in a specified time and optionally specify the time the movieclip will be invisible.

Example 1: (Example .swf) let a movieclip blink 10 times in 10 seconds. Each blink the movieclip will be invisible for 500 milliseconds.

				var myBlink:Blink = new Blink(mc);
				myBlink.animationStyle(10000);
				myBlink.blinkTimes(10, 50);
				

usage:

myBlink.blinkTimes(interval);

myBlink.blinkTimes(interval, speed);

parameters:

• interval (Number) Times the movieclip will blink.
• speed (Number) Optional. How long shall the movieclip be invisible. Defaults to 10 milliseconds.

returns: void

blinkFast

description: blinks a movieclip as fast as possible for a certain amount of time or frames. Uses the frame-based ImpulsDispatcher for maximum speed. High frame rates recommended. Doesn't support durationMode MS in frame-based tweening. In general, where preciseness is an issue you shouldn't use durationMode MS in frame-based tweening.

Example 1: (Example .swf) let a movieclip blink as fast as possible for one second (default). Frame rate is 31.

				var myBlink:Blink = new Blink(mc);
				myBlink.blinkFast()
				

usage:

myBlink.blinkFast(duration);

parameters:

• duration (Number) Duration of animation in milliseconds or frames. Default is milliseconds.

returns: Void.

animationStyle

description: set the animation style properties for your animation.

usage:

myBlink.animationStyle(duration);

myBlink.animationStyle(duration, callback);

parameters:

• duration (Number) Duration of animation in milliseconds or frames. Default is milliseconds.
• callback (String) Function to invoke after animation. See APCore class.

returns: Void.

stop

description: stops the animation if not locked..

usage: myInstance.stop();

returns: true if instance was successfully stopped. false if instance could not be stopped, because it was locked.

pause

description: pauses the animation if not locked. Call resume() to continue animation.

usage: myInstance.pause();

parameters:

• duration (Number) optional property. Number of milliseconds or frames to pause before continuing animation.

returns: true if instance was successfully paused. false if instance could not be paused, because it was locked.

resume

description: continues the animation if not locked.

usage: myInstance.resume();

returns: true if instance was successfully resumed. false if instance could not be resumed, because it was locked.

lock

description: locks the animation to prevent pausing, resuming and stopping. Default is unlocked.

usage: myInstance.lock();

returns: Void.

unlock

description: unlocks the animation to allow pausing, resuming and stopping. Default is unlocked.

usage: myInstance.unlock();

returns: Void.

isTweening

description: checks if the instance is currently animated.

usage: myInstance.isTweening();

returns: true if instance is tweening, false if instance is not tweening.

getDurationElapsed

description: returns the elapsed time or frames since the current tween started tweening.

usage: myInstance.getDurationElapsed();

returns: Number

getDurationRemaining

description: returns the remaining time or frames since the current tween started tweening.

usage: myInstance.getDurationRemaining();

returns: Number

addEventListener

description: Subscribe to a predefined event. The following standard EventDispatcher events are broadcasted

onStart, broadcasted when animation starts.
onEnd, broadcasted when animation ends.

The even object returned, contains the following properties:

type (String) event broadcasted.
target (Object) event source.

usage:

myBlink.addEventListener(event, listener);

myBlink.addEventListener(event, listener, handler);

parameters:

• event (String) Event to subscribe listener to. GDispatcher specific feature allows to subscribe to all events from an event source if the string "ALL" is passed.
• listener (Object) The listener object to subscribe to the specified event.
• handler (String) Optional. GDispatcher specific feature. The name of a function to call. This function will be called within the scope of the object specified in the second parameter.

returns: Void.

removeEventListener

description: Removes a listener from a subscribed event.

usage:

myBlink.removeEventListener(event, listener);

myBlink.removeEventListener(event, listener, handler);

parameters:

• event (String) Event to remove subscribed listener from. GDispatcher specific feature allows to remove subscribtion to all events if the string "ALL" is passed. Works only if listener has been subscribed via the "ALL" string in addEventListener.
• listener (Object) The listener object to unsubscribe from the specified event.
• handler (String) Optional. GDispatcher specific feature. Only needed if the listener has been subscribed with a handler function.

returns: Void.

removeAllEventListeners

description: GDispatcher specific feature. Removes all listeners for a specific event, or for all events.

usage:

myBlink.removeAllEventListeners();

myBlink.removeAllEventListeners(event);

parameters:

• event (String) Event to remove all subscribed listeners from. If not specified, all listeners to any event will be removed.

returns: Void.

eventListenerExists

description: GDispatcher specific feature. Checks if a listener is already subscribed to a certain event.

usage:

myBlink.eventListenerExists(event, listener);

myBlink.eventListenerExists(event, listener, handler);

parameters:

• event (String) Event to check subscription.
• listener (Object) The listener object to check subscription.
• handler (String) The handler function to check subscription.

returns: true if event exists on listener. false if event doesn't exist on listener.

getID

description: returns a unique ID of the instance. Usefull for associative arrays.

usage: myInstance.getID();

returns: Number

toString

description: returns the name of the class.

usage: myInstance.toString();

returns: String