PIXI

Class: AnimatedSprite

PIXI.extras. AnimatedSprite

An AnimatedSprite is a simple way to display an animation depicted by a list of textures.

let alienImages = ["image_sequence_01.png","image_sequence_02.png","image_sequence_03.png","image_sequence_04.png"];
let textureArray = [];

for (let i=0; i < 4; i++)
{
     let texture = PIXI.Texture.fromImage(alienImages[i]);
     textureArray.push(texture);
};

let mc = new PIXI.AnimatedSprite(textureArray);

new PIXI.extras.AnimatedSprite(textures, autoUpdate)

extras/AnimatedSprite.js, line 32
Name Type Default Description
textures Array.<PIXI.Texture> | Array.<FrameObject>

an array of PIXI.Texture or frame
objects that make up the animation
autoUpdate boolean true optional

Whether use PIXI.ticker.shared to auto update animation time.

Extends

Members

alphanumber

The opacity of the object.

anchorPIXI.ObservablePoint

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

animationSpeednumber

The speed that the AnimatedSprite will play at. Higher is faster, lower is slower

Default Value:
  • 1

blendModenumber

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

Default Value:
  • PIXI.BLEND_MODES.NORMAL
See:

cacheAsBitmapboolean

Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

readonlycurrentFramenumber

The AnimatedSprites current frame index

filterAreaPIXI.Rectangle

The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filtersArray.<PIXI.Filter>

Sets the filters for the displayObject.

  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'

heightnumber

The height of the sprite, setting this will actually modify the scale to achieve the value set

readonlylocalTransformPIXI.Matrix

Current transform of the object based on local factors: position, scale, other stuff

loopboolean

Whether or not the animate sprite repeats after playing.

Default Value:
  • true

maskPIXI.Graphics PIXI.Sprite

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

onCompletefunction

Function to call when a AnimatedSprite finishes playing

onFrameChangefunction

Function to call when a AnimatedSprite changes which texture is being rendered

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point PIXI.ObservablePoint

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

readonlyplayingboolean

Indicates if the AnimatedSprite is currently playing

pluginNamestring

Plugin that is responsible for rendering this element.
Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.

Default Value:
  • 'sprite'

positionPIXI.Point PIXI.ObservablePoint

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotationnumber

The rotation of the object in radians.

scalePIXI.Point PIXI.ObservablePoint

The scale factor of the object.
Assignment by value since pixi-v4.

shaderPIXI.Filter PIXI.Shader

The shader that will be used to render the sprite. Set to null to remove a current shader.

skewPIXI.ObservablePoint

The skew factor for the object in radians.
Assignment by value since pixi-v4.

texturePIXI.Texture

The texture that the sprite is using

texturesArray.<PIXI.Texture>

The array of textures used for this AnimatedSprite

tintnumber

The tint applied to the sprite. This is a hex value.
A value of 0xFFFFFF will remove any tint effect.

Default Value:
  • 0xFFFFFF

readonlytotalFramesnumber

totalFrames is the total number of frames in the AnimatedSprite. This is the same as number of textures
assigned to the AnimatedSprite.

Default Value:
  • 0

transformPIXI.TransformBase

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

widthnumber

The width of the sprite, setting this will actually modify the scale to achieve the value set

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the object is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Methods

staticPIXI.extras.AnimatedSprite.fromFrames(frames){AnimatedSprite}

extras/AnimatedSprite.js, line 281

A short hand way of creating a movieclip from an array of frame ids

Name Type Description
frames Array.<string>

The array of frames ids the movieclip will use as its texture frames
Returns:
Type Description
AnimatedSprite The new animated sprite with the specified frames.

staticPIXI.extras.AnimatedSprite.fromImages(images){AnimatedSprite}

extras/AnimatedSprite.js, line 300

A short hand way of creating a movieclip from an array of image ids

Name Type Description
images Array.<string>

the array of image urls the movieclip will use as its texture frames
Returns:
Type Description
AnimatedSprite The new animate sprite with the specified images as frames.

inherited _recursivePostUpdateTransform()

core/display/DisplayObject.js, line 161

recursively updates transform of all objects from the root to this one
internal function for toLocal()

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 55

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject repeatable

The DisplayObject(s) to add to the container
Returns:
Type Description
PIXI.DisplayObject The first child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 101

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name Type Description
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited calculateBounds()

