@pixi/sprite-animated - npm Package Compare versions

Comparing version 7.2.4 to 7.3.0-rc

lib/AnimatedSprite.js

@@ -1,138 +0,103 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var core = require('@pixi/core');
-var sprite = require('@pixi/sprite');
-
+"use strict";
+var core = require("@pixi/core"), sprite = require("@pixi/sprite");
 class AnimatedSprite extends sprite.Sprite {
-  constructor(textures, autoUpdate = true) {
-    super(textures[0] instanceof core.Texture ? textures[0] : textures[0].texture);
-    this._textures = null;
-    this._durations = null;
-    this._autoUpdate = autoUpdate;
-    this._isConnectedToTicker = false;
-    this.animationSpeed = 1;
-    this.loop = true;
-    this.updateAnchor = false;
-    this.onComplete = null;
-    this.onFrameChange = null;
-    this.onLoop = null;
-    this._currentTime = 0;
-    this._playing = false;
-    this._previousFrame = null;
-    this.textures = textures;
+  /**
+   * @param textures - An array of {@link PIXI.Texture} or frame
+   *  objects that make up the animation.
+   * @param {boolean} [autoUpdate=true] - Whether to use Ticker.shared to auto update animation time.
+   */
+  constructor(textures, autoUpdate = !0) {
+    super(textures[0] instanceof core.Texture ? textures[0] : textures[0].texture), this._textures = null, this._durations = null, this._autoUpdate = autoUpdate, this._isConnectedToTicker = !1, this.animationSpeed = 1, this.loop = !0, this.updateAnchor = !1, this.onComplete = null, this.onFrameChange = null, this.onLoop = null, this._currentTime = 0, this._playing = !1, this._previousFrame = null, this.textures = textures;
   }
+  /** Stops the AnimatedSprite. */
   stop() {
-    if (!this._playing) {
-      return;
-    }
-    this._playing = false;
-    if (this._autoUpdate && this._isConnectedToTicker) {
-      core.Ticker.shared.remove(this.update, this);
-      this._isConnectedToTicker = false;
-    }
+    this._playing && (this._playing = !1, this._autoUpdate && this._isConnectedToTicker && (core.Ticker.shared.remove(this.update, this), this._isConnectedToTicker = !1));
   }
+  /** Plays the AnimatedSprite. */
   play() {
-    if (this._playing) {
-      return;
-    }
-    this._playing = true;
-    if (this._autoUpdate && !this._isConnectedToTicker) {
-      core.Ticker.shared.add(this.update, this, core.UPDATE_PRIORITY.HIGH);
-      this._isConnectedToTicker = true;
-    }
+    this._playing || (this._playing = !0, this._autoUpdate && !this._isConnectedToTicker && (core.Ticker.shared.add(this.update, this, core.UPDATE_PRIORITY.HIGH), this._isConnectedToTicker = !0));
   }
+  /**
+   * Stops the AnimatedSprite and goes to a specific frame.
+   * @param frameNumber - Frame index to stop at.
+   */
   gotoAndStop(frameNumber) {
-    this.stop();
-    this.currentFrame = frameNumber;
+    this.stop(), this.currentFrame = frameNumber;
   }
+  /**
+   * Goes to a specific frame and begins playing the AnimatedSprite.
+   * @param frameNumber - Frame index to start at.
+   */
   gotoAndPlay(frameNumber) {
-    this.currentFrame = frameNumber;
-    this.play();
+    this.currentFrame = frameNumber, this.play();
   }
+  /**
+   * Updates the object transform for rendering.
+   * @param deltaTime - Time since last tick.
+   */
   update(deltaTime) {
-    if (!this._playing) {
+    if (!this._playing)
       return;
-    }
-    const elapsed = this.animationSpeed * deltaTime;
-    const previousFrame = this.currentFrame;
+    const elapsed = this.animationSpeed * deltaTime, previousFrame = this.currentFrame;
     if (this._durations !== null) {
       let lag = this._currentTime % 1 * this._durations[this.currentFrame];
-      lag += elapsed / 60 * 1e3;
-      while (lag < 0) {
-        this._currentTime--;
-        lag += this._durations[this.currentFrame];
-      }
+      for (lag += elapsed / 60 * 1e3; lag < 0; )
+        this._currentTime--, lag += this._durations[this.currentFrame];
       const sign = Math.sign(this.animationSpeed * deltaTime);
-      this._currentTime = Math.floor(this._currentTime);
-      while (lag >= this._durations[this.currentFrame]) {
-        lag -= this._durations[this.currentFrame] * sign;
-        this._currentTime += sign;
-      }
+      for (this._currentTime = Math.floor(this._currentTime); lag >= this._durations[this.currentFrame]; )
+        lag -= this._durations[this.currentFrame] * sign, this._currentTime += sign;
       this._currentTime += lag / this._durations[this.currentFrame];
-    } else {
+    } else
       this._currentTime += elapsed;
-    }
-    if (this._currentTime < 0 && !this.loop) {
-      this.gotoAndStop(0);
-      if (this.onComplete) {
-        this.onComplete();
-      }
-    } else if (this._currentTime >= this._textures.length && !this.loop) {
-      this.gotoAndStop(this._textures.length - 1);
-      if (this.onComplete) {
-        this.onComplete();
-      }
-    } else if (previousFrame !== this.currentFrame) {
-      if (this.loop && this.onLoop) {
-        if (this.animationSpeed > 0 && this.currentFrame < previousFrame || this.animationSpeed < 0 && this.currentFrame > previousFrame) {
-          this.onLoop();
-        }
-      }
-      this.updateTexture();
-    }
+    this._currentTime < 0 && !this.loop ? (this.gotoAndStop(0), this.onComplete && this.onComplete()) : this._currentTime >= this._textures.length && !this.loop ? (this.gotoAndStop(this._textures.length - 1), this.onComplete && this.onComplete()) : previousFrame !== this.currentFrame && (this.loop && this.onLoop && (this.animationSpeed > 0 && this.currentFrame < previousFrame || this.animationSpeed < 0 && this.currentFrame > previousFrame) && this.onLoop(), this.updateTexture());
   }
+  /** Updates the displayed texture to match the current frame index. */
   updateTexture() {
     const currentFrame = this.currentFrame;
-    if (this._previousFrame === currentFrame) {
-      return;
-    }
-    this._previousFrame = currentFrame;
-    this._texture = this._textures[currentFrame];
-    this._textureID = -1;
-    this._textureTrimmedID = -1;
-    this._cachedTint = 16777215;
-    this.uvs = this._texture._uvs.uvsFloat32;
-    if (this.updateAnchor) {
-      this._anchor.copyFrom(this._texture.defaultAnchor);
-    }
-    if (this.onFrameChange) {
-      this.onFrameChange(this.currentFrame);
-    }
+    this._previousFrame !== currentFrame && (this._previousFrame = currentFrame, this._texture = this._textures[currentFrame], this._textureID = -1, this._textureTrimmedID = -1, this._cachedTint = 16777215, this.uvs = this._texture._uvs.uvsFloat32, this.updateAnchor && this._anchor.copyFrom(this._texture.defaultAnchor), this.onFrameChange && this.onFrameChange(this.currentFrame));
   }
+  /**
+   * Stops the AnimatedSprite and destroys it.
+   * @param {object|boolean} [options] - Options parameter. A boolean will act as if all options
+   *  have been set to that value.
+   * @param {boolean} [options.children=false] - If set to true, all the children will have their destroy
+   *      method called as well. 'options' will be passed on to those calls.
+   * @param {boolean} [options.texture=false] - Should it destroy the current texture of the sprite as well.
+   * @param {boolean} [options.baseTexture=false] - Should it destroy the base texture of the sprite as well.
+   */
   destroy(options) {
-    this.stop();
-    super.destroy(options);
-    this.onComplete = null;
-    this.onFrameChange = null;
-    this.onLoop = null;
+    this.stop(), super.destroy(options), this.onComplete = null, this.onFrameChange = null, this.onLoop = null;
   }
+  /**
+   * A short hand way of creating an AnimatedSprite from an array of frame ids.
+   * @param frames - The array of frames ids the AnimatedSprite will use as its texture frames.
+   * @returns - The new animated sprite with the specified frames.
+   */
   static fromFrames(frames) {
     const textures = [];
-    for (let i = 0; i < frames.length; ++i) {
+    for (let i = 0; i < frames.length; ++i)
       textures.push(core.Texture.from(frames[i]));
-    }
     return new AnimatedSprite(textures);
   }
+  /**
+   * A short hand way of creating an AnimatedSprite from an array of image ids.
+   * @param images - The array of image urls the AnimatedSprite will use as its texture frames.
+   * @returns The new animate sprite with the specified images as frames.
+   */
   static fromImages(images) {
     const textures = [];
-    for (let i = 0; i < images.length; ++i) {
+    for (let i = 0; i < images.length; ++i)
       textures.push(core.Texture.from(images[i]));
-    }
     return new AnimatedSprite(textures);
   }
+  /**
+   * The total number of frames in the AnimatedSprite. This is the same as number of textures
+   * assigned to the AnimatedSprite.
+   * @readonly
+   * @default 0
+   */
   get totalFrames() {
     return this._textures.length;
   }
+  /** The array of textures used for this AnimatedSprite. */
   get textures() {
@@ -142,37 +107,30 @@ return this._textures;
   set textures(value) {
-    if (value[0] instanceof core.Texture) {
-      this._textures = value;
-      this._durations = null;
-    } else {
-      this._textures = [];
-      this._durations = [];
-      for (let i = 0; i < value.length; i++) {
-        this._textures.push(value[i].texture);
-        this._durations.push(value[i].time);
-      }
+    if (value[0] instanceof core.Texture)
+      this._textures = value, this._durations = null;
+    else {
+      this._textures = [], this._durations = [];
+      for (let i = 0; i < value.length; i++)
+        this._textures.push(value[i].texture), this._durations.push(value[i].time);
     }
-    this._previousFrame = null;
-    this.gotoAndStop(0);
-    this.updateTexture();
+    this._previousFrame = null, this.gotoAndStop(0), this.updateTexture();
   }
+  /** The AnimatedSprite's current frame index. */
   get currentFrame() {
     let currentFrame = Math.floor(this._currentTime) % this._textures.length;
-    if (currentFrame < 0) {
-      currentFrame += this._textures.length;
-    }
-    return currentFrame;
+    return currentFrame < 0 && (currentFrame += this._textures.length), currentFrame;
   }
   set currentFrame(value) {
-    if (value < 0 || value > this.totalFrames - 1) {
+    if (value < 0 || value > this.totalFrames - 1)
       throw new Error(`[AnimatedSprite]: Invalid frame index value ${value}, expected to be between 0 and totalFrames ${this.totalFrames}.`);
-    }
     const previousFrame = this.currentFrame;
-    this._currentTime = value;
-    if (previousFrame !== this.currentFrame) {
-      this.updateTexture();
-    }
+    this._currentTime = value, previousFrame !== this.currentFrame && this.updateTexture();
   }
+  /**
+   * Indicates if the AnimatedSprite is currently playing.
+   * @readonly
+   */
   get playing() {
     return this._playing;
   }
+  /** Whether to use Ticker.shared to auto update animation time. */
   get autoUpdate() {
@@ -182,16 +140,6 @@ return this._autoUpdate;
   set autoUpdate(value) {
-    if (value !== this._autoUpdate) {
-      this._autoUpdate = value;
-      if (!this._autoUpdate && this._isConnectedToTicker) {
-        core.Ticker.shared.remove(this.update, this);
-        this._isConnectedToTicker = false;
-      } else if (this._autoUpdate && !this._isConnectedToTicker && this._playing) {
-        core.Ticker.shared.add(this.update, this);
-        this._isConnectedToTicker = true;
-      }
-    }
+    value !== this._autoUpdate && (this._autoUpdate = value, !this._autoUpdate && this._isConnectedToTicker ? (core.Ticker.shared.remove(this.update, this), this._isConnectedToTicker = !1) : this._autoUpdate && !this._isConnectedToTicker && this._playing && (core.Ticker.shared.add(this.update, this), this._isConnectedToTicker = !0));
   }
 }
-
 exports.AnimatedSprite = AnimatedSprite;
 //# sourceMappingURL=AnimatedSprite.js.map

lib/index.js

@@ -1,10 +0,4 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var AnimatedSprite = require('./AnimatedSprite.js');
-
-
-
+"use strict";
+var AnimatedSprite = require("./AnimatedSprite.js");
 exports.AnimatedSprite = AnimatedSprite.AnimatedSprite;
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@pixi/sprite-animated",
-  "version": "7.2.4",
+  "version": "7.3.0-rc",
   "main": "lib/index.js",
@@ -39,5 +39,5 @@ "module": "lib/index.mjs",
   "peerDependencies": {
-    "@pixi/core": "7.2.4",
-    "@pixi/sprite": "7.2.4"
+    "@pixi/core": "7.3.0-rc",
+    "@pixi/sprite": "7.3.0-rc"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

58375

decreased by-5.8%

Lines of code

483

decreased by-14.51%

Number of low quality alerts

1

increased byInfinity%

No dependency changes