API Docs for: 2.2.1
Show:

File: pixi/display/MovieClip.hx

                        package pixi.display;
                        
                        import pixi.textures.Texture;
                        
                        @:native("PIXI.MovieClip")
                        extern class MovieClip extends Sprite {
                        
                        	/**
                        	 * A MovieClip is a simple way to display an animation depicted by a list of textures.
                        	 *
                        	 * @class MovieClip
                        	 * @extends Sprite
                        	 * @constructor
                        	 * @param textures {Array<Texture>} an array of {Texture} objects that make up the animation
                        	 */
                        	function new(textures:Array<Texture>):Void;
                        
                        	/**
                        	 * The speed that the MovieClip will play at. Higher is faster, lower is slower
                        	 *
                        	 * @property animationSpeed
                        	 * @type Float
                        	 * @default 1
                        	 */
                        	var animationSpeed:Float;
                        
                        	/**
                        	 * Whether or not the movie clip repeats after playing.
                        	 *
                        	 * @property loop
                        	 * @type Bool
                        	 * @default true
                        	 */
                        	var loop:Bool;
                        
                        	/**
                        	 * Function to call when a MovieClip finishes playing
                        	 *
                        	 * @property onComplete
                        	 * @type Function
                        	 */
                        	var onComplete:Void -> Void;
                        
                        	/**
                        	 * [read-only] The MovieClips current frame index (this may not have to be a whole number)
                        	 *
                        	 * @property currentFrame
                        	 * @type Int
                        	 * @default 0
                        	 * @readOnly
                        	 */
                        	var currentFrame:Int;
                        
                        	/**
                        	 * [read-only] Indicates if the MovieClip is currently playing
                        	 *
                        	 * @property playing
                        	 * @type Bool
                        	 * @readOnly
                        	 */
                        	var playing:Bool;
                        
                        	/**
                        	 * [read-only] totalFrames is the total number of frames in the MovieClip. This is the same as number of textures
                        	 * assigned to the MovieClip.
                        	 *
                        	 * @property totalFrames
                        	 * @type Int
                        	 * @default 0
                        	 * @readOnly
                        	 */
                        	var totalFrames:Int;
                        
                        	/**
                        	 * The array of textures that make up the animation
                        	 *
                        	 * @property textures
                        	 * @type Array
                        	 */
                        	var textures:Array<Texture>;
                        
                        	/**
                        	 * Stops the MovieClip
                        	 *
                        	 * @method stop
                        	*/
                        	function stop():Void;
                        
                        	/**
                        	 * Plays the MovieClip
                        	 *
                        	 * @method play
                        	 */
                        	function play():Void;
                        
                        	/**
                        	 * Stops the MovieClip and goes to a specific frame
                        	 *
                        	 * @method gotoAndStop
                        	 * @param frameNumber {Int} frame index to stop at
                        	 */
                        	function gotoAndStop(frameNumber:Int):Void;
                        
                        	/**
                        	 * Goes to a specific frame and begins playing the MovieClip
                        	 *
                        	 * @method gotoAndPlay
                        	 * @param frameNumber {Int} frame index to start at
                        	 */
                        	function gotoAndPlay(frameNumber:Int):Void;
                        
                        	/**
                        	 * A short hand way of creating a movieclip from an array of frame ids
                        	 *
                        	 * @static
                        	 * @method fromFrames
                        	 * @param frames {Array<String>} the array of frames ids the movieclip will use as its texture frames
                        	 * @return {MovieClip} returns the created MovieClip
                        	 */
                        	static function fromFrames(frames:Array<String>):MovieClip;
                        
                        	/**
                        	 * A short hand way of creating a movieclip from an array of image ids
                        	 *
                        	 * @static
                        	 * @method fromImages
                        	 * @param frames {Array<String>} the array of image ids the movieclip will use as its texture frames
                        	 * @return {MovieClip} returns the created MovieClip
                        	 */
                        	static function fromImages(images:Array<String>):MovieClip;
                        }