core/display/Container.js, line 345

Recalculates the bounds of the container.

inherited calculateTrimmedVertices()

core/sprites/Sprite.js, line 245

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

inherited calculateVertices()

core/sprites/Sprite.js, line 175

calculates worldTransform * vertices, store it in vertexData

inherited containsPoint(point){boolean}

core/sprites/Sprite.js, line 386

Tests if a point is inside this sprite

Name Type Description
point PIXI.Point

the point to test
Returns:
Type Description
boolean the result of the test

destroy()

extras/AnimatedSprite.js, line 268

Stops the AnimatedSprite and destroys it

inherited getBounds(skipUpdate, rect){PIXI.Rectangle}

core/display/DisplayObject.js, line 183

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate boolean

setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost
rect PIXI.Rectangle

Optional rectangle to store the result of the bounds calculation
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 195

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 156

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

inherited getLocalBounds(rect){PIXI.Rectangle}

core/sprites/Sprite.js, line 354

Gets the local bounds of the sprite object.

Name Type Description
rect PIXI.Rectangle

The output rectangle.
Returns:
Type Description
PIXI.Rectangle The bounds.

gotoAndPlay(frameNumber)

extras/AnimatedSprite.js, line 170

Goes to a specific frame and begins playing the AnimatedSprite

Name Type Description
frameNumber number

frame index to start at

gotoAndStop(frameNumber)

extras/AnimatedSprite.js, line 151

Stops the AnimatedSprite and goes to a specific frame

Name Type Description
frameNumber number

frame index to stop at

play()

extras/AnimatedSprite.js, line 132

Plays the AnimatedSprite

inherited removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 211

Removes one or more children from the container.

Name Type Description
child PIXI.DisplayObject repeatable

The DisplayObject(s) to remove
Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 253

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}

core/display/Container.js, line 279

Removes all children from this container that are within the begin and end indexes.

Name Type Default Description
beginIndex number 0 optional

The beginning position.
endIndex number this.children.length optional

The ending position. Default value is size of the container.
Returns:
Type Description
Array.<DisplayObject> List of removed children

inherited renderCanvas(renderer)

core/display/Container.js, line 512

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

inherited renderWebGL(renderer)

core/display/Container.js, line 396

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 174

Changes the position of an existing child in the display object container

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

inherited setParent(container){PIXI.Container}

core/display/DisplayObject.js, line 350

Set the parent Container of this DisplayObject

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to
Returns:
Type Description
PIXI.Container The Container that this DisplayObject was added to

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

core/display/DisplayObject.js, line 376

Convenience function to set the position, scale, skew and pivot at once.

Name Type Default Description
x number 0 optional

The X position
y number 0 optional

The Y position
scaleX number 1 optional

The X scale value
scaleY number 1 optional

The Y scale value
rotation number 0 optional

The rotation
skewX number 0 optional

The X skew value
skewY number 0 optional

The Y skew value
pivotX number 0 optional

The X pivot value
pivotY number 0 optional

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject The DisplayObject instance

stop()

extras/AnimatedSprite.js, line 114

Stops the AnimatedSprite

inherited swapChildren(child, child2)

core/display/Container.js, line 135

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject

First display object to swap
child2 PIXI.DisplayObject

Second display object to swap

inherited toGlobal(position, point, skipUpdate){PIXI.Point}

core/display/DisplayObject.js, line 259

Calculates the global position of the display object

Name Type Default Description
position PIXI.Point

The world origin to calculate from
point PIXI.Point optional

A Point object in which to store the value, optional
(otherwise will create a new Point)
skipUpdate boolean false optional

Should we skip the update transform.
Returns:
Type Description
PIXI.Point A point object representing the position of this object

inherited toLocal(position, from, point, skipUpdate){PIXI.Point}

core/display/DisplayObject.js, line 294

Calculates the local position of the display object relative to another point

Name Type Default Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from
point PIXI.Point optional

A Point object in which to store the value, optional
(otherwise will create a new Point)
skipUpdate boolean false optional

Should we skip the update transform
Returns:
Type Description
PIXI.Point A point object representing the position of this object

inherited updateTransform()

core/display/Container.js, line 321

Updates the transform on all children of this container for rendering