isaacscript-common 30.5.5 → 30.6.0

package/dist/index.rollup.d.ts

@@ -12883,6 +12883,15 @@ export declare function newRNG(seed?: Seed): RNG;
  */
 export declare function newRoom(seedOrRNG?: Seed | RNG): int | undefined;
 
+/**
+ * Helper function to load a new sprite and play its default animation.
+ *
+ * @param anm2Path The path to the "anm2" file that should be loaded.
+ * @param pngPath Optional. The path to a custom PNG file that should be loaded on layer 0 of the
+ *                sprite.
+ */
+export declare function newSprite(anm2Path: string, pngPath?: string): Sprite;
+
 /**
  * Helper function to generate a new sprite based on a collectible. If the provided collectible type
  * is invalid, a sprite with a Curse of the Blind question mark will be returned.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 30.5.5
+isaacscript-common 30.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -20714,6 +20714,19 @@ function ____exports.getLastFrameOfAnimation(self, sprite, animation)
     sprite:SetFrame(currentFrame)
     return finalFrame
 end
+function ____exports.newSprite(self, anm2Path, pngPath)
+    local sprite = Sprite()
+    if pngPath == nil then
+        sprite:Load(anm2Path, true)
+    else
+        sprite:Load(anm2Path, false)
+        sprite:ReplaceSpritesheet(0, pngPath)
+        sprite:LoadGraphics()
+    end
+    local defaultAnimation = sprite:GetDefaultAnimation()
+    sprite:Play(defaultAnimation, true)
+    return sprite
+end
 function ____exports.setSpriteOpacity(self, sprite, alpha)
     local fadedColor = copyColor(nil, sprite.Color)
     fadedColor.A = alpha

package/dist/src/functions/sprites.d.ts

@@ -32,6 +32,14 @@ export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
  * player animations.
  */
 export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: string): int;
+/**
+ * Helper function to load a new sprite and play its default animation.
+ *
+ * @param anm2Path The path to the "anm2" file that should be loaded.
+ * @param pngPath Optional. The path to a custom PNG file that should be loaded on layer 0 of the
+ *                sprite.
+ */
+export declare function newSprite(anm2Path: string, pngPath?: string): Sprite;
 /**
  * Helper function to keep a sprite's color the same values as it already is but set the opacity to
  * a specific value.

package/dist/src/functions/sprites.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sprites.d.ts","sourceRoot":"","sources":["../../../src/functions/sprites.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAWpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GACjB,GAAG,CAmBL;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAInE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,EACf,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,GACd,OAAO,CAaT;AAED,uFAAuF;AACvF,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,GACX,OAAO,CAIT"}
+{"version":3,"file":"sprites.d.ts","sourceRoot":"","sources":["../../../src/functions/sprites.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAWpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GACjB,GAAG,CAmBL;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAepE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAInE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,EACf,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,GACd,OAAO,CAaT;AAED,uFAAuF;AACvF,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,GACX,OAAO,CAIT"}

package/dist/src/functions/sprites.lua

@@ -64,6 +64,24 @@ function ____exports.getLastFrameOfAnimation(self, sprite, animation)
     sprite:SetFrame(currentFrame)
     return finalFrame
 end
+--- Helper function to load a new sprite and play its default animation.
+-- 
+-- @param anm2Path The path to the "anm2" file that should be loaded.
+-- @param pngPath Optional. The path to a custom PNG file that should be loaded on layer 0 of the
+-- sprite.
+function ____exports.newSprite(self, anm2Path, pngPath)
+    local sprite = Sprite()
+    if pngPath == nil then
+        sprite:Load(anm2Path, true)
+    else
+        sprite:Load(anm2Path, false)
+        sprite:ReplaceSpritesheet(0, pngPath)
+        sprite:LoadGraphics()
+    end
+    local defaultAnimation = sprite:GetDefaultAnimation()
+    sprite:Play(defaultAnimation, true)
+    return sprite
+end
 --- Helper function to keep a sprite's color the same values as it already is but set the opacity to
 -- a specific value.
 -- 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "30.5.5",
+  "version": "30.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/sprites.ts

@@ -69,6 +69,30 @@ export function getLastFrameOfAnimation(
   return finalFrame;
 }
 
+/**
+ * Helper function to load a new sprite and play its default animation.
+ *
+ * @param anm2Path The path to the "anm2" file that should be loaded.
+ * @param pngPath Optional. The path to a custom PNG file that should be loaded on layer 0 of the
+ *                sprite.
+ */
+export function newSprite(anm2Path: string, pngPath?: string): Sprite {
+  const sprite = Sprite();
+
+  if (pngPath === undefined) {
+    sprite.Load(anm2Path, true);
+  } else {
+    sprite.Load(anm2Path, false);
+    sprite.ReplaceSpritesheet(0, pngPath);
+    sprite.LoadGraphics();
+  }
+
+  const defaultAnimation = sprite.GetDefaultAnimation();
+  sprite.Play(defaultAnimation, true);
+
+  return sprite;
+}
+
 /**
  * Helper function to keep a sprite's color the same values as it already is but set the opacity to
  * a specific value.