Permalink
Browse files

Documentation changes for UI module

  • Loading branch information...
1 parent 36b5fec commit a8f070bb260828e85738ff05226d62fb3eac8784 @izb committed Jun 6, 2013
Showing with 26,992 additions and 26,716 deletions.
  1. +136 −155 dist/doc/8way.Face8Way.html
  2. +1 −1 dist/doc/8way.html
  3. +136 −162 dist/doc/animate.Animate.html
  4. +1 −1 dist/doc/animate.html
  5. +136 −154 dist/doc/apply-velocity.ApplyVelocity.html
  6. +1 −1 dist/doc/apply-velocity.html
  7. +360 −364 dist/doc/bitmap.html
  8. +136 −150 dist/doc/bounce.Bounce.html
  9. +1 −1 dist/doc/bounce.html
  10. +136 −0 dist/doc/button.Button.html
  11. +115 −0 dist/doc/button.html
  12. +432 −450 dist/doc/circle-trace.CircleTrace.html
  13. +1 −1 dist/doc/circle-trace.html
  14. +1 −1 dist/doc/clock.html
  15. +716 −728 dist/doc/composite.Composite.html
  16. +1 −1 dist/doc/composite.html
  17. +136 −179 dist/doc/flock.Flock.html
  18. +1 −1 dist/doc/flock.html
  19. +136 −143 dist/doc/follow-mouse.FollowMouse.html
  20. +1 −1 dist/doc/follow-mouse.html
  21. +337 −343 dist/doc/frame-phaser.FramePhaser.html
  22. +1 −1 dist/doc/frame-phaser.html
  23. +527 −538 dist/doc/ground-sprites.GroundSprites.html
  24. +1 −1 dist/doc/ground-sprites.html
  25. +1 −1 dist/doc/index.html
  26. +545 −546 dist/doc/js.html
  27. +447 −450 dist/doc/keyboard.Keyboard.html
  28. +1 −1 dist/doc/keyboard.html
  29. +432 −445 dist/doc/line-trace.LineTrace.html
  30. +1 −1 dist/doc/line-trace.html
  31. +570 −577 dist/doc/minheap.MinHeap.html
  32. +1 −1 dist/doc/minheap.html
  33. +6,206 −6,183 dist/doc/module-snaps.Snaps.html
  34. +1 −1 dist/doc/module-snaps.html
  35. +278 −281 dist/doc/mouse.Mouse.html
  36. +1 −1 dist/doc/mouse.html
  37. +136 −137 dist/doc/occlusion-scanner.OcclusionScanner.html
  38. +1 −1 dist/doc/occlusion-scanner.html
  39. +320 −0 dist/doc/panel.Panel.html
  40. +115 −0 dist/doc/panel.html
  41. +184 −228 dist/doc/particles.Particles.html
  42. +1 −1 dist/doc/particles.html
  43. +961 −993 dist/doc/pathfinder.PathFinder.html
  44. +1 −1 dist/doc/pathfinder.html
  45. +472 −478 dist/doc/preload.Preloader.html
  46. +1 −1 dist/doc/preload.html
  47. +704 −734 dist/doc/proximity-tracker.ProximityTracker.html
  48. +1 −1 dist/doc/proximity-tracker.html
  49. +245 −250 dist/doc/push-cam.PushCam.html
  50. +1 −1 dist/doc/push-cam.html
  51. +654 −680 dist/doc/rnd.html
  52. +518 −545 dist/doc/slowqueue.SlowQueue.html
  53. +1 −1 dist/doc/slowqueue.html
  54. +2,118 −2,191 dist/doc/sprite.Sprite.html
  55. +1 −1 dist/doc/sprite.html
  56. +2,667 −2,707 dist/doc/staggered-isometric.StaggeredIsometric.html
  57. +1 −1 dist/doc/staggered-isometric.html
  58. +318 −318 dist/doc/stats.Stats.html
  59. +1 −1 dist/doc/stats.html
  60. +865 −870 dist/doc/tile.Tile.html
  61. +1 −1 dist/doc/tile.html
  62. +337 −348 dist/doc/time-phaser.TimePhaser.html
  63. +1 −1 dist/doc/time-phaser.html
  64. +136 −183 dist/doc/track.Track.html
  65. +1 −1 dist/doc/track.html
  66. +3,478 −3,513 dist/doc/tween.html
  67. +207 −212 dist/doc/ui.UI.html
  68. +1 −1 dist/doc/ui.html
  69. +1 −1 dist/doc/uid.html
  70. +1 −1 dist/doc/url.html
  71. +555 −397 dist/snaps.js
  72. +52 −51 dist/snaps.min.js
