Documentation

Author: OttCS

documentation.html

@@ -31,6 +31,8 @@ <h2>PIXI.Zephyr</h2>
             <dd>Sets up the WebAudio API for Pixi-style usage</dd>
             <dt>PIXI.Zephyr.useFile()</dt>
             <dd>Sets up the File reading/writing system</dd>
+            <dt class="nightly">PIXI.Zephyr.useParticles()</dt>
+            <dd>Sets up the Particle Emitter backend for Pixi-Style usage</dd>
         </dl>
         <br>
         <h2>PIXI.Keys</h2>
@@ -89,20 +91,18 @@ <h2>PIXI.File</h2>
             <dd class="return">Object</dd>
         </dl>
         <br>
-        <h2>PIXI.Particles</h2>
+        <h2 class="nightly">PIXI.Particles</h2>
         <dl>
             <dt>PIXI.Particles.from(src, maxParticleCount)</dt>
             <dd>Returns a "PIXI Particle Emitter" which is a particleContainer with a built-in <strong>step()</strong>
                 function to progress the animation. The different attributes of the container specify how the particles
                 are emitted.</dd>
-            <dd class="return">Pixi Particle Container
-                <br>{
-                <br>life: how far the particles can move away from the emitter's location, in pixels (default 128)
-                <br>speed: quickly the particles move to their end of life distance (default 1)
-                <br>direction: specifies the direction (in radians) that the particles will move (default 0)
-                <br>spread: the angle (in radians) of how closely particles should follow the direction. 0 is no deviation, 2 PI is in a full circle (default is 2 PI)
-                <br>step(): moves and updates all particles
-                <br>}
+            <dd class="return">Pixi Particle Emitter</dd>
+            <dd>.life = how far the particles can move away from the emitter's location, in pixels (default 128)
+                <br>.speed = quickly the particles move to their end of life distance (default 1)
+                <br>.direction = specifies the direction (in radians) that the particles will move (default 0)
+                <br>.spread = the angle (in radians) of how closely particles should follow the direction. 0 is no deviation, 2 PI is in a full circle (default is 2 PI)
+                <br>.step() = a shared function that moves and updates all particles
             </dd>
         </dl>
         <br>

nightly/zephyr.js

@@ -154,9 +154,9 @@ PIXI.Zephyr = {
                     p.life = this.life;
                 }
                 if (this.children.length < this.size) {
-                    this.spawnTime -= deltaTime;
-                    if (this.spawnTime <= 0) {
-                        this.spawnTime = this.life / this.size;
+                    this._spawnTimer -= deltaTime;
+                    if (this._spawnTimer <= 0) {
+                        this._spawnTimer = this.life / this.size;
                         let p = new PIXI.Sprite(this.baseTexture);
                         p.anchor = { x: 0.5, y: 0.5 }
                         init(p);
@@ -170,15 +170,16 @@ PIXI.Zephyr = {
                         init(p);
                 });
             },
-            from: (src, size) => {
+            from: (src, size, options) => {
+                if (!options) options = {};
                 let res = new PIXI.ParticleContainer(size);
+                res._spawnTimer = 0;
                 res.size = size;
                 res.baseTexture = PIXI.Texture.from(src);
-                res.life = 128;
-                res.speed = 1;
-                res.direction = 0;
-                res.spread = 6.2831853072;
-                res.spawnTime = 0;
+                res.life = (options.life ? options.life : 128);
+                res.speed = (options.speed ? options.speed : 1);
+                res.direction = (options.direction ? options.direction : 0);
+                res.spread = (options.spread ? options.spread : 6.2831853072);
                 res.step = PIXI.Particles._step;
                 return res;
             }