Class: AnimatedSprite

PIXI.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.from(alienImages[i]);
     textureArray.push(texture);
};

let animatedSprite = new PIXI.AnimatedSprite(textureArray);

The more efficient and simpler way to create an animated sprite is using a PIXI.Spritesheet containing the animation definitions:

PIXI.Loader.shared.add("assets/spritesheet.json").load(setup);

function setup() {
  let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet;
  animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]);
  ...
}

new PIXI.AnimatedSprite (textures, autoUpdate) overrides

Name Type Attributes Default Description
textures PIXI.Texture[] | PIXI.AnimatedSprite.FrameObject[]

An array of PIXI.Texture or frame objects that make up the animation.

autoUpdate boolean <optional>
true

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

Extends

Interface Definitions

FrameObject

Properties:
Name Type Description
texture PIXI.Texture

The PIXI.Texture of the frame.

time number

The duration of the frame, in milliseconds.

Members

animationSpeed number

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

Default Value:
  • 1

autoUpdate boolean

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

currentFrame number readonly

The AnimatedSprites current frame index.

loop boolean

Whether or not the animate sprite repeats after playing.

Default Value:
  • true

onComplete () => void

User-assigned function to call when an AnimatedSprite finishes playing.

Example

 animation.onComplete = function () {
   // finished!
 };

onFrameChange (currentFrame: number) => void

User-assigned function to call when an AnimatedSprite changes which texture is being rendered.

Example

 animation.onFrameChange = function () {
   // updated!
 };

onLoop () => void

User-assigned function to call when loop is true, and an AnimatedSprite is played and loops around to start again.

Example

 animation.onLoop = function () {
   // looped!
 };

playing boolean readonly

Indicates if the AnimatedSprite is currently playing.

The array of textures used for this AnimatedSprite.

totalFrames number readonly

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

Default Value:
  • 0

updateAnchor boolean

Update anchor to Texture's defaultAnchor when frame changes.

Useful with sprite sheet animations created with tools. Changing anchor for each frame allows to pin sprite origin to certain moving feature of the frame (e.g. left foot).

Note: Enabling this will override any previously set anchor on each frame change.

Default Value:
  • false

Methods

PIXI.AnimatedSprite.fromFrames (frames) PIXI.AnimatedSprite static

A short hand way of creating an AnimatedSprite from an array of frame ids.

Name Type Description
frames string[]

The array of frames ids the AnimatedSprite will use as its texture frames.

Returns:
Type Description
PIXI.AnimatedSprite
  • The new animated sprite with the specified frames.

PIXI.AnimatedSprite.fromImages (images) PIXI.AnimatedSprite static

A short hand way of creating an AnimatedSprite from an array of image ids.

Name Type Description
images string[]

The array of image urls the AnimatedSprite will use as its texture frames.

Returns:
Type Description
PIXI.AnimatedSprite The new animate sprite with the specified images as frames.

destroy (options) void overrides

Stops the AnimatedSprite and destroys it.

Name Type Attributes Default Description
options object | boolean <optional>

Options parameter. A boolean will act as if all options have been set to that value.

options.children boolean <optional>
false

If set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.

options.texture boolean <optional>
false

Should it destroy the current texture of the sprite as well.

options.baseTexture boolean <optional>
false

Should it destroy the base texture of the sprite as well.

gotoAndPlay (frameNumber) void

Goes to a specific frame and begins playing the AnimatedSprite.

Name Type Description
frameNumber number

Frame index to start at.

gotoAndStop (frameNumber) void

Stops the AnimatedSprite and goes to a specific frame.

Name Type Description
frameNumber number

Frame index to stop at.

play () void

Plays the AnimatedSprite.

stop () void

Stops the AnimatedSprite.

update (deltaTime) void

Updates the object transform for rendering.

Name Type Description
deltaTime number

Time since last tick.

Inherited Properties

From class PIXI.Sprite

The anchor sets the origin point of the sprite. The default value is taken from the Texture and passed to the constructor.

The default is (0,0), this means the sprite's origin is the top left.

Setting the anchor to (0.5,0.5) means the sprite's origin is centered.

Setting the anchor to (1,1) would mean the sprite's origin point will be the bottom right corner.

If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

Example

 const sprite = new PIXI.Sprite(texture);
 sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).

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

