Skip to content

Commit

Permalink
Changes to actual api docs on the site
Browse files Browse the repository at this point in the history
  • Loading branch information
@starwed
starwed committed May 17, 2015
1 parent 560293f commit 8b29894
Show file tree
Hide file tree
Showing 92 changed files with 2,198 additions and 6,509 deletions.
543 changes: 102 additions & 441 deletions api/2D.html
View file

Large diffs are not rendered by default.

45 changes: 12 additions & 33 deletions api/Canvas.html
View file

Large diffs are not rendered by default.

328 changes: 88 additions & 240 deletions api/Collision.html
View file

Large diffs are not rendered by default.

69 changes: 19 additions & 50 deletions api/Color.html
View file

Large diffs are not rendered by default.

582 changes: 136 additions & 446 deletions api/Crafty Core.html
View file

Large diffs are not rendered by default.

81 changes: 16 additions & 65 deletions api/Crafty-DOM.html
View file

Large diffs are not rendered by default.

173 changes: 25 additions & 148 deletions api/Crafty-DrawManager.html
View file

Large diffs are not rendered by default.

34 changes: 9 additions & 25 deletions api/Crafty-HashMap.html
View file
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Crafty - </title>
<title>Crafty - Crafty.HashMap</title>
<link type="text/css" rel="stylesheet" href="/craftyjs-site.css" />

<link href='http://fonts.googleapis.com/css?family=Arvo:regular,bold' rel='stylesheet' type='text/css'>
Expand Down Expand Up @@ -53,36 +53,20 @@
<div id="content" class="container">


<div id='api-container'>


