SpriteLoader Class

The SpriteLoader class handles loading, caching, and retrieving sprite assets for use in the game.

---

Example usage

import { SpriteLoader } from "./sprite-loader";

const spriteLoader = new SpriteLoader();

async function initSprites() {
  try {
    await spriteLoader.loadSprite("enemy", "/assets/enemy.png", {
      spriteWidth: 32,
      spriteHeight: 32,
    });

    const enemySprite = spriteLoader.getSprite("enemy");
    if (enemySprite) {
      console.log("Enemy sprite loaded!", enemySprite);
    }
  } catch (error) {
    console.error("Sprite loading error:", error);
  }
}

initSprites();

Constructor

new SpriteLoader();

Methods

loadSprite

Parameter	Type	Description
name	string	Unique identifier for the sprite
src	string	Path to the sprite image
config	SpriteConfig	Configuration for sprite properties

Example

const loader = new SpriteLoader();
await loader.loadSprite("player", "/assets/player.png", {
  spriteWidth: 64,
  spriteHeight: 64,
});

getSprite

Retrieves a previously loaded sprite by name.

Return Sprite object if found, otherwise null.

Parameter	Type	Description
name	string	Unique identifier for the sprite

Example

const playerSprite = loader.getSprite("player");
if (playerSprite) {
  console.log("Player sprite loaded successfully!");
}

Notes

• Error Handling:
  • Throws an error if the sprite image fails to load.
• Caching:
  • Loaded sprites are stored in an internal map for efficient retrieval.