API Documentation for: 0.6.0
Show:

SpriteSheetLoader Class

Defined in: SpriteSheetLoader:41
Module: PreloadJS

A loader for EaselJS SpriteSheets. Images inside the spritesheet definition are loaded before the loader completes. To load SpriteSheets using JSONP, specify a callback as part of the LoadItem. Note that the JSONLoader and JSONPLoader are higher priority loaders, so SpriteSheets must set the LoadItem type property to SPRITESHEET.

Constructor

SpriteSheetLoader

(
  • loadItem
)

Parameters:

Methods

_handleManifestComplete

(
  • event
)
private

The images have completed loading. This triggers the complete Event from the SpriteSheetLoader.

Parameters:

_handleManifestError

(
  • event
)
private

An image has reported an error.

Parameters:

_handleManifestFileLoad

(
  • event
)
private

An item from the _manifestQueue:property has completed.

Parameters:

_handleManifestProgress

(
  • event
)
private

The images LoadQueue has reported progress.

Parameters:

_loadManifest

(
  • json
)
private

Defined in _loadManifest:126

Create and load the images once the SpriteSheet JSON has been loaded.

Parameters:

_manifestQueue

() private

Defined in _manifestQueue:56

An internal queue which loads the SpriteSheet's images.

canLoadItem

(
  • item
)
Boolean static

Defined in canLoadItem:80

Determines if the loader can load a specific item. This loader can only load items that are of type SPRITESHEET

Parameters:

  • item LoadItem | Object

    The LoadItem that a LoadQueue is trying to load.

Returns:

Boolean:

Whether the loader can load the item.

Properties

SPRITESHEET_PROGRESS

Number private static

The amount of progress that the manifest itself takes up.

Default: 0.25 (25%)