API Docs for: 1.13.1
Show:

game.SpriteSheet Class

Extends game.Class
Module: renderer

Constructor

game.SpriteSheet

(
  • id
  • width
  • height
)

Parameters:

  • id String

    Asset ID

  • width Number

    Sprite frame width

  • height Number

    Sprite frame height

Item Index

Methods

Properties

Methods

anim

(
  • frames
  • [startIndex]
  • [onlyTextures]
)
game.Animation | Array

Create animation from spritesheet.

Parameters:

  • frames Number | Array

    List or number of frames

  • [startIndex] Number optional

    The index to begin with, default to 0

  • [onlyTextures] Boolean optional

    Return only textures

Returns:

game.Animation | Array:

frame

(
  • index
)
game.Sprite

Create sprite from specific frame.

Parameters:

  • index Number

    Frame index

Returns:

Properties

frames

Number

Number of frames