<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MovieClip - pixi.js</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="pixi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="../classes/AlphaMaskFilter.html">AlphaMaskFilter</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="../classes/ColorStepFilter.html">ColorStepFilter</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/GrayFilter.html">GrayFilter</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PIXI.PixiShader.html">PIXI.PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/PolyK._convex.html">PolyK._convex</a></li>
<li><a href="../classes/PolyK._PointInTriangle.html">PolyK._PointInTriangle</a></li>
<li><a href="../classes/PolyK.AjaxRequest.html">PolyK.AjaxRequest</a></li>
<li><a href="../classes/PolyK.InteractionData.html">PolyK.InteractionData</a></li>
<li><a href="../classes/PolyK.InteractionManager.html">PolyK.InteractionManager</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li>
<li><a href="../classes/Spine.html">Spine</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Sprite™.html">Sprite™</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
<li><a href="../classes/Text.html">Text</a></li>
<li><a href="../classes/Texture.html">Texture</a></li>
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/PIXI.html">PIXI</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>MovieClip Class</h1>
<div class="box meta">
<div class="extends">
Extends Sprite
</div>
<div class="foundat">
Defined in: <a href="../files/src_pixi_display_MovieClip.js.html#l5"><code>src/pixi/display/MovieClip.js:5</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>A MovieClip is a simple way to display an animation depicted by a list of textures.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_MovieClip" class="method item">
<h3 class="name"><code>MovieClip</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>textures</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l5"><code>src/pixi/display/MovieClip.js:5</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">textures</code>
<span class="type">Array<Texture></span>
<div class="param-description">
<p>an array of {Texture} objects that make up the animation</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method">
<a href="#method_gotoAndPlay">gotoAndPlay</a>
</li>
<li class="index-item method">
<a href="#method_gotoAndStop">gotoAndStop</a>
</li>
<li class="index-item method">
<a href="#method_play">play</a>
</li>
<li class="index-item method">
<a href="#method_stop">stop</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#property_animationSpeed">animationSpeed</a>
</li>
<li class="index-item property">
<a href="#property_currentFrame">currentFrame</a>
</li>
<li class="index-item property">
<a href="#property_loop">loop</a>
</li>
<li class="index-item property">
<a href="#property_onComplete">onComplete</a>
</li>
<li class="index-item property">
<a href="#property_playing">playing</a>
</li>
<li class="index-item property">
<a href="#property_textures">textures</a>
</li>
<li class="index-item property">
<a href="#property_totalFrames">totalFrames</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_gotoAndPlay" class="method item">
<h3 class="name"><code>gotoAndPlay</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>frameNumber</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l126"><code>src/pixi/display/MovieClip.js:126</code></a>
</p>
</div>
<div class="description">
<p>Goes to a specific frame and begins playing the MovieClip</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">frameNumber</code>
<span class="type">Number</span>
<div class="param-description">
<p>frame index to start at</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_gotoAndStop" class="method item">
<h3 class="name"><code>gotoAndStop</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>frameNumber</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l112"><code>src/pixi/display/MovieClip.js:112</code></a>
</p>
</div>
<div class="description">
<p>Stops the MovieClip and goes to a specific frame</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">frameNumber</code>
<span class="type">Number</span>
<div class="param-description">
<p>frame index to stop at</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_play" class="method item">
<h3 class="name"><code>play</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l102"><code>src/pixi/display/MovieClip.js:102</code></a>
</p>
</div>
<div class="description">
<p>Plays the MovieClip</p>
</div>
</div>
<div id="method_stop" class="method item">
<h3 class="name"><code>stop</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l92"><code>src/pixi/display/MovieClip.js:92</code></a>
</p>
</div>
<div class="description">
<p>Stops the MovieClip</p>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_animationSpeed" class="property item">
<h3 class="name"><code>animationSpeed</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l25"><code>src/pixi/display/MovieClip.js:25</code></a>
</p>
</div>
<div class="description">
<p>The speed that the MovieClip will play at. Higher is faster, lower is slower</p>
</div>
<p><strong>Default:</strong> 1</p>
</div>
<div id="property_currentFrame" class="property item">
<h3 class="name"><code>currentFrame</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l51"><code>src/pixi/display/MovieClip.js:51</code></a>
</p>
</div>
<div class="description">
<p>[read-only] The index MovieClips current frame (this may not have to be a whole number)</p>
</div>
<p><strong>Default:</strong> 0</p>
</div>
<div id="property_loop" class="property item">
<h3 class="name"><code>loop</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l34"><code>src/pixi/display/MovieClip.js:34</code></a>
</p>
</div>
<div class="description">
<p>Whether or not the movie clip repeats after playing.</p>
</div>
<p><strong>Default:</strong> true</p>
</div>
<div id="property_onComplete" class="property item">
<h3 class="name"><code>onComplete</code></h3>
<span class="type">Function</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l43"><code>src/pixi/display/MovieClip.js:43</code></a>
</p>
</div>
<div class="description">
<p>Function to call when a MovieClip finishes playing</p>
</div>
</div>
<div id="property_playing" class="property item">
<h3 class="name"><code>playing</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l61"><code>src/pixi/display/MovieClip.js:61</code></a>
</p>
</div>
<div class="description">
<p>[read-only] Indicates if the MovieClip is currently playing</p>
</div>
</div>
<div id="property_textures" class="property item">
<h3 class="name"><code>textures</code></h3>
<span class="type">Array</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l17"><code>src/pixi/display/MovieClip.js:17</code></a>
</p>
</div>
<div class="description">
<p>The array of textures that make up the animation</p>
</div>
</div>
<div id="property_totalFrames" class="property item">
<h3 class="name"><code>totalFrames</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_display_MovieClip.js.html#l75"><code>src/pixi/display/MovieClip.js:75</code></a>
</p>
</div>
<div class="description">
<p>[read-only] totalFrames is the total number of frames in the MovieClip. This is the same as number of textures
assigned to the MovieClip.</p>
</div>
<p><strong>Default:</strong> 0</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
