MD Push

Author: OttCS

README.md

@@ -21,8 +21,8 @@
  code is below:</p> <code>&lt;head&gt;<br>&lt;script src="https://zephyrjs.netlify.app/stable/pixi.js"&gt;&lt;/script&gt;<br><span class="zephyr">&lt;script src="https://zephyrjs.netlify.app/stable/zephyr.js"&gt;&lt;/script&gt;</span><br>&lt;/head&gt;</code> <p>If you'd like to test out the nightly version, awesome! Thanks for helping out with development, and <a
  href="https://github.com/ZephyrJS-Project/ZephyrJS/issues">issue</a> reports are super helpful. Just
  replace where it says <code>stable</code> above with <code>nightly</code> and you're good to go!</p> <p>When you're wanting to use one of Zephyr's features, you can call the <strong>Zephyr.use______()</strong>
- methods! The options
+ methods. The options
  are listed at the top of the <a href="documentation/">documentation</a>. After that, you're ready to go!
  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> </article> 
+ 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> <dt>Bug Reports/Feature Requests</dt> <dd>If you'd like to directly influence where I'll be focusing my efforts, <a href="https://github.com/ZephyrJS-Project/ZephyrJS/issues">submit an issue on Github</a>! It'll get added to the <a href="https://github.com/orgs/ZephyrJS-Project/projects/1">project board</a>, and you can track the progress there!</dd> <dt>Usage Poll</dt> <dd>For broader information, you can fill out <a href="https://forms.gle/hfR5pmJY9g51RPRL8">the usage poll</a>. It just has some general questions about PixiJS and should only take a couple minutes to fill out, but it is very useful.</dd> <dt>Contribute Directly</dt> <dd>Code is always welcome, just I'd appreciate some communication beforehand, or VERY well documented code.</dd> <dd>I'm also looking for someone who is experienced with creating/maintaining NPM packages to extend Zephyr's reach!</dd> </dl> </article> 

documentation/README.md

@@ -12,11 +12,21 @@
  As of version 23.1, calling this method with an unappended element will fail with a console error about
  using an "invalid element".</dd> <dt>PIXI.Mouse.down([mouse button])</dt> <dd>Returns true if the button is actively pressed down.</dd> <dd class="return">Boolean</dd> <dt>PIXI.Mouse.fired(mouseEvent.button)</dt> <dd>Returns true if this is the first time the button value has been accessed since the button has been
  pressed.
- </dd> <dd class="return">Boolean</dd> <dt>PIXI.Mouse.x</dt> <dd>The last seen mouse X coordinate, scaled to the mouseContainer horizontally from left to right.</dd> <dd class="return">Number</dd> <dt>PIXI.Mouse.y</dt> <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> <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> <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>PIXI.collision</h2> <dl> <dt>PIXI.collision.aabb(Sprite, Sprite)</dt> <dd>Checks if the two provided Sprites are colliding with the aabb algorithm - NOTE: Both a and b are
+ </dd> <dd class="return">Boolean</dd> <dt>PIXI.Mouse.x</dt> <dd>The last seen mouse X coordinate, scaled to the mouseContainer horizontally from left to right.</dd> <dd class="return">Number</dd> <dt>PIXI.Mouse.y</dt> <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> <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> <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>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> </dl> <br> <h2>PIXI.collision</h2> <dl> <dt>PIXI.collision.aabb(Sprite, Sprite)</dt> <dd>Checks if the two provided Sprites are colliding with the aabb algorithm - NOTE: Both a and b are
  formatted
  as javascript objects with x, y, width, and height, and optionally anchor positions.</dd> <dd class="return">Boolean</dd> <dt>PIXI.collision.radius(Sprite, Sprite)</dt> <dd>Checks if the two provided Sprites are colliding with the standard point-radius method of circle
  collision -
  NOTE: Both a and b are formatted as javascript objects with x, y, and r, and optionally anchor
  positions.
- </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> </dl> <h2>Added Functions</h2> <dl> <dt>PIXI.clamp(x, min, max)</dt> <dd>Returns the value of x if it is between the bounds of min and max, or the closest bound if x is outside
+ </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> </dl> <br> <h2>Added Functions</h2> <dl> <dt>PIXI.clamp(x, min, max)</dt> <dd>Returns the value of x if it is between the bounds of min and max, or the closest bound if x is outside
  </dd> <dd class="return">Number</dd> <dt>PIXI.mix(a, b, m)</dt> <dd>Linearly interpolate between values a and b</dd> <dd class="return">Number</dd> <dt>PIXI.rand(min, max)</dt> <dd>Generates a random integer between min and max, inclusive</dd> <dd class="return">Number</dd> </dl> </article>