Class Sprite

Defined in: graphics.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Sprite(path) Creates an instance of a Sprite

Field Summary
Field Attributes	Field Name and Description
	alpha Alpha transparency value.
	angle Starting angle value for rotation.
	image Image array for animated sprites.
	imageindex Sprite image index.
	nsprites Number of sprites in current Sprite object.
	path Path to sprite image file.
	visible Sprite visible property.
	x Current sprite X position.
	y Current sprite Y position.

Method Summary
Method Attributes	Method Name and Description
	add(path) Add a sprite to the sprite #image Array.
	cycle() Cycle through sprites in #image Array.
	draw(ctx) Draw sprite on Canvas 2D context.
	getAngle() Return angle of sprite value stored in #angle.
	getImageIndex() Return sprite image index value stored in #imageindex.
	getNumSprites() Return number of sprites value stored in #nsprites.
	getTransparency() Return alpha transparency value stored in #alpha.
	getVisible() Return visible property stored in #visible.
	getX() Return sprite x axis cartesian co-ordinate value stored in #x.
	getY() Return sprite y axis cartesian co-ordinate value stored in #y.
	hide() Set sprite to be invisible when drawing.
	load() Load sprite image file from the path given in #path.
	rotate(angle) Rotate sprite when drawing.
	scale(width, height) Scale sprite when drawing by width and height.
	setPosition(x, y) Set sprite position using cartesian coordinates.
	setSpriteIndex(i) Set a sprites current image.
	show() Set sprite to be visible when drawing.
	transparency(value) Set alpha transparency of sprite.

Class Detail

Sprite(path)

Creates an instance of a Sprite

Parameters:
{String} path: Path to sprite image file.

See:: graphics.js

Field Detail

{Number} alpha

Alpha transparency value.

{Number} angle

Starting angle value for rotation.

{Array} image

Image array for animated sprites.

{Number} imageindex

Sprite image index.

{Number} nsprites

Number of sprites in current Sprite object.

{String} path

Path to sprite image file.

{Boolean} visible

Sprite visible property.

{Number} x

Current sprite X position.

{Number} y

Current sprite Y position.

Method Detail

add(path)

Add a sprite to the sprite #image Array. Used to create animated sprites.

Parameters:
{String} path: Path to sprite image file.

cycle()

Cycle through sprites in #image Array. Used to play animated sprites.

draw(ctx)

Draw sprite on Canvas 2D context.

Parameters:
{[object CanvasRenderingContext2D]} ctx: Canvas 2D context to draw onto.

{Number} getAngle()

Return angle of sprite value stored in #angle.

Returns:: {Number} Number denoting angle of sprite.

{Number} getImageIndex()

Return sprite image index value stored in #imageindex.

Returns:: {Number} Number denoting image index value.

{Number} getNumSprites()

Return number of sprites value stored in #nsprites.

Returns:: {Number} Number denoting number of sprites value.

{Number} getTransparency()

Return alpha transparency value stored in #alpha.

Returns:: {Number} Number denoting alpha transparency value.

{Boolean} getVisible()

Return visible property stored in #visible.

Returns:: {Boolean} Boolean denoting visible property.

{Number} getX()

Return sprite x axis cartesian co-ordinate value stored in #x.

Returns:: {Number} Number denoting sprite x axis cartesian co-ordinate value.

{Number} getY()

Return sprite y axis cartesian co-ordinate value stored in #y.

Returns:: {Number} Number denoting sprite y axis cartesian co-ordinate value.

hide()

Set sprite to be invisible when drawing.

load()

Load sprite image file from the path given in #path.

rotate(angle)

Rotate sprite when drawing.

Parameters:
{Number} angle: Angle of rotation in degrees.

scale(width, height)

Scale sprite when drawing by width and height.

Parameters:
{Number} width: Width to scale sprite by.
{Number} height: Height to scale sprite by.

setPosition(x, y)

Set sprite position using cartesian coordinates.

Parameters:
{Number} x: Set sprite X axis position.
{Number} y: Set sprite Y axis position.

setSpriteIndex(i)

Set a sprites current image. Used to set animated sprite image.

Parameters:
{Number} i: Index of image in #image Array.

show()

Set sprite to be visible when drawing.

transparency(value)

Set alpha transparency of sprite.

Parameters:
{Number} value: Transparency value from 0.0 to 1.0

Classes

Class Sprite