-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
39 changed files
with
27,042 additions
and
26,215 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,136 +1,155 @@ | ||
| <!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> | ||
| <!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 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> |
Oops, something went wrong.