View
@@ -1,155 +1,136 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Class: Face8Way</title>
-
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div class="topdiv">
- <nav>
- <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="occlusion-scanner.html">ai/occlusion-scanner</a></li><li><a href="pathfinder.html">ai/pathfinder</a></li><li><a href="proximity-tracker.html">ai/proximity-tracker</a></li><li><a href="tween.html">animate/tween</a></li><li><a href="keyboard.html">input/keyboard</a></li><li><a href="mouse.html">input/mouse</a></li><li><a href="staggered-isometric.html">map/staggered-isometric</a></li><li><a href="tile.html">map/tile</a></li><li><a href="push-cam.html">plugins/ai/camera/push-cam</a></li><li><a href="frame-phaser.html">plugins/ai/phasers/frame-phaser</a></li><li><a href="time-phaser.html">plugins/ai/phasers/time-phaser</a></li><li><a href="circle-trace.html">plugins/collision/sprite-with-map/circle-trace</a></li><li><a href="line-trace.html">plugins/collision/sprite-with-map/line-trace</a></li><li><a href="particles.html">plugins/fx/particles</a></li><li><a href="ground-sprites.html">plugins/layer/ground-sprites</a></li><li><a href="ui.html">plugins/layer/ui</a></li><li><a href="8way.html">plugins/sprite/8way</a></li><li><a href="animate.html">plugins/sprite/animate</a></li><li><a href="apply-velocity.html">plugins/sprite/apply-velocity</a></li><li><a href="bounce.html">plugins/sprite/bounce</a></li><li><a href="flock.html">plugins/sprite/flock</a></li><li><a href="follow-mouse.html">plugins/sprite/follow-mouse</a></li><li><a href="track.html">plugins/sprite/track</a></li><li><a href="module-snaps.html">snaps</a></li><li><a href="composite.html">sprites/composite</a></li><li><a href="sprite.html">sprites/sprite</a></li><li><a href="bitmap.html">util/bitmap</a></li><li><a href="clock.html">util/clock</a></li><li><a href="js.html">util/js</a></li><li><a href="minheap.html">util/minheap</a></li><li><a href="preload.html">util/preload</a></li><li><a href="rnd.html">util/rnd</a></li><li><a href="slowqueue.html">util/slowqueue</a></li><li><a href="stats.html">util/stats</a></li><li><a href="uid.html">util/uid</a></li><li><a href="url.html">util/url</a></li></ul><h3>Classes</h3><ul><li><a href="occlusion-scanner.OcclusionScanner.html">OcclusionScanner</a></li><li><a href="pathfinder.PathFinder.html">PathFinder</a></li><li><a href="proximity-tracker.ProximityTracker.html">ProximityTracker</a></li><li><a href="keyboard.Keyboard.html">Keyboard</a></li><li><a href="mouse.Mouse.html">Mouse</a></li><li><a href="staggered-isometric.StaggeredIsometric.html">StaggeredIsometric</a></li><li><a href="tile.Tile.html">Tile</a></li><li><a href="push-cam.PushCam.html">PushCam</a></li><li><a href="frame-phaser.FramePhaser.html">FramePhaser</a></li><li><a href="time-phaser.TimePhaser.html">TimePhaser</a></li><li><a href="circle-trace.CircleTrace.html">CircleTrace</a></li><li><a href="line-trace.LineTrace.html">LineTrace</a></li><li><a href="particles.Particles.html">Particles</a></li><li><a href="ground-sprites.GroundSprites.html">GroundSprites</a></li><li><a href="ui.UI.html">UI</a></li><li><a href="8way.Face8Way.html">Face8Way</a></li><li><a href="animate.Animate.html">Animate</a></li><li><a href="apply-velocity.ApplyVelocity.html">ApplyVelocity</a></li><li><a href="bounce.Bounce.html">Bounce</a></li><li><a href="flock.Flock.html">Flock</a></li><li><a href="follow-mouse.FollowMouse.html">FollowMouse</a></li><li><a href="track.Track.html">Track</a></li><li><a href="module-snaps.Snaps.html">Snaps</a></li><li><a href="composite.Composite.html">Composite</a></li><li><a href="sprite.Sprite.html">Sprite</a></li><li><a href="minheap.MinHeap.html">MinHeap</a></li><li><a href="preload.Preloader.html">Preloader</a></li><li><a href="slowqueue.SlowQueue.html">SlowQueue</a></li><li><a href="stats.Stats.html">Stats</a></li></ul>
- </nav><div id="main">
-
- <h1 class="page-title">Class: Face8Way</h1>
-
-
-
-
-
-<section>
-
-<header>
- <h2>
- <span class="ancestors"><a href="8way.html">plugins/sprite/8way</a>.</span>
-
- Face8Way
- </h2>
-
-</header>
-
-<article>
- <div class="container-overview">
-
-
-
-
-<dt>
- <h4 class="name" id="Face8Way"><span class="type-signature"></span>new Face8Way<span class="signature">()</span><span class="type-signature"></span></h4>
-
-
-</dt>
-<dd>
-
-
- <div class="description">
- A sprite updater that sets the sprite's state extension to a compass direction
-('n', 'ne', 'e', 'se'...)
-based on the direction values in the sprite. Direction updates automatically when the sprite
-moves but can be overridden with <a href="sprite.Sprite.html#setDirection"><code>setDirection</code></a>.
-The compass direction takes into account the isometric projection.
-<p>
-Note that this should not be constructed directly, but rather via the updates or commit
-property in your spawnSprite data, e.g. <code>updates:[{name:'8way'}]</code>.
-<p>
-See The <code>opts<code> parameter in the <a href="sprite.Sprite.html"><code>Sprite constructor</code></a>
-<p>
-Alongside the name, you can pass the following options
-<dl>
- <dt>anti_jitter</dt><dd>Creates a buffer between direction changes. Waits a certain number
- of frames before changing the direction. The direction only changes if the new direction
- is not the current direction for a set number of frames. Defaults to 0.</dd>
- <dt>bounce_base</dt><dd>Where is the 'floor'? E.g. a bounce_base of 25 and an bounce height
- of 100 will bounce up 100px on top of the floor level of 25. The height value will
- be 125 at its apex, midway through the state animation.</dd>
-</dl>
- </div>
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</dl>
-
-
-
-
-
-
-
-
-
-</dd>
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</article>
-
-</section>
-
-
-
-
- </div>
-</div>
-
-<br clear="both">
-
-<script> prettyPrint(); </script>
-</body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>JSDoc: Class: Face8Way</title>
+
+ <script src="scripts/prettify/prettify.js"> </script>
+ <script src="scripts/prettify/lang-css.js"> </script>
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div class="topdiv">
+ <nav>
+ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="occlusion-scanner.html">ai/occlusion-scanner</a></li><li><a href="pathfinder.html">ai/pathfinder</a></li><li><a href="proximity-tracker.html">ai/proximity-tracker</a></li><li><a href="tween.html">animate/tween</a></li><li><a href="keyboard.html">input/keyboard</a></li><li><a href="mouse.html">input/mouse</a></li><li><a href="button.html">input/ui/button</a></li><li><a href="panel.html">input/ui/panel</a></li><li><a href="staggered-isometric.html">map/staggered-isometric</a></li><li><a href="tile.html">map/tile</a></li><li><a href="push-cam.html">plugins/ai/camera/push-cam</a></li><li><a href="frame-phaser.html">plugins/ai/phasers/frame-phaser</a></li><li><a href="time-phaser.html">plugins/ai/phasers/time-phaser</a></li><li><a href="circle-trace.html">plugins/collision/sprite-with-map/circle-trace</a></li><li><a href="line-trace.html">plugins/collision/sprite-with-map/line-trace</a></li><li><a href="particles.html">plugins/fx/particles</a></li><li><a href="ground-sprites.html">plugins/layer/ground-sprites</a></li><li><a href="ui.html">plugins/layer/ui</a></li><li><a href="8way.html">plugins/sprite/8way</a></li><li><a href="animate.html">plugins/sprite/animate</a></li><li><a href="apply-velocity.html">plugins/sprite/apply-velocity</a></li><li><a href="bounce.html">plugins/sprite/bounce</a></li><li><a href="flock.html">plugins/sprite/flock</a></li><li><a href="follow-mouse.html">plugins/sprite/follow-mouse</a></li><li><a href="track.html">plugins/sprite/track</a></li><li><a href="module-snaps.html">snaps</a></li><li><a href="composite.html">sprites/composite</a></li><li><a href="sprite.html">sprites/sprite</a></li><li><a href="bitmap.html">util/bitmap</a></li><li><a href="clock.html">util/clock</a></li><li><a href="js.html">util/js</a></li><li><a href="minheap.html">util/minheap</a></li><li><a href="preload.html">util/preload</a></li><li><a href="rnd.html">util/rnd</a></li><li><a href="slowqueue.html">util/slowqueue</a></li><li><a href="stats.html">util/stats</a></li><li><a href="uid.html">util/uid</a></li><li><a href="url.html">util/url</a></li></ul><h3>Classes</h3><ul><li><a href="occlusion-scanner.OcclusionScanner.html">OcclusionScanner</a></li><li><a href="pathfinder.PathFinder.html">PathFinder</a></li><li><a href="proximity-tracker.ProximityTracker.html">ProximityTracker</a></li><li><a href="keyboard.Keyboard.html">Keyboard</a></li><li><a href="mouse.Mouse.html">Mouse</a></li><li><a href="button.Button.html">Button</a></li><li><a href="panel.Panel.html">Panel</a></li><li><a href="staggered-isometric.StaggeredIsometric.html">StaggeredIsometric</a></li><li><a href="tile.Tile.html">Tile</a></li><li><a href="push-cam.PushCam.html">PushCam</a></li><li><a href="frame-phaser.FramePhaser.html">FramePhaser</a></li><li><a href="time-phaser.TimePhaser.html">TimePhaser</a></li><li><a href="circle-trace.CircleTrace.html">CircleTrace</a></li><li><a href="line-trace.LineTrace.html">LineTrace</a></li><li><a href="particles.Particles.html">Particles</a></li><li><a href="ground-sprites.GroundSprites.html">GroundSprites</a></li><li><a href="ui.UI.html">UI</a></li><li><a href="8way.Face8Way.html">Face8Way</a></li><li><a href="animate.Animate.html">Animate</a></li><li><a href="apply-velocity.ApplyVelocity.html">ApplyVelocity</a></li><li><a href="bounce.Bounce.html">Bounce</a></li><li><a href="flock.Flock.html">Flock</a></li><li><a href="follow-mouse.FollowMouse.html">FollowMouse</a></li><li><a href="track.Track.html">Track</a></li><li><a href="module-snaps.Snaps.html">Snaps</a></li><li><a href="composite.Composite.html">Composite</a></li><li><a href="sprite.Sprite.html">Sprite</a></li><li><a href="minheap.MinHeap.html">MinHeap</a></li><li><a href="preload.Preloader.html">Preloader</a></li><li><a href="slowqueue.SlowQueue.html">SlowQueue</a></li><li><a href="stats.Stats.html">Stats</a></li></ul>
+ </nav><div id="main">
+
+ <h1 class="page-title">Class: Face8Way</h1>
+
+
+
+
+
+<section>
+
+<header>
+ <h2>
+ <span class="ancestors"><a href="8way.html">plugins/sprite/8way</a>.</span>
+
+ Face8Way
+ </h2>
+
+</header>
+
+<article>
+ <div class="container-overview">
+
+
+
+
+<dt>
+ <h4 class="name" id="Face8Way"><span class="type-signature"></span>new Face8Way<span class="signature">()</span><span class="type-signature"></span></h4>
+
+
+</dt>
+<dd>
+
+
+ <div class="description">
+ A sprite updater that sets the sprite's state extension to a compass direction('n', 'ne', 'e', 'se'...)based on the direction values in the sprite. Direction updates automatically when the spritemoves but can be overridden with <a href="sprite.Sprite.html#setDirection"><code>setDirection</code></a>.The compass direction takes into account the isometric projection.<p>Note that this should not be constructed directly, but rather via the updates or commitproperty in your spawnSprite data, e.g. <code>updates:[{name:'8way'}]</code>.<p>See The <code>opts<code> parameter in the <a href="sprite.Sprite.html"><code>Sprite constructor</code></a><p>Alongside the name, you can pass the following options<dl> <dt>anti_jitter</dt><dd>Creates a buffer between direction changes. Waits a certain number of frames before changing the direction. The direction only changes if the new direction is not the current direction for a set number of frames. Defaults to 0.</dd> <dt>bounce_base</dt><dd>Where is the 'floor'? E.g. a bounce_base of 25 and an bounce height of 100 will bounce up 100px on top of the floor level of 25. The height value will be 125 at its apex, midway through the state animation.</dd></dl>
+ </div>
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+</dd>
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+ </div>
+</div>
+
+<br clear="both">
+
+<script> prettyPrint(); </script>
+</body>
+</html>
Oops, something went wrong.

0 comments on commit a8f070b

Please sign in to comment.