summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Tile-Maps.html
blob: 473d72085c58c06b00b5cf5b39a2a663682d893e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

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).
 -->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Tile Maps (The Chickadee Game Toolkit)</title>

<meta name="description" content="Tile Maps (The Chickadee Game Toolkit)">
<meta name="keywords" content="Tile Maps (The Chickadee Game Toolkit)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics.html#Graphics" rel="up" title="Graphics">
<link href="Lines-and-Shapes.html#Lines-and-Shapes" rel="next" title="Lines and Shapes">
<link href="Sprites.html#Sprites" rel="prev" title="Sprites">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">


</head>

<body lang="en">
<a name="Tile-Maps"></a>
<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>
<hr>
<a name="Tile-Maps-1"></a>
<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
maps is called <a href="http://mapeditor.org">Tiled</a>.  Chickadee has native
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>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-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
using the <var>layers</var> keyword argument.
</p>
<p>Refer to <code>draw-sprite</code> (see <a href="Sprites.html#Sprites">Sprites</a>) for information about
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>



</body>
</html>