23.2

OttCS · OttCS · commit 8a292fedcafc · 2023-01-31T23:55:46.000-05:00
diff --git a/demo/app.js b/demo/app.js
@@ -18,13 +18,14 @@ backdrop.height = app.view.height;
 backdrop.anchor = { x: 0, y: 0 };
 app.stage.addChild(backdrop);
 
-const emitter = PIXI.Particles.from('/demo/assets/star.png', 250);
-emitter.life = app.view.width * 0.7071067812;
-emitter.direction = Math.PI * 1.5;
-emitter.spread = Math.PI;
+const emitter = PIXI.Particles.from('/demo/assets/star.png', 250, {
+    life: app.view.width * 0.7071067812,
+    direction: Math.PI * 1.5,
+    spread: Math.PI,
+});
 emitter.x = app.view.width * 0.5;
 emitter.y = app.view.height;
-app.stage.addChild(emitter)
+app.stage.addChild(emitter);
 
 let planet = new PIXI.Sprite(tex.planet);
 planet.anchor = { x: 0.5, y: 0.5 };
diff --git a/documentation.html b/documentation.html
@@ -9,33 +9,35 @@
 <body>
     <header>ZephyrJS Documentation</header>
     <article>
+        <br>
         <h1>How to Read the Documentation</h1>
-        <p>Zephyr is designed to extend the functionality of <span id="compatibility" class="nightly">PixiJS</span>,
-            rather
-            than wrapping it so that you can always use Pixi without Zephyr.</p>
-        <p>The <span class="return">Return</span> line below the function indicates the object type that is returned.
+        <p><span  class="warning">WARNINGS</span> are just general knowledge to be aware of when using a particular feature.</p>
+        <p>Lines color coded as <span class="return">RETURN</span> below the function indicates the object type that is returned.
         </p>
-        <p>The <span class="nightly">Nightly</span> features can only be found in the current nightly version of Zephyr.
+        <p>Lines coded as <span class="nightly">NIGHTLY</span> can only be found in the current nightly version of Zephyr.
             Consider trying it out, and letting us know of any bugs you find!</p>
-        <p>The <span class="deprecated">Deprecated</span> features are set to be removed in the next stable release.</p>
-        <br>
+        <p><span class="deprecated">DEPRECATED</span> lines specify features are set to be removed in the next stable release.</p>
         <h2>PIXI.Zephyr</h2>
         <dl>
             <dt>PIXI.Zephyr.useKeys()</dt>
+            <dd><em>Enables <a href="#PIXI.Keys">PIXI.Keys</a></em></dd>
             <dd>Sets up the key tracking system for use</dd>
             <dt>PIXI.Zephyr.useMouse()</dt>
+            <dd><em>Enables <a href="#PIXI.Mouse">PIXI.Mouse</a></em></dd>
             <dd>Sets up the mouse tracking system for use</dd>
             <dd><span class="warning">NOTE</span>: Please make sure you call PIXI.Mouse.setContainer() with an appended
                 element afterward!</dd>
             <dt>PIXI.Zephyr.useAudio()</dt>
+            <dd><em>Enables <a href="#PIXI.Audio">PIXI.Audio</a></em></dd>
             <dd>Sets up the WebAudio API for Pixi-style usage</dd>
             <dt>PIXI.Zephyr.useFile()</dt>
+            <dd><em>Enables <a href="#PIXI.File">PIXI.File</a></em></dd>
             <dd>Sets up the File reading/writing system</dd>
-            <dt class="nightly">PIXI.Zephyr.useParticles()</dt>
+            <dt>PIXI.Zephyr.useParticles()</dt>
+            <dd><em>Enables <a href="#PIXI.Particles">PIXI.Particles</a></em></dd>
             <dd>Sets up the Particle Emitter backend for Pixi-Style usage</dd>
         </dl>
-        <br>
-        <h2>PIXI.Keys</h2>
+        <h2 id="PIXI.Keys">PIXI.Keys</h2>
         <p>keyName is a string that is returned by keyboardEvent.code. Check out the <a
                 href="https://zephyrjs.netlify.app/keyname">Key Namer</a> to get specific key names.</p>
         <dl>
@@ -47,7 +49,6 @@ <h2>PIXI.Keys</h2>
             </dd>
             <dd class="return">Boolean</dd>
         </dl>
-        <br>
         <h2 id="PIXI.Mouse">PIXI.Mouse</h2>
         <p>For button-related functions, the button names are 'Primary', 'Middle', and 'Secondary'</p>
         <dl>
@@ -74,38 +75,36 @@ <h2 id="PIXI.Mouse">PIXI.Mouse</h2>
             <dd>The last seen mouse Y coordinate, scaled to the mouseContainer vertically from top to bottom.</dd>
             <dd class="return">Number</dd>
         </dl>
-        <br>
-        <h2>PIXI.Audio</h2>
+        <h2 id="PIXI.Audio">PIXI.Audio</h2>
         <dl>
             <dt>PIXI.Audio.from(src)</dt>
             <dd>Returns a "Pixi Audio" object. These can have .play() called on them to play their sound.</dd>
             <dd class="return">Pixi Audio object</dd>
         </dl>
-        <br>
-        <h2>PIXI.File</h2>
+        <h2 id="PIXI.File">PIXI.File</h2>
         <dl>
             <dt>PIXI.File.write(object, fileName)</dt>
             <dd>Converts the passed object into JSON and prompting the user to download the resulting fileName.json</dd>
             <dt>PIXI.File.open()</dt>
             <dd>Prompts the user to select a file, which it then attempts to parse as JSON and return</dd>
             <dd class="return">Object</dd>
         </dl>
