API Docs for: 0.0.2
Show:

Atlantis.SpriteGroup Class

Extends Sprite
Defined in: Engine\Graphics\SpriteGroup.js:11
Module: Engine
Parent Module: Atlantis

A collection that initialize, load, update and draw _sprites.

Constructor

Atlantis.SpriteGroup

()

Defined in Engine\Graphics\SpriteGroup.js:11

Methods

add

(
  • sprite
)

Defined in Engine\Graphics\SpriteGroup.js:297

Add an sprite to the group.

Parameters:

  • sprite Atlantis.Sprite

    The sprite to add.

addAnimation

()

Defined in Engine\Graphics\Sprite.js:255

clear

()

Defined in Engine\Graphics\SpriteGroup.js:111

Clear the collection.

collides

() Boolean

Defined in Engine\Graphics\Sprite.js:203

Returns:

Boolean:

Return true if collides otherwise return false.

collidesWithGroup

(
  • sprite
  • computeBoundingRect
)
Boolean

Defined in Engine\Graphics\SpriteGroup.js:140

Parameters:

  • sprite Atlantis.Sprite
  • computeBoundingRect Boolean

Returns:

Boolean:

computeBoundingSize

()

Defined in Engine\Graphics\SpriteGroup.js:154

Compute the bounding size of the group.

countDead

() Number

Defined in Engine\Graphics\SpriteGroup.js:184

Count the number of dead sprite in the group.

Returns:

Number:

Return the number of dead sprites.

countLiving

() Number

Defined in Engine\Graphics\SpriteGroup.js:169

Count the number of living sprite in the group.

Returns:

Number:

Return the number of living sprites.

draw

(
  • spriteBatch
)

Defined in Engine\Graphics\Sprite.js:370

Draw the sprite on screen.

Parameters:

draw

(
  • UNKNOWN
)

Defined in Engine\Graphics\SpriteGroup.js:96

Draw all members on screen.

Parameters:

forEach

(
  • callback
)

Defined in Engine\Graphics\SpriteGroup.js:199

Parameters:

get

(
  • index
)

Defined in Engine\Graphics\SpriteGroup.js:211

Gets an sprite from the group.

Parameters:

  • index Number

    The index of the sprite on the group.

getFirstAlive

() Atlantis.Sprite

Defined in Engine\Graphics\SpriteGroup.js:243

Gets the first alive sprite if available.

Returns:

Atlantis.Sprite:

Return the first alive sprite, otherwise return null.

getFirstDead

() Atlantis.Sprite

Defined in Engine\Graphics\SpriteGroup.js:226

Gets the first dead sprite if available.

Returns:

Atlantis.Sprite:

Return the first killed sprite otherwise return null.

getFirstNull

() Number

Defined in Engine\Graphics\SpriteGroup.js:260

Gets the first null index.

Returns:

Number:

Return the index of the first null element in the group otherwise return -1.

initialize

(
  • callback
)

Defined in Engine\Graphics\Sprite.js:177

Parameters:

  • callback Function

    A callback called when the sprite is fully loaded.

initialize

(
  • callback
)

Defined in Engine\Graphics\SpriteGroup.js:49

Load assets of all members.

Parameters:

kill

()

Defined in Engine\Graphics\Sprite.js:218

Kill the sprite and put it in a cache so that it can be recycled if needed.

play

()

Defined in Engine\Graphics\Sprite.js:269

postUpdate

(
  • gameTime
)

Defined in Engine\Graphics\Sprite.js:316

Method called after the update process.

Parameters:

prepareAnimation

()

Defined in Engine\Graphics\Sprite.js:238

preUpdate

(
  • gameTime
)

Defined in Engine\Graphics\Sprite.js:280

Function called before update process.

Parameters:

preUpdate

(
  • gameTime
)

Defined in Engine\Graphics\SpriteGroup.js:89

Function called before update process.

Parameters:

remove

(
  • sprite
  • splice
)

Defined in Engine\Graphics\SpriteGroup.js:351

remove a sprite from the group.

Parameters:

  • sprite Atlantis.Sprite

    The sprite to remove.

  • splice Boolean

    Whether the object should be cut from the array entirely or not.

removeAt

(
  • index
  • splice
)

Defined in Engine\Graphics\SpriteGroup.js:324

Remove a sprite from the group at the position.

Parameters:

  • index Number

    The index of the sprite to remove.

  • splice Boolean

    Whether the object should be cut from the array entirely or not.

revive

()

Defined in Engine\Graphics\Sprite.js:228

Revive the Sprite and remove it from the recycle cache.

setSize

()

Defined in Engine\Graphics\Sprite.js:381

update

(
  • gameTime
)

Defined in Engine\Graphics\SpriteGroup.js:69

Update logic of all members.

Parameters:

update

(
  • gameTime
)

Defined in Engine\Graphics\Sprite.js:287

Update process.

Parameters:

Properties

active

Boolean

Defined in Engine\Graphics\Sprite.js:58

Active or not the sprite.

Default: true

alive

Boolean

Defined in Engine\Graphics\Sprite.js:71

Indicate if the sprite is alive or dead.

Default: true

height

Number

Defined in Engine\Graphics\Sprite.js:126

Sprite's height.

Default: 0

texture

Object

Defined in Engine\Graphics\Sprite.js:149

Sprite's texture.

Default: null

textureName

String

Defined in Engine\Graphics\Sprite.js:136

The name of the texture used by the sprite.

Default: ""

width

Number

Defined in Engine\Graphics\Sprite.js:116

Sprite's width.

Default: 0

x

Number

Defined in Engine\Graphics\Sprite.js:88

Position on X axis.

Default: 0

y

Boolean

Defined in Engine\Graphics\Sprite.js:102

Position on Y axis.

Default: 0