<div id='doc-nav'><ul id='doc-level-one'><li><a href='events.html'>List of Events</a></li><li>2D<ul><li><a href='Crafty-map.html'>Crafty.map</a></li><li><a href='2D.html'>2D</a></li><li><a href='Gravity.html'>Gravity</a></li><li><a href='Crafty-polygon.html'>Crafty.polygon</a></li><li><a href='Crafty-circle.html'>Crafty.circle</a></li><li><a href='Crafty-HashMap.html'>Crafty.HashMap</a></li><li><a href='Collision.html'>Collision</a></li><li><a href='Crafty-diamondIso.html'>Crafty.diamondIso</a></li><li><a href='Crafty-isometric.html'>Crafty.isometric</a></li><li><a href='Crafty-math.html'>Crafty.math</a></li><li><a href='Crafty-math.Vector2D.html'>Crafty.math.Vector2D</a></li><li><a href='Crafty-math.Matrix2D.html'>Crafty.math.Matrix2D</a></li></ul></li><li>Graphics<ul><li><a href='DOM.html'>DOM</a></li><li><a href='Crafty-DOM.html'>Crafty.DOM</a></li><li><a href='Canvas.html'>Canvas</a></li><li><a href='Crafty-canvas.html'>Crafty.canvas</a></li><li><a href='Crafty-assignColor.html'>Crafty.assignColor</a></li><li><a href='Color.html'>Color</a></li><li><a href='Image.html'>Image</a></li><li><a href='Crafty-DrawManager.html'>Crafty.DrawManager</a></li><li><a href='Crafty-pixelart.html'>Crafty.pixelart</a></li><li><a href='Crafty-background.html'>Crafty.background</a></li><li><a href='HTML.html'>HTML</a></li><li><a href='Particles.html'>Particles</a></li><li><a href='Crafty-sprite.html'>Crafty.sprite</a></li><li><a href='Sprite.html'>Sprite</a></li><li><a href='Text.html'>Text</a></li></ul></li><li>Debug<ul><li><a href='DebugCanvas.html'>DebugCanvas</a></li><li><a href='DebugRectangle.html'>DebugRectangle</a></li><li><a href='VisibleMBR.html'>VisibleMBR</a></li><li><a href='DebugPolygon.html'>DebugPolygon</a></li><li><a href='WiredHitBox.html'>WiredHitBox</a></li><li><a href='SolidHitBox.html'>SolidHitBox</a></li></ul></li><li>Animation<ul><li><a href='Tween.html'>Tween</a></li><li><a href='SpriteAnimation.html'>SpriteAnimation</a></li></ul></li><li>Input<ul><li><a href='Crafty-keydown.html'>Crafty.keydown</a></li><li><a href='Crafty-mouseDispatch.html'>Crafty.mouseDispatch</a></li><li><a href='Crafty-touchDispatch.html'>Crafty.touchDispatch</a></li><li><a href='KeyboardEvent.html'>KeyboardEvent</a></li><li><a href='Crafty-eventObject.html'>Crafty.eventObject</a></li><li><a href='Mouse.html'>Mouse</a></li><li><a href='Draggable.html'>Draggable</a></li><li><a href='Keyboard.html'>Keyboard</a></li><li><a href='Multiway.html'>Multiway</a></li><li><a href='Fourway.html'>Fourway</a></li><li><a href='Twoway.html'>Twoway</a></li><li><a href='Crafty-keys.html'>Crafty.keys</a></li><li><a href='Crafty-mouseButtons.html'>Crafty.mouseButtons</a></li></ul></li><li>Core<ul><li><a href='Crafty.html'>Crafty</a></li><li><a href='Crafty Core.html'>Crafty Core</a></li><li><a href='Crafty-extend.html'>Crafty.extend</a></li><li><a href='Crafty-init.html'>Crafty.init</a></li><li><a href='Crafty-getVersion.html'>Crafty.getVersion</a></li><li><a href='Crafty-stop.html'>Crafty.stop</a></li><li><a href='Crafty-pause.html'>Crafty.pause</a></li><li><a href='Crafty-isPaused.html'>Crafty.isPaused</a></li><li><a href='Crafty-e.html'>Crafty.e</a></li><li><a href='Crafty-c.html'>Crafty.c</a></li><li><a href='Crafty-trigger.html'>Crafty.trigger</a></li><li><a href='Crafty-bind.html'>Crafty.bind</a></li><li><a href='Crafty-uniqueBind.html'>Crafty.uniqueBind</a></li><li><a href='Crafty-one.html'>Crafty.one</a></li><li><a href='Crafty-unbind.html'>Crafty.unbind</a></li><li><a href='Crafty-frame.html'>Crafty.frame</a></li><li><a href='Crafty-settings.html'>Crafty.settings</a></li><li><a href='Crafty-clone.html'>Crafty.clone</a></li><li><a href='Crafty-support.html'>Crafty.support</a></li><li><a href='Crafty-stage.html'>Crafty.stage</a></li></ul></li><li>Game Loop<ul><li><a href='Crafty-timer.html'>Crafty.timer</a></li></ul></li><li>Events<ul><li><a href='Crafty-trigger.html'>Crafty.trigger</a></li><li><a href='Crafty-bind.html'>Crafty.bind</a></li><li><a href='Crafty-uniqueBind.html'>Crafty.uniqueBind</a></li><li><a href='Crafty-one.html'>Crafty.one</a></li><li><a href='Crafty-unbind.html'>Crafty.unbind</a></li><li><a href='Crafty-addEvent.html'>Crafty.addEvent</a></li><li><a href='Crafty-removeEvent.html'>Crafty.removeEvent</a></li></ul></li><li>Misc<ul><li><a href='Crafty-device.html'>Crafty.device</a></li><li><a href='Crafty-support.html'>Crafty.support</a></li><li><a href='Crafty-addEvent.html'>Crafty.addEvent</a></li><li><a href='Crafty-removeEvent.html'>Crafty.removeEvent</a></li></ul></li><li>Stage<ul><li><a href='Crafty-background.html'>Crafty.background</a></li><li><a href='Crafty-scene.html'>Crafty.scene</a></li><li><a href='Crafty-viewport.html'>Crafty.viewport</a></li></ul></li><li>Assets<ul><li><a href='Crafty-assets.html'>Crafty.assets</a></li><li><a href='Crafty-paths.html'>Crafty.paths</a></li><li><a href='Crafty-asset.html'>Crafty.asset</a></li><li><a href='Crafty-image_whitelist.html'>Crafty.image_whitelist</a></li><li><a href='Crafty-loader.html'>Crafty.loader</a></li><li><a href='Crafty-removeAssets.html'>Crafty.removeAssets</a></li></ul></li><li>Model<ul><li><a href='Model.html'>Model</a></li></ul></li><li>Scenes<ul><li><a href='Crafty-scene.html'>Crafty.scene</a></li></ul></li><li>Audio<ul><li><a href='Crafty-audio.html'>Crafty.audio</a></li></ul></li><li>Utilities<ul><li><a href='Storage.html'>Storage</a></li><li><a href='Delay.html'>Delay</a></li></ul></li></ul></div>
<div id='doc-content'><h1 id="crafty-hashmap">Crafty.HashMap</h1>
<p>Broad-phase collision detection engine. See background information at</p>