height number inherited

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

isSprite boolean inherited

Used to fast check if a sprite is.. a sprite!

Default Value:
  • true

pluginName string inherited

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

Default Value:
  • 'batch'

roundPixels boolean inherited

If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.

Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth.

To set the global default, change PIXI.settings.ROUND_PIXELS.

Default Value:
  • false

The texture that the sprite is using.

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

width number inherited

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

_anchor PIXI.ObservablePoint protected inherited

The anchor point defines the normalized coordinates in the texture that map to the position of this sprite.

By default, this is (0,0) (or texture.defaultAnchor if you have modified that), which means the position (x,y) of this Sprite will be the top-left corner.

Note: Updating texture.defaultAnchor after constructing a Sprite does not update its anchor.

https://docs.cocos2d-x.org/cocos2d-x/en/sprites/manipulation.html

Default Value:
  • `this.texture.defaultAnchor`

_cachedTint number protected inherited

Cached tint value so we can tell when the tint is changed. Value is used for 2d CanvasRenderer.

Default Value:
  • 0xFFFFFF

_height number protected inherited

The height of the sprite (this is initially set by the texture)

_tintedCanvas HTMLCanvasElement protected inherited

Cached tinted texture.

Default Value:
  • undefined

_width number protected inherited

The width of the sprite (this is initially set by the texture).

uvs Float32Array protected inherited

This is used to store the uvs data of the sprite, assigned at the same time as the vertexData in calculateVertices().

vertexData Float32Array protected inherited

This is used to store the vertex data of the sprite (basically a quad).

From class PIXI.Container

children T[] readonly inherited

The array of children of this container.

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

Default Value:
  • true

sortableChildren boolean inherited

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as @link https://github.com/pixijs/pixi-display

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

See:

sortDirty boolean inherited

Should children be sorted by zIndex at the next updateTransform call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

From class PIXI.DisplayObject

_accessibleActive boolean inherited

Default Value:
  • false
TODO
  • Needs docs.

_accessibleDiv boolean inherited

Default Value:
  • undefined
TODO
  • Needs docs.

The bounds object, this is used to calculate and store the bounds of the displayObject.

_localBounds PIXI.Bounds inherited

Local bounds object, swapped with _bounds when using getLocalBounds().

accessible boolean inherited

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Default Value:
  • false

accessibleChildren boolean inherited

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default Value:
  • true

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

Default Value:
  • undefined

accessiblePointerEvents string inherited

Specify the pointer-events the accessible div will use Defaults to auto.

Default Value:
  • 'auto'

accessibleTitle ?string inherited

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'

Default Value:
  • undefined

accessibleType string inherited

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default Value:
  • 'button'

alpha number inherited

The opacity of the object.

angle number inherited

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

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.

cacheAsBitmapMultisample number inherited

The number of samples to use for cacheAsBitmap. If set to null, the renderer's sample count is used. If cacheAsBitmap is set to true, this will re-render with the new number of samples.

Default Value:
  • PIXI.MSAA_QUALITY.NONE

cacheAsBitmapResolution number inherited

The resolution to use for cacheAsBitmap. By default this will use the renderer's resolution but can be overriden for performance. Lower values will reduce memory usage at the expense of render quality. A falsey value of null or 0 will default to the renderer's resolution. If cacheAsBitmap is set to true, this will re-render with the new resolution.

Default Value:
  • null

cullable boolean inherited

Should this object be rendered if the bounds of this object are out of frame?

Culling has no effect on whether updateTransform is called.

If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.

destroyed boolean inherited

Readonly flag for destroyed display objects.

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

Also works as an interaction mask.

filters PIXI.Filter[] | null 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'.

hitArea PIXI.IHitArea 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.

Default Value:
  • undefined
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 to true.

Default Value:
  • false
Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.on('tap', (event) => {
    //handle event
 });

isMask boolean inherited

Does any other displayObject use this object as a mask?

localTransform PIXI.Matrix readonly inherited

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

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 PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. Otherwise, getLocalBounds may calculate incorrect bounds, which makes the container's width and height wrong. 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
  • At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
Example

 const graphics = new PIXI.Graphics();
 graphics.beginFill(0xFF3300);
 graphics.drawRect(50, 250, 100, 100);
 graphics.endFill();

 const sprite = new PIXI.Sprite(texture);
 sprite.mask = graphics;

