API Docs for: 1.0.1

Grape.Sprite Class

Extends
Defined in: js\grape\resource\sprite.js:39

A sprite is an image or an animation. It can be defined as a part of a real image (tile sets). When a sprite is an animation, the subsequent images have to be next to each other (left to right direction)

Constructor

Grape.Sprite

(
  • url
  • opts
)

Defined in js\grape\resource\sprite.js:39

Parameters:

  • url String
  • opts Object

    Initial properties

Methods

getResourceKey

()

Inherited from Grape.Cacheable: js\grape\resource\cacheable.js:31

An abstract method which should return the same key when the resource is the same, it is used as cache key. A typical key is the url.

loadResource

(
  • onFinish
  • onError
  • onProgress
)

Inherited from Grape.Cacheable: js\grape\resource\cacheable.js:39

This method is called when we want to load the resource and it is not in the cache.

Parameters:

  • onFinish Function

    Should be called when the resource is ready. The parameter is the loaded data.

  • onError Function

    Should be called when an error occurs

  • onProgress Function

    Should be called when the loading progress changes (0-100)

process

(
  • (*)
)

Inherited from Grape.Cacheable: js\grape\resource\cacheable.js:48

This method is called after load is called. If load is called multiple times, this method is not called more than once. It should initialize the resource with the loaded data.

Parameters:

  • (*) Object

    data The loaded data (passed to the onFinish method in loadResource

Properties

bottomBounding

Number

Defined in js\grape\resource\sprite.js:133

The bottom side of the sprite's bounding box. If not set it will be the image height.

height

Number

Defined in js\grape\resource\sprite.js:119

The height of the sprite. If not set, it will be the height of the image.

left

Number

Defined in js\grape\resource\sprite.js:52

The left position of the sprite in the image.

Default: 0

leftBounding

Number

Defined in js\grape\resource\sprite.js:68

The left side of the sprite's bounding box

Default: 0

originX

Number

Defined in js\grape\resource\sprite.js:85

The x coordinate of the sprite origin

Default: 0

originY

Number

Defined in js\grape\resource\sprite.js:93

The y coordinate of the sprite origin

Default: 0

rightBounding

Number

Defined in js\grape\resource\sprite.js:126

The right side of the sprite's bounding box. If not set, it will be the image width.

subimages

Number

Defined in js\grape\resource\sprite.js:102

The number of subimages (animation length). Subsequent images have to be arranged left to right.

Default: 1

top

Number

Defined in js\grape\resource\sprite.js:60

The top position of the sprite in the image.

Default: 0

topBounding

Number

Defined in js\grape\resource\sprite.js:76

The top side of the sprite's bounding box

Default: 0

width

Number

Defined in js\grape\resource\sprite.js:112

The width of the sprite. If not set, it will be calculated by the image width and the animation length.