/**
* 
* @module Kiwi
* @submodule Animations
* 
*/

module Kiwi.Animations {

	/**
	* A Sequence is a series of cells that are held on a SpriteSheet/TextureAtlas.
	* Sequences are generally used with the AnimationManager/Animation sections as a way to initially create Animations on GameObjects that use the same TextureAtlas.
	* 
	* @class Sequence
	* @namespace Kiwi.Animations
	* @constructor
	* @param name {String} The name of this sequence. This is not unique.
	* @param cells {Number[]} The cells that are in this animation.
	* @param [speed=0.1] {Number} The time an animation should spend on each frame.
	* @param [loop=true] {boolean} If the sequence should play again if it was animating and the animation reaches the last frame.
	* @return {Kiwi.Animations.Sequence}
	* 
	*/
	export class Sequence {

		constructor(name:string,cells:number[],speed:number=0.1,loop:boolean=true) {
			this.name = name;
			this.cells = cells;
			this.speed = speed;
			this.loop = loop;
		}

		/**
		* The name of this sequence.
		* @property name
		* @type string
		* @public
		*/
		public name: string;

		/**
		* The cells that are in this animation.
		* These are a reference to the cells that are contained in a texture atlas that this sequence should be a part of.
		* @property cells
		* @type number[]
		* @public
		*/
		public cells: number[];

		/**
		* The time an animation should spend on each cell.
		* @property speed
		* @type boolean
		* @public
		*/
		public speed: number;

		/**
		* If the sequence should play again if it was animating and the animation reaches the last frame.
		* @property loop
		* @type boolean
		* @public
		*/
		public loop: boolean;

	}
}