name string inherited

The instance name of the object.

Default Value:
  • undefined

The display object container that contains this display object.

The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

By default, the pivot is the origin (0, 0).

Since:
  • 4.0.0

The coordinate of the object relative to the local coordinates of the parent.

Since:
  • 4.0.0

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. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

Since:
  • 4.0.0

The skew factor for the object in radians.

Since:
  • 4.0.0

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.

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

zIndex number inherited

The zIndex of the displayObject.

If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other display objects within the same container.

See:

_boundsID number protected inherited

Flags the cached bounds as dirty.

_boundsRect PIXI.Rectangle protected inherited

Cache of this display-object's bounds-rectangle.

_destroyed boolean protected inherited

If the object has been destroyed via destroy(). If true, it should not be used.

_enabledFilters PIXI.Filter[] protected inherited

Currently enabled filters.

_lastSortedIndex number protected inherited

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

_localBoundsRect PIXI.Rectangle protected inherited

Cache of this display-object's local-bounds rectangle.

The original, cached mask of the object.

_tempDisplayObjectParent PIXI.Container protected inherited

_zIndex number protected inherited

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Inherited Methods

From class PIXI.Sprite

calculateTrimmedVertices () void 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 () void inherited

Calculates worldTransform * vertices, store it in vertexData.

containsPoint (point) boolean inherited

Tests if a point is inside this sprite

Name Type Description
point IPointData

the point to test

Returns:
Type Description
boolean The result of the test

getLocalBounds (rect) PIXI.Rectangle inherited

Gets the local bounds of the sprite object.

Name Type Attributes Description
rect PIXI.Rectangle <optional>

Optional output rectangle.

Returns:
Type Description
PIXI.Rectangle The bounds.

_calculateBounds () void protected inherited

Updates the bounds of the sprite.

_onTextureUpdate () void protected inherited

When the texture is updated, this event will fire to update the scale and frame.

_render (renderer) void protected inherited

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The webgl renderer to use.

From class PIXI.Container

Adds one or more children to the container.

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

Name Type Description
children PIXI.DisplayObject

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 () void inherited

Recalculates the bounds of the container.

This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

containerUpdateTransform () inherited

Container default updateTransform, does update children of container. Will crash if there's no parent element.

getChildAt (index) T inherited

Returns the child at the specified index

Name Type Description
index number

The index to get the child at

Returns:
Type Description
T
  • The child at the given index, if any.

getChildByName (name, deep) PIXI.DisplayObject inherited

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Name Type Attributes Default Description
name string

Instance name.

deep boolean <optional>
false

Whether to search recursively

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 T

The DisplayObject instance to identify

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

removeChild (…children) PIXI.DisplayObject inherited

Removes one or more children from the container.

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to remove

Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

removeChildAt (index) T inherited

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from

Returns:
Type Description
T The child that was removed.

removeChildren (beginIndex, endIndex) T[] inherited

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

Name Type Default Description
beginIndex number 0

The beginning position.

endIndex

The ending position. Default value is size of the container.

Returns:
Type Description
T[]
  • List of removed children

render (renderer) void inherited

Renders the object using the WebGL renderer.

The _render method is be overriden for rendering the contents of the container itself. This render method will invoke it, and also invoke the render methods of all children afterward.

If renderable or visible is false or if worldAlpha is not positive or if cullable is true and the bounds of this object are out of frame, this implementation will entirely skip rendering. See PIXI.DisplayObject for choosing between renderable or visible. Generally, setting alpha to zero is not recommended for purely skipping rendering.

When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. See cullable and cullArea. Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and pixi-cull.

The renderAdvanced method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.

Name Type Description
renderer PIXI.Renderer

The renderer

renderCanvas (renderer) void inherited

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

setChildIndex (child, index) void inherited

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

Name Type Description
child T

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

index number

The resulting index number for the child display object

sortChildren () void inherited

Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.

swapChildren (child, child2) void inherited

Swaps the position of 2 Display Objects within this container.

Name Type Description
child T

First display object to swap

child2 T

Second display object to swap

updateTransform () void inherited

Updates the transform on all children of this container for rendering.

_renderWithCulling (renderer) void protected inherited

Renders this object and its children with culling.

Name Type Description
renderer PIXI.Renderer

