Name | Type | Default | Description |
---|---|---|---|
textures |
Array.<PIXI.Texture> | Array.<PIXI.extras.AnimatedSprite~FrameObject> |
an array of PIXI.Texture or frame objects that make up the animation |
|
autoUpdate |
boolean | true |
optional
Whether to use PIXI.Ticker.shared to auto update animation time. |
Extends
Members
-
alpha number inherited
-
The opacity of the object.
-
anchor PIXI.ObservablePoint inherited
-
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
-
The speed that the AnimatedSprite will play at. Higher is faster, lower is slower
- Default Value:
- 1
-
blendMode number inherited
-
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:
-
buttonMode boolean inherited
-
If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to
'pointer'
.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.buttonMode = true;
-
cacheAsBitmap boolean inherited
-
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.
-
children Array.<PIXI.DisplayObject> readonly inherited
-
The array of children of this container.
-
The AnimatedSprites current frame index
-
cursor string inherited
-
This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.cursor = 'wait';
-
filterArea PIXI.Rectangle inherited
-
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
-
filters Array.<PIXI.Filter> inherited
-
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'
-
height number inherited
-
The height of the sprite, setting this will actually modify the scale to achieve the value set
-
hitArea PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.RoundedRectangle inherited
-
Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);
-
interactive boolean inherited
-
Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless
interactive
is set totrue
.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.on('tap', (event) => { //handle event });
-
interactiveChildren boolean inherited
-
Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive
hitTest
function -
localTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on local factors: position, scale, other stuff
-
Whether or not the animate sprite repeats after playing.
- Default Value:
- true
-
mask PIXI.Graphics | PIXI.Sprite inherited
-
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.
For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
- TODO
-
- For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-
name string inherited
-
The instance name of the object.
-
Function to call when a AnimatedSprite finishes playing
-
Function to call when a AnimatedSprite changes which texture is being rendered
-
Function to call when 'loop' is true, and an AnimatedSprite is played and loops around to start again
-
parent PIXI.Container readonly inherited
-
The display object container that contains this display object.
-
pivot PIXI.Point | PIXI.ObservablePoint inherited
-
The pivot point of the displayObject that it rotates around Assignment by value since pixi-v4.
-
Indicates if the AnimatedSprite is currently playing
-
pluginName string inherited
-
Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.
- Default Value:
- 'sprite'
-
position PIXI.Point | PIXI.ObservablePoint inherited
-
The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.
-
renderable boolean inherited
-
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
-
rotation number inherited
-
The rotation of the object in radians.
-
scale PIXI.Point | PIXI.ObservablePoint inherited
-
The scale factor of the object. Assignment by value since pixi-v4.
-
shader PIXI.Filter | PIXI.Shader inherited
-
The shader that will be used to render the sprite. Set to null to remove a current shader.
-
The skew factor for the object in radians. Assignment by value since pixi-v4.
-
texture PIXI.Texture inherited
-
The texture that the sprite is using
-
textures Array.<PIXI.Texture>
-
The array of textures used for this AnimatedSprite
-
tint number inherited
-
The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
- Default Value:
- 0xFFFFFF
-
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
-
transform PIXI.TransformBase inherited
-
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
-
visible boolean inherited
-
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
-
width number inherited
-
The width of the sprite, setting this will actually modify the scale to achieve the value set
-
worldAlpha number readonly inherited
-
The multiplied alpha of the displayObject
-
worldTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on world (parent) factors
-
worldVisible boolean readonly inherited
-
Indicates if the object is globally visible.
-
x number inherited
-
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-
y number inherited
-
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
Methods
-
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. -
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. -
_recursivePostUpdateTransform () inherited
-
recursively updates transform of all objects from the root to this one internal function for toLocal()
-
addChild (child)PIXI.DisplayObject inherited
-
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. -
addChildAt (child, index)PIXI.DisplayObject inherited
-
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. -
calculateBounds () inherited
-
Recalculates the bounds of the container.
-
calculateTrimmedVertices () inherited
-
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
-
calculateVertices () inherited
-
calculates worldTransform * vertices, store it in vertexData
-
containsPoint (point)boolean inherited
-
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 (options) overrides
-
Stops the AnimatedSprite and destroys it
Name Type Description options
object | boolean optional Options parameter. A boolean will act as if all options have been set to that value
Name Type Default Description children
boolean false optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
texture
boolean false optional Should it destroy the current texture of the sprite as well
baseTexture
boolean false optional Should it destroy the base texture of the sprite as well
-
getBounds (skipUpdate, rect)PIXI.Rectangle inherited
-
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 -
getChildAt (index)PIXI.DisplayObject inherited
-
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. -
getChildByName (name)PIXI.DisplayObject inherited
-
Returns the display object in the container
Name Type Description name
string instance name
Returns:
Type Description PIXI.DisplayObject The child with the specified name. -
getChildIndex (child)number inherited
-
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 -
getGlobalPosition (point, skipUpdate)Point inherited
-
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
Name Type Description point
Point the point to write the global value to. If null a new point will be returned
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
Returns:
Type Description Point The updated point -
getLocalBounds (rect)PIXI.Rectangle inherited
-
Gets the local bounds of the sprite object.
Name Type Description rect
PIXI.Rectangle The output rectangle.
Returns:
Type Description PIXI.Rectangle The bounds. -
Goes to a specific frame and begins playing the AnimatedSprite
Name Type Description frameNumber
number frame index to start at
-
Stops the AnimatedSprite and goes to a specific frame
Name Type Description frameNumber
number frame index to stop at
-
Plays the AnimatedSprite
-
removeChild (child)PIXI.DisplayObject inherited
-
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. -
removeChildAt (index)PIXI.DisplayObject inherited
-
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. -
removeChildren (beginIndex, endIndex)Array.<DisplayObject> inherited
-
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 -
render (renderer) inherited
-
Renders the object using the WebGL renderer
Name Type Description renderer
PIXI.Renderer The renderer
-
renderAdvancedWebGL (renderer) Deprecated : since 5.0.0 inherited
-
Name Type Description renderer
PIXI.Renderer Instance of renderer
- See:
-
- PIXI.Container#renderAdvanced
-
renderWebGL (renderer) Deprecated : since 5.0.0 inherited
-
Name Type Description renderer
PIXI.Renderer Instance of renderer
-
setChildIndex (child, index) inherited
-
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
-
setParent (container)PIXI.Container inherited
-
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 -
setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited
-
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 -
Stops the AnimatedSprite
-
swapChildren (child, child2) inherited
-
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
-
toGlobal (position, point, skipUpdate)PIXI.Point inherited
-
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 -
toLocal (position, from, point, skipUpdate)PIXI.Point inherited
-
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 -
updateTransform () inherited
-
Updates the transform on all children of this container for rendering