<div id="docs"><div class="toc-holder" id="doc-nav"><ul id="doc-level-one"><li><a href="events.html">List of Events</a></li><li class="category">Core<ul class="category-list"><li><a href="Crafty.html">Crafty</a></li><li><a href="Crafty Core.html">Crafty Core</a></li><li><a href="Crafty-bind.html">Crafty.bind</a></li><li><a href="Crafty-c.html">Crafty.c</a></li><li><a href="Crafty-clone.html">Crafty.clone</a></li><li><a href="Crafty-e.html">Crafty.e</a></li><li><a href="Crafty-extend.html">Crafty.extend</a></li><li><a href="Crafty-frame.html">Crafty.frame</a></li><li><a href="Crafty-getVersion.html">Crafty.getVersion</a></li><li><a href="Crafty-init.html">Crafty.init</a></li><li><a href="Crafty-isPaused.html">Crafty.isPaused</a></li><li><a href="Crafty-one.html">Crafty.one</a></li><li><a href="Crafty-pause.html">Crafty.pause</a></li><li><a href="Crafty-settings.html">Crafty.settings</a></li><li><a href="Crafty-stage.html">Crafty.stage</a></li><li><a href="Crafty-stop.html">Crafty.stop</a></li><li><a href="Crafty-support.html">Crafty.support</a></li><li><a href="Crafty-trigger.html">Crafty.trigger</a></li><li><a href="Crafty-unbind.html">Crafty.unbind</a></li><li><a href="Crafty-uniqueBind.html">Crafty.uniqueBind</a></li></ul></li><li class="category">2D<ul class="category-list"><li><a href="2D.html">2D</a></li><li><a href="Collision.html">Collision</a></li><li><a href="Crafty-circle.html">Crafty.circle</a></li><li><a href="Crafty-diamondIso.html">Crafty.diamondIso</a></li><li><a href="Crafty-HashMap.html">Crafty.HashMap</a></li><li><a href="Crafty-isometric.html">Crafty.isometric</a></li><li><a href="Crafty-map.html">Crafty.map</a></li><li><a href="Crafty-math.html">Crafty.math</a></li><li><a href="Crafty-math-Matrix2D.html">Crafty.math.Matrix2D</a></li><li><a href="Crafty-math-Vector2D.html">Crafty.math.Vector2D</a></li><li><a href="Crafty-polygon.html">Crafty.polygon</a></li><li><a href="Gravity.html">Gravity</a></li></ul></li><li class="category">Animation<ul class="category-list"><li><a href="SpriteAnimation.html">SpriteAnimation</a></li><li><a href="Tween.html">Tween</a></li></ul></li><li class="category">Assets<ul class="category-list"><li><a href="Crafty-asset.html">Crafty.asset</a></li><li><a href="Crafty-assets.html">Crafty.assets</a></li><li><a href="Crafty-image_whitelist.html">Crafty.image_whitelist</a></li><li><a href="Crafty-loader.html">Crafty.loader</a></li><li><a href="Crafty-paths.html">Crafty.paths</a></li><li><a href="Crafty-removeAssets.html">Crafty.removeAssets</a></li></ul></li><li class="category">Audio<ul class="category-list"><li><a href="Crafty-audio.html">Crafty.audio</a></li></ul></li><li class="category">Debug<ul class="category-list"><li><a href="DebugCanvas.html">DebugCanvas</a></li><li><a href="DebugPolygon.html">DebugPolygon</a></li><li><a href="DebugRectangle.html">DebugRectangle</a></li><li><a href="SolidHitBox.html">SolidHitBox</a></li><li><a href="VisibleMBR.html">VisibleMBR</a></li><li><a href="WiredHitBox.html">WiredHitBox</a></li></ul></li><li class="category">Events<ul class="category-list"><li><a href="Crafty-addEvent.html">Crafty.addEvent</a></li><li><a href="Crafty-bind.html">Crafty.bind</a></li><li><a href="Crafty-one.html">Crafty.one</a></li><li><a href="Crafty-removeEvent.html">Crafty.removeEvent</a></li><li><a href="Crafty-trigger.html">Crafty.trigger</a></li><li><a href="Crafty-unbind.html">Crafty.unbind</a></li><li><a href="Crafty-uniqueBind.html">Crafty.uniqueBind</a></li></ul></li><li class="category">Game Loop<ul class="category-list"><li><a href="Crafty-timer.html">Crafty.timer</a></li></ul></li><li class="category">Graphics<ul class="category-list"><li><a href="Canvas.html">Canvas</a></li><li><a href="Color.html">Color</a></li><li><a href="Crafty-assignColor.html">Crafty.assignColor</a></li><li><a href="Crafty-background.html">Crafty.background</a></li><li><a href="Crafty-canvas.html">Crafty.canvas</a></li><li><a href="Crafty-DOM.html">Crafty.DOM</a></li><li><a href="Crafty-DrawManager.html">Crafty.DrawManager</a></li><li><a href="Crafty-pixelart.html">Crafty.pixelart</a></li><li><a href="Crafty-sprite.html">Crafty.sprite</a></li><li><a href="DOM.html">DOM</a></li><li><a href="HTML.html">HTML</a></li><li><a href="Image.html">Image</a></li><li><a href="Particles.html">Particles</a></li><li><a href="Sprite.html">Sprite</a></li><li><a href="Text.html">Text</a></li></ul></li><li class="category">Input<ul class="category-list"><li><a href="Crafty-eventObject.html">Crafty.eventObject</a></li><li><a href="Crafty-keydown.html">Crafty.keydown</a></li><li><a href="Crafty-keys.html">Crafty.keys</a></li><li><a href="Crafty-mouseButtons.html">Crafty.mouseButtons</a></li><li><a href="Crafty-mouseDispatch.html">Crafty.mouseDispatch</a></li><li><a href="Crafty-touchDispatch.html">Crafty.touchDispatch</a></li><li><a href="Draggable.html">Draggable</a></li><li><a href="Fourway.html">Fourway</a></li><li><a href="Keyboard.html">Keyboard</a></li><li><a href="KeyboardEvent.html">KeyboardEvent</a></li><li><a href="Mouse.html">Mouse</a></li><li><a href="Multiway.html">Multiway</a></li><li><a href="Twoway.html">Twoway</a></li></ul></li><li class="category">Misc<ul class="category-list"><li><a href="Crafty-addEvent.html">Crafty.addEvent</a></li><li><a href="Crafty-device.html">Crafty.device</a></li><li><a href="Crafty-removeEvent.html">Crafty.removeEvent</a></li><li><a href="Crafty-support.html">Crafty.support</a></li></ul></li><li class="category">Model<ul class="category-list"><li><a href="Model.html">Model</a></li></ul></li><li class="category">Scenes<ul class="category-list"><li><a href="Crafty-scene.html">Crafty.scene</a></li></ul></li><li class="category">Stage<ul class="category-list"><li><a href="Crafty-background.html">Crafty.background</a></li><li><a href="Crafty-scene.html">Crafty.scene</a></li><li><a href="Crafty-viewport.html">Crafty.viewport</a></li></ul></li><li class="category">Utilities<ul class="category-list"><li><a href="Delay.html">Delay</a></li><li><a href="Storage.html">Storage</a></li></ul></li></ul></div><div id="doc-content" class="doc-page-holder"><div class="doc-page"><h1>Crafty.HashMap</h1><div id="Crafty.HashMap"><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/HashMap.js#L305-312">src/HashMap.js#L305-312</a></div><span class="markdown"><p>Broad-phase collision detection engine. See background information at</p>
<ul>
<li><a href="http://www.metanetsoftware.com/technique/tutorialB.html">N Tutorial B - Broad-Phase Collision</a></li>
<li><a href="http.developer.nvidia.com/GPUGems3/gpugems3_ch32.html">Broad-Phase Collision Detection with CUDA</a></li>
</ul>