-        <br>
-        <h2 class="nightly">PIXI.Particles</h2>
+        <h2 id="PIXI.Particles">PIXI.Particles</h2>
         <dl>
-            <dt>PIXI.Particles.from(src, maxParticleCount)</dt>
+            <dt>PIXI.Particles.from(src, maxParticleCount<em>, optionObject</em>)</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>An object can optionally be passed in to specify life, speed, direction, and spread, where the attributes are the associated values, for example, {life: 30, speed: 0.5, direction: Math.PI, Math.PI * 0.5}.</dd>
             <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>.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>
         <h2>PIXI.collision</h2>
         <dl>
             <dt>PIXI.collision.aabb(Sprite, Sprite)</dt>
@@ -121,13 +120,11 @@ <h2>PIXI.collision</h2>
             </dd>
             <dd class="return">Boolean</dd>
         </dl>
-        <br>
         <h2>PIXI.utils</h2>
         <dl>
             <dt>PIXI.utils.requestFullScreen(domElement)</dt>
-            <dd>The element passed in (typically use the Application view) will attempt to go fullscreen</dd>
+            <dd>The element passed in (typically the Application view) will attempt to go fullscreen</dd>
         </dl>
-        <br>
         <h2>Added Functions</h2>
         <dl>
             <dt>PIXI.clamp(x, min, max)</dt>
diff --git a/index.html b/index.html
@@ -45,7 +45,6 @@ <h2>Why Zephyr?</h2>
             Simply call Zephyr's methods in your javascript to add webgl audio, mouse and keyboard control, and file io,
             and every piece you need is at your fingertips.</p>
 
-        <br>
         <h2 id="getting-started">Getting Started</h2>
         <p>The <a href="https://pixijs.io/guides/basics/getting-started.html" class="pixi">PixiJS Getting Started</a>
             guide is very good, there's really nothing to expand upon in it.</p>
@@ -65,7 +64,6 @@ <h2 id="getting-started">Getting Started</h2>
             Feel free to download the <a
                 href="https://github.com/ZephyrJS-Project/ZephyrJS/raw/main/quickstart/bundle.zip">quickstart bundle</a>
             if you'd like!</p>
-        <br>
         <h2>Looking to Help?</h2>
         <p>If you'd like to help out, there's a few ways that you can!</p>
         <dl>
diff --git a/keyName.html b/keyName.html
@@ -1 +1,29 @@
-<!DOCTYPE html><html lang="en"><head><title>ZephyrJS | Home</title><link rel="stylesheet" href="style.css"><style>input{display:block;margin:auto;line-height:64px;font-size:24px;color:#000;text-align: center}</style></head><body onkeydown="keyCodeGetter(event)"><input id="input" type="text" value="Type Here"><script>let input = document.getElementById("input");function keyCodeGetter(e) {input.value = e.code}</script></body></html>
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <title>ZephyrJS | Home</title>
+    <link rel="stylesheet" href="style.css">
+    <style>
+        input {
+            display: block;
+            margin: auto;
+            line-height: 64px;
+            font-size: 24px;
+            color: #000;
+            text-align: center
+        }
+    </style>
+</head>
+
+<body onkeydown="keyCodeGetter(event)"><input id="input" type="text" value="Type Here">
+    <script>
+        let input = document.getElementById("input");
+        function keyCodeGetter(e) {
+            e.preventDefault();
+            input.value = e.code
+        }
+    </script>
+</body>
+
+</html>
diff --git a/nightly/pixi.js b/nightly/pixi.js
diff --git a/nightly/pixi.min.js.map b/nightly/pixi.min.js.map
diff --git a/nightly/zephyr.js b/nightly/zephyr.js
@@ -7,8 +7,8 @@ PIXI.Particles = {};
 // ZEPHYR FUNCTIONALITY //
 
 PIXI.Zephyr = {
-    version: "ZephyrJS 23.1.31",
-    compatible: "PixiJS v7.1.1",
+    version: "ZephyrJS 23.2",
+    compatible: "PixiJS v7.1.2",
     _spriteFix: (s) => { // Returns the actual x/y width/height of a scaled and anchored Sprite
         let w = s.width * (s.scale ? s.scale.x : 1);
         let h = s.height * (s.scale ? s.scale.y : 1);
diff --git a/style.css b/style.css
@@ -27,8 +27,8 @@ html {
     font-family: Helvetica;
 }
 
-body {
-    padding-top: 48px;
+h1,h2 {
+    padding-top: 64px;
 }
 
 * {
@@ -146,7 +146,7 @@ a.button.pixi:hover {
 }
 
 article {
-    padding: 64px 0;
+    padding-bottom: 64px;
     width: calc(100% - 128px);
     max-width: 1600px;
     margin: 0 auto;

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ html {`
`27`	`27`	`font-family: Helvetica;`
`28`	`28`	`}`
`29`	`29`
`30`		`-body {`
`31`		`- padding-top: 48px;`
	`30`	`+h1,h2 {`
	`31`	`+ padding-top: 64px;`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`* {`
`@@ -146,7 +146,7 @@ a.button.pixi:hover {`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`article {`
`149`		`- padding: 64px 0;`
	`149`	`+ padding-bottom: 64px;`
`150`	`150`	`width: calc(100% - 128px);`
`151`	`151`	`max-width: 1600px;`
`152`	`152`	`margin: 0 auto;`