The renderer

onChildrenChange (_length) void protected inherited

Overridable method that can be used by Container subclasses whenever the children array is modified.

Name Type Attributes Description
_length number <optional>

renderAdvanced (renderer) void protected inherited

Render the object using the WebGL renderer and advanced features.

Name Type Description
renderer PIXI.Renderer

The renderer

From class PIXI.DisplayObject

addEventListener (type, listener, options) inherited

Unlike on or addListener which are methods from EventEmitter, addEventListener seeks to be compatible with the DOM's addEventListener with support for options. IMPORTANT: Only available if using the @pixi/events package.

Name Type Attributes Description
type string

The type of event to listen to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

Listener options, used for capture phase.

Example

 // Tell the user whether they did a single, double, triple, or nth click.
 button.addEventListener('click', {
   handleEvent(e): {
     let prefix;

     switch (e.detail) {
       case 1: prefix = 'single'; break;
       case 2: prefix = 'double'; break;
       case 3: prefix = 'triple'; break;
       default: prefix = e.detail + 'th'; break;
     }

     console.log('That was a ' + prefix + 'click');
   }
 });

 // But skip the first click!
 button.parent.addEventListener('click', function blockClickOnce(e) {
   e.stopImmediatePropagation();
   button.parent.removeEventListener('click', blockClickOnce, true);
 }, {
   capture: true,
 })

disableTempParent (cacheParent) void inherited

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.Container

Actual parent of element

dispatchEvent (e) boolean inherited

Dispatch the event on this PIXI.DisplayObject using the event's PIXI.EventBoundary.

The target of the event is set to this and the defaultPrevented flag is cleared before dispatch.

IMPORTANT: Only available if using the @pixi/events package.

Name Type Description
e Event

The event to dispatch.

Returns:
Type Description
boolean Whether the preventDefault() method was not invoked.
Example

 // Reuse a click event!
 button.dispatchEvent(clickEvent);

displayObjectUpdateTransform () inherited

DisplayObject default updateTransform, does not update children of container. Will crash if there's no parent element.

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Returns:
Type Description
PIXI.Container
  • current parent

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

Calculates and returns the (world) bounds of the display object as a Rectangle.

This method is expensive on containers with a large subtree (like the stage). This is because the bounds of a container depend on its children's bounds, which recursively causes all bounds in the subtree to be recalculated. The upside, however, is that calling getBounds once on a container will indeed update the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using displayObject._bounds.getRectangle() when traversing through all the bounds in a scene graph. Otherwise, calling getBounds on each object in a subtree will cause the total cost to increase quadratically as its height increases.

The transforms of all objects in a container's subtree and of all ancestors are updated. The world bounds of all display objects in a container's subtree will also be recalculated.

The _bounds object stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.

const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);

Do know that usage of getLocalBounds can corrupt the _bounds of children (the whole subtree, actually). This is a known issue that has not been solved. See getLocalBounds for more details.

getBounds should be called with skipUpdate equal to true in a render() call. This is because the transforms are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain cases.

Name Type Attributes Description
skipUpdate boolean <optional>

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>

Optional rectangle to store the result of the bounds calculation.

Returns:
Type Description
PIXI.Rectangle
  • The minimum axis-aligned rectangle in world space that fits around this object.

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Attributes Default Description
point PIXI.Point <optional>
new PIXI.Point()

The point to write the global value to.

skipUpdate boolean <optional>
false

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
PIXI.Point The updated point.

removeEventListener (type, listener, options) inherited

Unlike off or removeListener which are methods from EventEmitter, removeEventListener seeks to be compatible with the DOM's removeEventListener with support for options. IMPORTANT: Only available if using the @pixi/events package.

Name Type Attributes Description
type string

The type of event the listener is bound to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

The original listener options. This is required to deregister a capture phase listener.

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) this inherited

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

Name Type Default Description
x number 0

The X position

y number 0

The Y position

scaleX number 1

The X scale value

scaleY number 1

The Y scale value

rotation number 0

The rotation

skewX number 0

The X skew value

skewY number 0

The Y skew value

pivotX number 0

The X pivot value

pivotY number 0

The Y pivot value

Returns:
Type Description
this
  • The DisplayObject instance

toGlobal (position, point, skipUpdate) P inherited

