Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a collection of sprites from a source image with some organization in a grid

Hierarchy

  • SpriteSheet

Index

Constructors

Properties

columns: number
rows: number
sprites: Sprite[] = []

Methods

  • getSprite(x: number, y: number): Sprite
  • Find a sprite by their x/y position in the SpriteSheet, for example getSprite(0, 0) is the Sprite in the top-left

    Parameters

    • x: number
    • y: number

    Returns Sprite

  • Create a SpriteSheet from an ImageSource organized in a grid

    Example:

    const spriteSheet = SpriteSheet.fromImageSource({
    image: imageSource,
    grid: {
    rows: 5,
    columns: 2,
    spriteWidth: 32, // pixels
    spriteHeight: 32 // pixels
    },
    // Optionally specify spacing
    spacing: {
    // pixels from the top left to start the sprite parsing
    originOffset: {
    x: 5,
    y: 5
    },
    // pixels between each sprite while parsing
    margin: {
    x: 1,
    y: 1
    }
    }
    })

    Parameters

    Returns SpriteSheet