Merge pull request #81 from pixijs/v3

V3 to master

.gitignore

@@ -5,4 +5,5 @@ docs/docs
 docs/examples/libs
 node_modules
 assets
-npm-debug.log
+npm-debug.log
+ts-dist

.travis.yml

@@ -1,5 +1,3 @@
 language: node_js
 node_js:
-  - "0.12"
-before_install:
-  - npm install -g grunt-cli
+  - "8.9.4"

README.md

@@ -4,6 +4,14 @@
 
 A particle system library for the [PixiJS](https://github.com/pixijs/pixi.js) library. Also, we created an [interactive particle editor](http://pixijs.github.io/pixi-particles-editor/) to design and preview custom particle emitters which utilitze PixiParticles.
 
+## Breaking changes in v3 from v2
+* On `Emitter`, `playOnce()` no longer sets `autoUpdate` to true. Set it manually before use.
+	`playOnceAndDestroy()` is unaffected.
+* On `Emitter`, `start*` and `end*` properties for alpha, color, scale, and speed have been
+	replaced by a singly linked list of `PropertyNode` objects.
+* Dropped support for PIXI v3. Please use v4.
+* The library is no longer exported as a node export, only adding itself to the global PIXI namespace.
+
 ## Sample Usage
 
 Please see the examples for various pre-made particle configurations.
@@ -24,20 +32,56 @@ var emitter = new PIXI.particles.Emitter(
 	// of the emitter
 	{
 		alpha: {
-			start: 0.8,
-			end: 0.1
+			list: [
+				{
+					value: 0.8,
+					time: 0
+				},
+				{
+					value: 0.1,
+					time: 1
+				}
+			],
+			isStepped: false
 		},
 		scale: {
-			start: 1,
-			end: 0.3
+			list: [
+				{
+					value: 1,
+					time: 0
+				},
+				{
+					value: 0.3,
+					time: 1
+				}
+			],
+			isStepped: false
 		},
 		color: {
-			start: "fb1010",
-			end: "f5b830"
+			list: [
+				{
+					value: "fb1010",
+					time: 0
+				},
+				{
+					value: "f5b830",
+					time: 1
+				}
+			],
+			isStepped: false
 		},
 		speed: {
-			start: 200,
-			end: 100
+			list: [
+				{
+					value: 200,
+					time: 0
+				},
+				{
+					value: 100,
+					time: 1
+				}
+			],
+			isStepped: false
 		},
 		startRotation: {
 			min: 0,
@@ -52,6 +96,8 @@ var emitter = new PIXI.particles.Emitter(
 			max: 0.5
 		},
 		frequency: 0.008,
+		spawnChance: 1,
+		particlesPerWave: 1,
 		emitterLifetime: 0.31,
 		maxParticles: 1000,
 		pos: {

ambient.d.ts

@@ -1,6 +1,13 @@
 // Typings for pixi-particles 2.1.9, requires Pixi.js typings
 declare namespace PIXI.particles {
 	type TexSrc = string|PIXI.Texture;
+	type Color = {r:number, g:number, b:number};
+
+	export interface ValueList {
+		list: {value:number|string, time:number}[],
+		isStepped?: boolean;
+		ease?: (lerp:number)=>number|EaseSegment[];
+	}
 
 	export interface ParticleConstructor {
 		new (emitter:Emitter):Particle;
@@ -38,7 +45,6 @@ declare namespace PIXI.particles {
 		private _prevEmitterPos:PIXI.Point;
 		private _prevPosIsValid:boolean;
 		private _posChanged:boolean;
-		private _parentIsPC:boolean;
 		private _parent:PIXI.Container;
 		private _emit:boolean;
 		private _spawnTimer:number;
@@ -53,18 +59,14 @@ declare namespace PIXI.particles {
 		private _completeCallback:()=>void;
 
 		public particleImages:any[];
-		public startAlpha:number;
-		public endAlpha:number;
-		public startSpeed:number;
-		public endSpeed:number;
+		public startAlpha:PropertyNode;
+		public startSpeed:PropertyNode;
 		public minimumSpeedMultiplier:number;
 		public acceleration:PIXI.Point;
 		public maxSpeed:number;
-		public startScale:number;
-		public endScale:number;
+		public startScale:PropertyNode;
 		public minimumScaleMultiplier:number;
-		public startColor:[number, number, number];
-		public endColor:[number, number, number];
+		public startColor:PropertyNode;
 		public minLifetime:number;
 		public maxLifetime:number;
 		public minStartRotation:number;
@@ -89,6 +91,7 @@ declare namespace PIXI.particles {
 		public addAtBack:boolean;
 		public readonly particleCount:number;
 		public frequency:number;
+		public spawnChance:number;
 		public particleConstructor:ParticleConstructor;
 		public parent:PIXI.Container;
 		public emit:boolean;
@@ -116,12 +119,6 @@ declare namespace PIXI.particles {
 	}
 
 	export class Particle extends PIXI.Sprite {
-		private _sR:number;
-		private _sG:number;
-		private _sB:number;
-		private _eR:number;
-		private _eG:number;
-		private _eB:number;
 		private _doAlpha:boolean;
 		private _doScale:boolean;
 		private _doSpeed:boolean;
@@ -138,16 +135,12 @@ declare namespace PIXI.particles {
 		public age:number;
 		public ease:(time:number)=>number;
 		public extraData:any;
-		public startAlpha:number;
-		public endAlpha:number;
-		public startSpeed:number;
-		public endSpeed:number;
+		public alphaList:PropertyList;
+		public speedList:PropertyList;
 		public acceleration:PIXI.Point;
 		public maxSpeed:number;
-		public startScale:number;
-		public endScale:number;
-		public startColor:number[];
-		public endColor:number[];
+		public scaleList:PropertyList;
+		public colorList:PropertyList;
 
 		/** Note that for Particle, the parameter is an array of strings or PIXI.Textures, and an array of Textures is returned. */
 		public static parseArt(art:any):any;
@@ -182,6 +175,7 @@ declare namespace PIXI.particles {
 		public static hexToRGB(color:string, output?:[number, number, number]):[number, number, number];
 		public static generateEase(segments:EaseSegment[]):(time:number)=>number;
 		public static getBlendMode(name:string):number;
+		public static createSteppedGradient(list:{value:string, time:number}, numSteps?:number):PropertyNode;
 	}
 
 	export class PathParticle extends Particle {
@@ -193,4 +187,26 @@ declare namespace PIXI.particles {
 		public static parseArt(art:TexSrc[]):PIXI.Texture[];
 		public static parseData(data:{path:string}):any;
 	}
+
+	export class PropertyList {
+		public current: PropertyNode;
+		protected next: PropertyNode;
+		private isColor: boolean;
+		private ease: Function;
+
+		constructor(isColor?:boolean);
+		public interpolate(lerp:number):number;
+		public reset(first:PropertyNode):void;
+	}
+
+	export class PropertyNode {
+		public value: number|Color;
+		public time: number;
+		public next: PropertyNode;
+		public isStepped: boolean;
+		private interpolate: (lerp:number)=>number;
+		private ease: (lerp:number)=>number;
+
+		public static createList(data:ValueList):PropertyNode;
+	}
 }