<h4>See Also</h4>
<ul><li><a href=Crafty-map.html>Crafty.map</a></li></ul><div class='doc-contents'><h4>Properties and Methods</h4><ul><li><a href='#Crafty-HashMap.key'>Crafty.HashMap.key</a></li></ul></div>

<div id='Crafty-HashMap.key' class='docblock'>

<a href='#doc-nav' class='doc-top'>Back to top</a><h2>Crafty.HashMap.key</h2>
<p><code>public Object Crafty.HashMap.key(Object obj)</code> </p>
<p><dl></p>
<p><dt>obj</dt><dd>an Object that has .mbr() or _x, _y, _w and _h.</dd>
</dl>
Get the rectangular region (in terms of the grid, with grid size <code>cellsize</code>), where the object may fall in. This region is determined by the object&#39;s bounding box.
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="Crafty-map.html">Crafty.map</a></li></ul></div></div><div><h4>Methods and Properties</h4><ul class="page-toc"><li><a href="#Crafty-HashMap-constructor">Crafty.HashMap.constructor</a></li><li><a href="#Crafty-HashMap-key">Crafty.HashMap.key</a></li></ul><div id="Crafty.HashMap.constructor"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">Crafty.HashMap.constructor</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/HashMap.js#L10-17">src/HashMap.js#L10-17</a></div><div class="crafty-method"><code class="signature">public void Crafty.HashMap([cellsize])</code><dl class="parameter"><dt> cellsize </dt><dd><span class="markdown"><p>the cell size. If omitted, <code>cellsize</code> is 64.</p>
</span></dd></dl></div><span class="markdown"><p>Set <code>cellsize</code>.
And create <code>this.map</code>.</p>
</span></div><div id="Crafty.HashMap.key"><a href="#doc-nav" class="doc-top">Back to top</a><h2 class="doclet-header">Crafty.HashMap.key</h2><div class="doc-source"><a href="https://github.com/craftyjs/Crafty/blob/b74c13c0cc74f8773bb2bf563009728113ac751c/src/HashMap.js#L315-323">src/HashMap.js#L315-323</a></div><div class="crafty-method"><code class="signature">public Object Crafty.HashMap.key(Object obj)</code><dl class="parameter"><dt> obj </dt><dd><span class="markdown"><p>an Object that has .mbr() or _x, _y, _w and _h.</p>
</span></dd></dl></div><span class="markdown"><p>Get the rectangular region (in terms of the grid, with grid size <code>cellsize</code>), where the object may fall in. This region is determined by the object&#39;s bounding box.
The <code>cellsize</code> is 64 by default.</p>

<p><p><h4>See Also</h4></p></p>
<ul><li><a href=Crafty-HashMap.constructor.html>Crafty.HashMap.constructor</a></li></ul>

<p></div></p>
</div>
</div>
</span><div><h4>See Also</h4><ul class="see-also-list"><li><a href="Crafty-HashMap-constructor.html">Crafty.HashMap.constructor</a></li></ul></div></div></div></div></div></div>

</div>
</div>
Expand Down

0 comments on commit 8b29894

Please sign in to comment.