Updated preloaded animations and added a few comments

Author: Lukeas14

animateText.js

@@ -17,17 +17,18 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 	function AnimateText(element, textObjects, options, animations){
 		var self = this;
 
-		this.$element = $(element);
+		this.$element = $(element); //ul jQuery object
 		this.textObjects = textObjects;
-		this.lastTextObject;
-		this.repeated = 0;
+		this.lastTextObject; //last text object to complete its animation
+		this.repeated = 0; //# of times the animation sequence has repeated
 
 		//Default options
 		this.defaults = {
 			repeat: true,
 			element: {
 				css: {
 					position: 'relative',
+					overflow: 'hidden',
 					margin: 0,
 					padding: 0,
 					width: function(){
@@ -50,7 +51,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 			},
 			position: {
 				duration: 1000,
-				easing: 'linear'
+				easing: 'swing'
 			}
 		};
 
@@ -62,81 +63,99 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 			"fadeIn": {
 				positions: {
 					start: {
-						opacity:0
+						top: '50%',
+						left: '50%',
+						opacity: 0
 					},
 					0: {
-						opacity:1
+						opacity: 1,
+						duration: 1200
+					},
+					1: {
+						duration: 1200
+					},
+					2: {
+						opacity: 0,
+						duration: 300
 					}
 				}
 			},
 			"fadeOut": {
 				positions: {
 					start: {
-						opacity:1
+						top: '50%',
+						left: '50%',
+						opacity: 1
 					},
 					0: {
-						opacity:0
+						duration: 1200
+					},
+					1: {
+						opacity: 0
 					}
 				}
 			},
-			"right_to_left": {
+			"rightToLeft": {
 				positions: {
 					start: {
-						right: 0,
+						width: '100%',
+						left: '100%',
 						opacity: 0,
-						top: '50%'
+						top: '50%',
+						'text-align': 'left'
 					},
 					0: {
-						right: '75%',
+						left: '25%',
 						opacity: 1,
-						duration:600
+						duration: 1200
 					},
 					1: {
-						duration:600
+						duration: 1200
 					},
 					2: {
 						opacity: 0,
-						duration:600
+						duration: 1200
 					}
 				}
 			},
-			"left_to_right": {
+			"leftToRight": {
 				positions: {
 					start: {
+						width: '100%',
 						right: '100%',
 						opacity: 0,
-						'text-align': 'right',
 						top: '50%',
+						'text-align': 'right'
 					},
 					0: {
 						right: '25%',
 						opacity: 1,
-						duration: 600
+						duration: 1200
 					},
 					1: {
-						duration: 600
+						duration: 1200
 					},
 					2: {
 						opacity: 0,
-						duration: 600
+						duration: 1200
 					}
 				}
 			},
 			"explode": {
 				positions: {
 					start: {
-						top: '30%',
+						top: '40%',
 						width: '100%',
 						opacity: 0,
 						'font-size': '10px',
 						'text-align': 'center'
 					},
 					0: {
-						opacity:1,
-						duration:0
+						opacity: 1,
+						duration: 0
 					},
 					1: {
-						top: '0%',
+						top:'-10%',
 						'font-size': '150px',
 						opacity: 0,
 						duration: 1000
@@ -147,7 +166,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 				positions: {
 					start: {
 						width: '100%',
-						opacity:0,
+						opacity: 0,
 						top: '0%',
 						'font-size': '150px',
 						'text-align': 'center'
@@ -157,6 +176,13 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 						'font-size': '40px',
 						opacity: 1,
 						duration: 1000
+					},
+					1: {
+						duration: 1200
+					},
+					2: {
+						opacity: 0,
+						duration: 400
 					}
 				}
 			}
@@ -175,6 +201,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 			//Hide ul element and set css
 			this.$element.hide().css(this.options.element.css);
 
+			//Start animation as soon as animations and textObjects are loaded.
 			this.loadAnimations();
 			this.loadTextObjects(function(){
 				self.$element.show();
@@ -185,19 +212,23 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 		loadAnimations: function(){
 			var self = this;
 
+			//Validate every position in every animation
 			$.each(this.animations, function(animationId, animation){
 				animation.duration = 0;
 
 				$.each(animation.positions, function(positionId, position){
 					if(positionId !== "start"){
+						//Make sure position's duration is set
 						if(typeof(position.duration) !== "number" || position.duration < 0){
 							position.duration = self.options.position.duration;
 						}
 
+						//Make sure position's easing property is set
 						if(typeof(position.easing) === "undefined"){
 							position.easing = self.options.position.easing;
 						}
 
+						//Calculate the animation's total duration
 						animation.duration += position.duration;
 					}
 				});
@@ -207,8 +238,10 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 		loadTextObjects: function(callback){
 			var self = this;
 
+			//Keep track of the animation sequence's total duration
 			totalDuration = 0;
 
+			//Validate every textObject
 			$.each(this.textObjects, function(textObjectId, textObject){
 				var textObjectDuration = 0;
 
@@ -222,6 +255,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 					return;
 				}
 
+				//Set textObject to its default style
 				textObject.$element.css(self.options.textObject.css).attr('id', textObject.id);
 
 				//Check for valid animation type
@@ -238,8 +272,10 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 					textObject.duration = 0;
 				}
 
+				//Merge textObject's positions with its animation's positions
 				textObject.positions = $.extend(true, {}, self.animations[textObject.animation].positions, textObject.positions);
 
+				//Calculate textObject duration
 				$.each(textObject.positions, function(positionId, position){
 					if(positionId !== "start"){
 						if(typeof(textObject.duration) === "number" && textObject.duration > 0){
@@ -255,7 +291,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 					textObject.duration = textObjectDuration;
 				}
 
-				//Calculate text object duration
+				//Determine if this textObject will be last to complete its animation
 				if((textObject.offset + textObject.duration) > totalDuration){
 					totalDuration = (textObject.offset + textObject.duration);
 					self.lastTextObject = textObject.id;
@@ -274,6 +310,7 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 				//Set textObject to its start position
 				textObject.$element.css(textObject.positions.start);
 
+				//Start textObject's animation after it's offset time has passed
 				setTimeout(function(){
 					self.animateTextObject(textObject.id, 0);
 				}, textObject.offset);
@@ -287,8 +324,14 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 		animateTextObject: function(textObjectId, animationPosition){
 			var self = this,
 				textObject = this.textObjects[textObjectId],
-				animation = this.animations[textObject.animation];
-
+				animation = this.animations[textObject.animation],
+				test = function(){
+					var to = textObject;
+					console.log(to);
+					return 'hey';
+				};
+
+			//Finally, animate the textObject
 			textObject.$element.animate(
 				textObject.positions[animationPosition],
 				textObject.positions[animationPosition].duration,
@@ -304,13 +347,9 @@ Licensed under MIT License (https://github.com/jquery/jquery/blob/master/MIT-LIC
 
 						//Repeat animations if repeat option is set to true or we're still under the set repeat limit
 						if(self.options.repeat === true || (typeof(self.options.repeat) === "number" && self.repeated < self.options.repeat)){
-							self.stopAnimation();
 							self.startAnimation();
 							self.repeated++;
 						}
-						else{
-							self.stopAnimation();
-						}
 					}
 				}
 			);