Permalink
Browse files

Documentation tweaks

  • Loading branch information...
1 parent 9817dea commit 729c44d026de720d7b8a0a708e9001067163025e @izb committed May 8, 2013
Showing with 661 additions and 550 deletions.
  1. +9 −7 dist/doc/8way.Face8Way.html
  2. +7 −7 dist/doc/8way.html
  3. +9 −7 dist/doc/animate.Animate.html
  4. +7 −7 dist/doc/animate.html
  5. +9 −7 dist/doc/apply-velocity.ApplyVelocity.html
  6. +7 −7 dist/doc/apply-velocity.html
  7. +7 −7 dist/doc/bitmap.html
  8. +9 −7 dist/doc/bounce.Bounce.html
  9. +7 −7 dist/doc/bounce.html
  10. +8 −8 dist/doc/circle-trace.CircleTrace.html
  11. +7 −7 dist/doc/circle-trace.html
  12. +7 −7 dist/doc/composite.Composite.html
  13. +7 −7 dist/doc/composite.html
  14. +9 −7 dist/doc/flock.Flock.html
  15. +7 −7 dist/doc/flock.html
  16. +9 −7 dist/doc/follow-mouse.FollowMouse.html
  17. +7 −7 dist/doc/follow-mouse.html
  18. +8 −8 dist/doc/frame-phaser.FramePhaser.html
  19. +7 −7 dist/doc/frame-phaser.html
  20. +8 −8 dist/doc/ground-sprites.GroundSprites.html
  21. +7 −7 dist/doc/ground-sprites.html
  22. +7 −7 dist/doc/index.html
  23. +7 −7 dist/doc/js.html
  24. +7 −7 dist/doc/keyboard.Keyboard.html
  25. +7 −7 dist/doc/keyboard.html
  26. +8 −8 dist/doc/line-trace.LineTrace.html
  27. +7 −7 dist/doc/line-trace.html
  28. +7 −7 dist/doc/minheap.MinHeap.html
  29. +7 −7 dist/doc/minheap.html
  30. +7 −7 dist/doc/module-snaps.Snaps.html
  31. +7 −7 dist/doc/module-snaps.html
  32. +7 −7 dist/doc/mouse.Mouse.html
  33. +7 −7 dist/doc/mouse.html
  34. +7 −7 dist/doc/occlusion-scanner.OcclusionScanner.html
  35. +7 −7 dist/doc/occlusion-scanner.html
  36. +8 −8 dist/doc/particles.Particles.html
  37. +7 −7 dist/doc/particles.html
  38. +9 −9 dist/doc/pathfinder.PathFinder.html
  39. +7 −7 dist/doc/pathfinder.html
  40. +7 −7 dist/doc/preload.Preloader.html
  41. +7 −7 dist/doc/preload.html
  42. +9 −9 dist/doc/proximity-tracker.ProximityTracker.html
  43. +7 −7 dist/doc/proximity-tracker.html
  44. +8 −8 dist/doc/push-cam.PushCam.html
  45. +7 −7 dist/doc/push-cam.html
  46. +7 −7 dist/doc/rnd.html
  47. +7 −7 dist/doc/sprite.Sprite.html
  48. +7 −7 dist/doc/sprite.html
  49. +7 −7 dist/doc/staggered-isometric.StaggeredIsometric.html
  50. +7 −7 dist/doc/staggered-isometric.html
  51. +7 −7 dist/doc/stats.Stats.html
  52. +7 −7 dist/doc/stats.html
  53. +9 −6 dist/doc/styles/jsdoc-default.css
  54. +57 −8 dist/doc/tile.Tile.html
  55. +7 −7 dist/doc/tile.html
  56. +8 −8 dist/doc/time-phaser.TimePhaser.html
  57. +7 −7 dist/doc/time-phaser.html
  58. +9 −7 dist/doc/track.Track.html
  59. +7 −7 dist/doc/track.html
  60. +7 −7 dist/doc/tween.html
  61. +8 −8 dist/doc/ui.UI.html
  62. +7 −7 dist/doc/ui.html
  63. +7 −7 dist/doc/uid.html
  64. +7 −7 dist/doc/url.html
  65. +36 −15 dist/snaps.js
  66. +47 −47 dist/snaps.min.js
  67. +9 −6 doc_template/static/styles/jsdoc-default.css
  68. +7 −7 doc_template/tmpl/layout.tmpl
  69. +2 −2 src/ai/pathfinder.js
  70. +2 −2 src/ai/proximity-tracker.js
  71. +10 −3 src/map/tile.js
  72. +1 −1 src/plugins/ai/phasers/frame-phaser.js
  73. +1 −1 src/plugins/ai/phasers/time-phaser.js
  74. +1 −1 src/plugins/camera/push-cam.js
  75. +1 −1 src/plugins/collision/sprite-with-map/circle-trace.js
  76. +1 −1 src/plugins/collision/sprite-with-map/line-trace.js
  77. +1 −1 src/plugins/fx/particles.js
  78. +1 −1 src/plugins/layer/ground-sprites.js
  79. +1 −1 src/plugins/layer/ui.js
  80. +2 −0 src/plugins/sprite/8way.js
  81. +2 −0 src/plugins/sprite/animate.js
  82. +2 −0 src/plugins/sprite/apply-velocity.js
  83. +2 −0 src/plugins/sprite/bounce.js
  84. +2 −0 src/plugins/sprite/flock.js
  85. +2 −0 src/plugins/sprite/follow-mouse.js
  86. +2 −0 src/plugins/sprite/track.js
@@ -15,11 +15,14 @@
<body>
-<div id="main">
+<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="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="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="stats.Stats.html">Stats</a></li></ul>
+ </nav><div id="main">
- <h1 class="page-title">Class: Face8Way</h1>
+ <h1 class="page-title">Class: Face8Way</h1>
-
+
@@ -58,6 +61,8 @@ <h4 class="name" id="Face8Way"><span class="type-signature"></span>new Face8Way<
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>
This plugin takes no options.
</div>
@@ -132,12 +137,9 @@ <h4 class="name" id="Face8Way"><span class="type-signature"></span>new Face8Way<
+ </div>
</div>
-<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="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="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="stats.Stats.html">Stats</a></li></ul>
-</nav>
-
<br clear="both">
<script> prettyPrint(); </script>
View
@@ -15,11 +15,14 @@
<body>
-<div id="main">
+<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="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="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="stats.Stats.html">Stats</a></li></ul>
+ </nav><div id="main">
- <h1 class="page-title">Module: plugins/sprite/8way</h1>
+ <h1 class="page-title">Module: plugins/sprite/8way</h1>
-
+
@@ -102,12 +105,9 @@ <h3 class="subsection-title">Classes</h3>
+ </div>
</div>
-<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="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="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="stats.Stats.html">Stats</a></li></ul>
-</nav>
-
<br clear="both">
<script> prettyPrint(); </script>
Oops, something went wrong.

0 comments on commit 729c44d

Please sign in to comment.