jquery.animateSprite

Animating sprites using jQuery made easy

Release notes

1.1.3 Added a fancy page to explain the plugin (http://blaiprat.github.com/jquery.animateSprite). Renamed "showFrame" to "frame"

1.1 Refacotred the plugin. Added new methods so it's easier to control what the plugin is doing. Also now it chains correctly and controls multiple jquery objects instead of one

1.0 Initial release

How to use it

1. Create an HTML Block Element (aka DIV) and define its width and height exactly as the with and height of the sprite.

2. Put the sprite file as a background image.

3. Call the plugin.

Example:

	$(".sprite").animateSprite({
		columns: 10,
		totalFrames: 20,
		duration: 2000,
		loop: true,
		complete: function(){
			alert("Sprite animation complete!");
		}
	})

Options

	columns: 		int // the number of columns the sprite sheet has, default 10
	totalFrames:	int // number of frames the animation has
	duration:		int // time to complete the animation, in milliseconds
	complete:		function // called after the animation has finished (not called if is loop)
	loop:			bool // if the animation has to loop

Methods

	$("object").animateSprite("stopAnimation")		stops the animation
	$("object").animateSprite("resumeAnimation")	continues the animation from the point where it was stopped
	$("object").animateSprite("restartAnimation")	starts the animation from the beginning
	$("object").animateSprite("frame", n)		displays the frame number "n"