Calculates the global position of the display object.

Name Type Attributes Default Description
position IPointData

The world origin to calculate from.

point P <optional>

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

skipUpdate boolean false

Should we skip the update transform.

Returns:
Type Description
P
  • A point object representing the position of this object.

toLocal (position, from, point, skipUpdate) P inherited

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

Name Type Attributes Description
position IPointData

The world origin to calculate from.

from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from.

point P <optional>

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

skipUpdate boolean <optional>

Should we skip the update transform

Returns:
Type Description
P
  • A point object representing the position of this object

_recursivePostUpdateTransform () void protected inherited

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

Inherited Events

From class PIXI.Container

Fired when a DisplayObject is added to this Container.

Name Type Description
child PIXI.DisplayObject

The child added to the Container.

container PIXI.Container

The container that added the child.

index number

The children's index of the added child.

From class PIXI.DisplayObject

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

Fired when a DisplayObject is removed from this Container.

Name Type Description
child PIXI.DisplayObject

The child removed from the Container.

container PIXI.Container

The container that removed the child.

index number

The former children's index of the removed child

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

A click event fires after the pointerdown and pointerup events, in that order. If the mouse is moved over another DisplayObject after the pointerdown event, the click event is fired on the most specific common ancestor of the two target DisplayObjects.

The detail property of the event is the number of clicks that occurred within a 200ms window of each other upto the current click. For example, it will be 2 for a double click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when this DisplayObject is destroyed. This event is emitted once destroy is finished.

Fired when a mouse button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The mousedown event.

mousedowncapture inherited

Capture phase equivalent of mousedown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The capture phase mousedown.

Fired when the mouse pointer is moved over a DisplayObject and its descendant's hit testing boundaries.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseentercapture inherited

Capture phase equivalent of mouseenter

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when the mouse pointer exits a DisplayObject and its descendants.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

mouseleavecapture inherited

Capture phase equivalent of mouseleave.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemovecapture inherited

Capture phase equivalent of mousemove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

This may be fired on a DisplayObject that was removed from the scene graph immediately after a mouseover event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of mouseout.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseovercapture inherited

Capture phase equivalent of mouseover.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of mouseup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

This event is specific to the Federated Events API. It does not have a capture phase, unlike most of the other events. It only bubbles to the most specific ancestor of the targets of the corresponding pointerdown and pointerup events, i.e. the target of the click event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutsidecapture inherited

Capture phase equivalent of mouseupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancelcapture inherited

Capture phase equivalent of pointercancel.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdowncapture inherited

Capture phase equivalent of pointerdown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when the pointer is moved over a DisplayObject and its descendant's hit testing boundaries.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerentercapture inherited

Capture phase equivalent of pointerenter

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when the pointer leaves the hit testing boundaries of a DisplayObject and its descendants.

This event notifies only the target and does not bubble.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The pointerleave event.

pointerleavecapture inherited

Capture phase equivalent of pointerleave.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermovecapture inherited

Capture phase equivalent of pointermove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointeroutcapture inherited

Capture phase equivalent of pointerout.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerovercapture inherited

Capture phase equivalent of pointerover.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertapcapture inherited

Capture phase equivalent of pointertap.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupcapture inherited

Capture phase equivalent of pointerup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutside inherited

Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

This event is specific to the Federated Events API. It does not have a capture phase, unlike most of the other events. It only bubbles to the most specific ancestor of the targets of the corresponding pointerdown and pointerup events, i.e. the target of the click event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutsidecapture inherited

Capture phase equivalent of pointerupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

This event follows the semantics of click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightclickcapture inherited

Capture phase equivalent of rightclick.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdowncapture inherited

Capture phase equivalent of rightdown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The rightdowncapture event.

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of rightup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutsidecapture inherited

Capture phase equivalent of rightupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of tap.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancelcapture inherited

Capture phase equivalent of touchcancel.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of touchend.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutsidecapture inherited

Capture phase equivalent of touchendoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmovecapture inherited

Capture phase equivalent of touchmove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstartcapture inherited

Capture phase equivalent of touchstart.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when a the user scrolls with the mouse cursor over a DisplayObject.

These events are propagating from the EventSystem in @pixi/events.

Type:

Capture phase equivalent of wheel.

These events are propagating from the EventSystem in @pixi/events.

Type: