Update chickadee manual.

author: David Thompson <dthompson@vistahigherlearning.com> 2019-06-04 20:49:16 -0400
committer: David Thompson <dthompson@vistahigherlearning.com> 2019-06-04 20:49:16 -0400
commit: 279f17ac0e1b3d019c2b294098e834d249376686 (patch)
tree: 47be849d3b35635d167e00cd8448815a75167a23 /manuals/chickadee/Tile-Maps.html
parent: 7b808b9268ec735a7a176d10bf1887b3fa66d13e (diff)
1 files changed, 250 insertions, 4 deletions
diff --git a/manuals/chickadee/Tile-Maps.html b/manuals/chickadee/Tile-Maps.html
index cdf4f6e..473d720 100644
--- a/manuals/chickadee/Tile-Maps.html
+++ b/manuals/chickadee/Tile-Maps.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
-<!-- Copyright (C) 2017  David Thompson davet@gnu.org
+<!-- Copyright (C) 2017, 2018, 2019  David Thompson davet@gnu.org
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3
@@ -13,6 +13,8 @@ A copy of the license is also available from the Free Software
 Foundation Web site at http://www.gnu.org/licenses/fdl.html.
 
 
+* Chickadee: (chickadee).     Game programming toolkit for Guile.
+
 The document was typeset with
 http://www.texinfo.org/ (GNU Texinfo).
  -->
@@ -94,7 +96,7 @@ Next: <a href="Lines-and-Shapes.html#Lines-and-Shapes" accesskey="n" rel="next">
 </div>
 <hr>
 <a name="Tile-Maps-1"></a>
-<h4 class="subsection">2.3.4 Tile Maps</h4>
+<h4 class="subsection">2.3.3 Tile Maps</h4>
 
 <p>A tile map is a scene created by composing lots of small sprites,
 called &ldquo;tiles&rdquo;, into a larger image.  One program for editing such
@@ -103,13 +105,64 @@ support for loading and rendering Tiled maps in the <code>(chickadee
 render tiled)</code> module.
 </p>
 <dl>
-<dt><a name="index-load_002dtile_002dmap"></a>Procedure: <strong>load-tile-map</strong> <em><var>file-name</var></em></dt>
+<dt><a name="index-load_002dtile_002dmap"></a>Procedure: <strong>load-tile-map</strong> <em>file-name</em></dt>
 <dd><p>Load the Tiled formatted map in <var>file-name</var> and return a new tile
 map object.
 </p></dd></dl>
 
 <dl>
-<dt><a name="index-draw_002dtile_002dmap"></a>Procedure: <strong>draw-tile-map</strong> <em><var>tile-map</var> [#:layers] [#:region]        [#:origin] [#:position] [#:scale] [#:rotation]</em></dt>
+<dt><a name="index-tile_002dmap_003f"></a>Procedure: <strong>tile-map?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a tile map.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dorientation"></a>Procedure: <strong>tile-map-orientation</strong> <em>tile-map</em></dt>
+<dd><p>Return the orientation of <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dwidth"></a>Procedure: <strong>tile-map-width</strong> <em>tile-map</em></dt>
+<dd><p>Return the width of <var>tile-map</var> in tiles.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dheight"></a>Procedure: <strong>tile-map-height</strong> <em>tile-map</em></dt>
+<dd><p>Return the height of <var>tile-map</var> in tiles.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dtile_002dwidth"></a>Procedure: <strong>tile-map-tile-width</strong> <em>tile-map</em></dt>
+<dd><p>Return the width of tiles in <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dtile_002dheight"></a>Procedure: <strong>tile-map-tile-height</strong> <em>tile-map</em></dt>
+<dd><p>Return the height of tiles in <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dtilesets"></a>Procedure: <strong>tile-map-tilesets</strong> <em>tile-map</em></dt>
+<dd><p>Return the tilesets for <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dlayers"></a>Procedure: <strong>tile-map-layers</strong> <em>tile-map</em></dt>
+<dd><p>Return the layers of <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dmap_002dproperties"></a>Procedure: <strong>tile-map-properties</strong> <em>tile-map</em></dt>
+<dd><p>Return the custom properties of <var>tile-map</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-point_002d_003etile"></a>Procedure: <strong>point-&gt;tile</strong> <em>tile-map x y</em></dt>
+<dd><p>Translate the pixel coordinates (<var>x</var>, <var>y</var>) into tile
+coordinates.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-draw_002dtile_002dmap"></a>Procedure: <strong>draw-tile-map</strong> <em>tile-map [#:layers] [#:region]        [#:origin] [#:position] [#:scale] [#:rotation]</em></dt>
 <dd>
 <p>Draw the layers of <var>tile-map</var>.  By default, all layers are drawn.
 To draw a subset of the available layers, pass a list of layer ids
@@ -119,6 +172,199 @@ using the <var>layers</var> keyword argument.
 the other arguments.
 </p></dd></dl>
 
+<a name="Tilesets"></a>
+<h4 class="subsubsection">2.3.3.1 Tilesets</h4>
+
+<dl>
+<dt><a name="index-tileset_003f"></a>Procedure: <strong>tileset?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a tileset.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dname"></a>Procedure: <strong>tileset-name</strong> <em>tileset</em></dt>
+<dd><p>Return the name of <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dfirst_002dgid"></a>Procedure: <strong>tileset-first-gid</strong> <em>tileset</em></dt>
+<dd><p>Return the starting GID of <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dsize"></a>Procedure: <strong>tileset-size</strong> <em>tileset</em></dt>
+<dd><p>Return the number of tiles in <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dtile_002dwidth"></a>Procedure: <strong>tileset-tile-width</strong> <em>tileset</em></dt>
+<dd><p>Return the width of tiles in <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dtile_002dheight"></a>Procedure: <strong>tileset-tile-height</strong> <em>tileset</em></dt>
+<dd><p>Return the height of tiles in <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002datlas"></a>Procedure: <strong>tileset-atlas</strong> <em>tileset</em></dt>
+<dd><p>Return the texture atlas for <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dtiles"></a>Procedure: <strong>tileset-tiles</strong> <em>tileset</em></dt>
+<dd><p>Return the tiles in <var>tileset</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tileset_002dproperties"></a>Procedure: <strong>tileset-properties</strong> <em>tileset</em></dt>
+<dd><p>Return the custom properties of <var>tileset</var>.
+</p></dd></dl>
+
+<a name="Tiles"></a>
+<h4 class="subsubsection">2.3.3.2 Tiles</h4>
+
+<dl>
+<dt><a name="index-tile_003f"></a>Procedure: <strong>tile?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a tile.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002did"></a>Procedure: <strong>tile-id</strong> <em>tile</em></dt>
+<dd><p>Return the ID of <var>tile</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002danimation"></a>Procedure: <strong>tile-animation</strong> <em>tile</em></dt>
+<dd><p>Return the animation for <var>tile</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dproperties"></a>Procedure: <strong>tile-properties</strong> <em>tile</em></dt>
+<dd><p>Return the custom properties of <var>tile</var>.
+</p></dd></dl>
+
+<a name="Animations"></a>
+<h4 class="subsubsection">2.3.3.3 Animations</h4>
+
+<dl>
+<dt><a name="index-animation_002dframe_003f"></a>Procedure: <strong>animation-frame?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is an animation frame.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-animation_002dframe_002dtile"></a>Procedure: <strong>animation-frame-tile</strong> <em>frame</em></dt>
+<dd><p>Return the tile for <var>frame</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-animation_002dframe_002dduration"></a>Procedure: <strong>animation-frame-duration</strong> <em>frame</em></dt>
+<dd><p>Return the duration of <var>frame</var>.
+</p></dd></dl>
+
+<a name="Layers"></a>
+<h4 class="subsubsection">2.3.3.4 Layers</h4>
+
+<dl>
+<dt><a name="index-tile_002dlayer_003f"></a>Procedure: <strong>tile-layer?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a tile layer.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dlayer_002dname"></a>Procedure: <strong>tile-layer-name</strong> <em>layer</em></dt>
+<dd><p>Return the name of <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dlayer_002dwidth"></a>Procedure: <strong>tile-layer-width</strong> <em>layer</em></dt>
+<dd><p>Return the width in tiles of <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dlayer_002dheight"></a>Procedure: <strong>tile-layer-height</strong> <em>layer</em></dt>
+<dd><p>Return the height in tiles of <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dlayer_002dtiles"></a>Procedure: <strong>tile-layer-tiles</strong> <em>layer</em></dt>
+<dd><p>Return the tile data for <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-tile_002dlayer_002dproperties"></a>Procedure: <strong>tile-layer-properties</strong> <em>layer</em></dt>
+<dd><p>Return the custom properties of <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-object_002dlayer_003f"></a>Procedure: <strong>object-layer?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is an object layer.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-object_002dlayer_002dname"></a>Procedure: <strong>object-layer-name</strong> <em>layer</em></dt>
+<dd><p>Return the name of <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-object_002dlayer_002dobjects"></a>Procedure: <strong>object-layer-objects</strong> <em>layer</em></dt>
+<dd><p>Return the objects for <var>layer</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-object_002dlayer_002dproperties"></a>Procedure: <strong>object-layer-properties</strong> <em>layer</em></dt>
+<dd><p>Return the custom properties of <var>layer</var>.
+</p></dd></dl>
+
+<a name="Objects"></a>
+<h4 class="subsubsection">2.3.3.5 Objects</h4>
+
+<dl>
+<dt><a name="index-map_002dobject_003f"></a>Procedure: <strong>map-object?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a map object.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-map_002dobject_002did"></a>Procedure: <strong>map-object-id</strong> <em>obj</em></dt>
+<dd><p>Return the ID of <var>obj</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-map_002dobject_002dname"></a>Procedure: <strong>map-object-name</strong> <em>obj</em></dt>
+<dd><p>Return the name of <var>obj</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-map_002dobject_002dtype"></a>Procedure: <strong>map-object-type</strong> <em>obj</em></dt>
+<dd><p>Return the type of <var>obj</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-map_002dobject_002dshape"></a>Procedure: <strong>map-object-shape</strong> <em>obj</em></dt>
+<dd><p>Return the shape of <var>obj</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-map_002dobject_002dproperties"></a>Procedure: <strong>map-object-properties</strong> <em>obj</em></dt>
+<dd><p>Return the custom properties of <var>obj</var>.
+</p></dd></dl>
+
+<a name="Polygons"></a>
+<h4 class="subsubsection">2.3.3.6 Polygons</h4>
+
+<dl>
+<dt><a name="index-polygon_003f"></a>Procedure: <strong>polygon?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a polygon.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-polygon_002dpoints"></a>Procedure: <strong>polygon-points</strong> <em>polygon</em></dt>
+<dd><p>Return the list of points that form <var>polygon</var>.
+</p></dd></dl>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Lines-and-Shapes.html#Lines-and-Shapes" accesskey="n" rel="next">Lines and Shapes</a>, Previous: <a href="Sprites.html#Sprites" accesskey="p" rel="prev">Sprites</a>, Up: <a href="Graphics.html#Graphics" accesskey="u" rel="up">Graphics</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
author	David Thompson <dthompson@vistahigherlearning.com>	2019-06-04 20:49:16 -0400
committer	David Thompson <dthompson@vistahigherlearning.com>	2019-06-04 20:49:16 -0400
commit	279f17ac0e1b3d019c2b294098e834d249376686 (patch)
tree	47be849d3b35635d167e00cd8448815a75167a23 /manuals/chickadee/Tile-Maps.html
parent	7b808b9268ec735a7a176d10bf1887b3fa66d13e (diff)