-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathtcod.html
24161 lines (18737 loc) · 463 KB
/
tcod.html
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="iso-8859-1"?>
<!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" lang="en" xml:lang="en">
<head>
<title>CL-TCOD</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="title" content="CL-TCOD"/>
<meta name="generator" content="Org-mode"/>
<meta name="generated" content="2012-03-14 12:04:19 New Zealand Daylight Time"/>
<meta name="author" content="Paul Sexton"/>
<meta name="description" content=""/>
<meta name="keywords" content=""/>
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
html { font-family: Times, serif; font-size: 12pt; }
.title { text-align: center; }
.todo { color: red; }
.done { color: green; }
.tag { background-color: #add8e6; font-weight:normal }
.target { }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right {margin-left:auto; margin-right:0px; text-align:right;}
.left {margin-left:0px; margin-right:auto; text-align:left;}
.center {margin-left:auto; margin-right:auto; text-align:center;}
p.verse { margin-left: 3% }
pre {
border: 1pt solid #AEBDCC;
background-color: #F3F5F7;
padding: 5pt;
font-family: courier, monospace;
font-size: 90%;
overflow:auto;
}
table { border-collapse: collapse; }
td, th { vertical-align: top; }
th.right { text-align:center; }
th.left { text-align:center; }
th.center { text-align:center; }
td.right { text-align:right; }
td.left { text-align:left; }
td.center { text-align:center; }
dt { font-weight: bold; }
div.figure { padding: 0.5em; }
div.figure p { text-align: center; }
div.inlinetask {
padding:10px;
border:2px solid gray;
margin:10px;
background: #ffffcc;
}
textarea { overflow-x: auto; }
.linenr { font-size:smaller }
.code-highlighted {background-color:#ffff00;}
.org-info-js_info-navigation { border-style:none; }
#org-info-js_console-label { font-size:10px; font-weight:bold;
white-space:nowrap; }
.org-info-js_search-highlight {background-color:#ffff00; color:#000000;
font-weight:bold; }
/*]]>*/-->
</style>
<script type="text/javascript">
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="preamble">
</div>
<div id="content">
<h1 class="title">CL-TCOD</h1>
<p><a name="tcod" id="tcod"></a>
<a name="package-tcod" id="package-tcod"></a>
</p>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1 Internal Package: <code>tcod</code></a>
<ul>
<li><a href="#sec-1-1">1.1 Introduction</a></li>
<li><a href="#sec-1-2">1.2 License</a></li>
<li><a href="#sec-1-3">1.3 Dependencies</a></li>
<li><a href="#sec-1-4">1.4 Hints on installation</a></li>
<li><a href="#sec-1-5">1.5 Differences between CL-TCOD and libtcod</a>
<ul>
<li><a href="#sec-1-5-1">1.5.1 Naming conventions</a></li>
<li><a href="#sec-1-5-2">1.5.2 Colournums</a></li>
<li><a href="#sec-1-5-3">1.5.3 Colours by keyword</a></li>
<li><a href="#sec-1-5-4">1.5.4 Lisp <code>format</code> versus C <code>printf</code></a></li>
<li><a href="#sec-1-5-5">1.5.5 Miscellaneous extra functions</a></li>
<li><a href="#sec-1-5-6">1.5.6 Coverage</a></li>
</ul>
</li>
<li><a href="#sec-1-6">1.6 Resources</a>
<ul>
<li><a href="#sec-1-6-1">1.6.1 Specific to CL-TCOD and libtcod</a></li>
<li><a href="#sec-1-6-2">1.6.2 Learning Common Lisp</a></li>
<li><a href="#sec-1-6-3">1.6.3 A note on editors and IDEs</a></li>
<li><a href="#sec-1-6-4">1.6.4 Commercial Common Lisp implementations</a></li>
<li><a href="#sec-1-6-5">1.6.5 Full-featured, free Common Lisp implementations</a></li>
</ul>
</li>
<li><a href="#sec-1-7">1.7 External Symbols</a>
<ul>
<li><a href="#sec-1-7-1">1.7.1 External Structures</a>
<ul>
<li><a href="#sec-1-7-1-1">1.7.1.1 Structure: <code>key</code></a></li>
<li><a href="#sec-1-7-1-2">1.7.1.2 Structure: <code>mouse</code></a></li>
</ul>
</li>
<li><a href="#sec-1-7-2">1.7.2 External Types</a>
<ul>
<li><a href="#sec-1-7-2-1">1.7.2.1 Type: <code>a*-path</code></a></li>
<li><a href="#sec-1-7-2-2">1.7.2.2 Type: <code>background-flag</code></a></li>
<li><a href="#sec-1-7-2-3">1.7.2.3 Type: <code>colctrl</code></a></li>
<li><a href="#sec-1-7-2-4">1.7.2.4 Type: <code>console</code></a></li>
<li><a href="#sec-1-7-2-5">1.7.2.5 Type: <code>dijkstra-path</code></a></li>
<li><a href="#sec-1-7-2-6">1.7.2.6 Type: <code>drawing-character</code></a></li>
<li><a href="#sec-1-7-2-7">1.7.2.7 Type: <code>fov-algorithm</code></a></li>
<li><a href="#sec-1-7-2-8">1.7.2.8 Type: <code>key-state</code></a></li>
<li><a href="#sec-1-7-2-9">1.7.2.9 Type: <code>keycode</code></a></li>
<li><a href="#sec-1-7-2-10">1.7.2.10 Type: <code>mapptr</code></a></li>
<li><a href="#sec-1-7-2-11">1.7.2.11 Type: <code>zipptr</code></a></li>
</ul>
</li>
<li><a href="#sec-1-7-3">1.7.3 External Global Variables</a>
<ul>
<li><a href="#sec-1-7-3-1">1.7.3.1 Variable: <code>*root*</code></a></li>
<li><a href="#sec-1-7-3-2">1.7.3.2 Variable: <code>+null+</code></a></li>
</ul>
</li>
<li><a href="#sec-1-7-4">1.7.4 External Macros</a>
<ul>
<li><a href="#sec-1-7-4-1">1.7.4.1 Macro: <code>legal-console-coordinates?</code></a></li>
</ul>
</li>
<li><a href="#sec-1-7-5">1.7.5 External Functions</a>
<ul>
<li><a href="#sec-1-7-5-1">1.7.5.1 Function: <code>background-add-alpha</code></a></li>
<li><a href="#sec-1-7-5-2">1.7.5.2 Function: <code>background-alpha</code></a></li>
<li><a href="#sec-1-7-5-3">1.7.5.3 Function: <code>bsp-contains?</code></a></li>
<li><a href="#sec-1-7-5-4">1.7.5.4 Function: <code>bsp-delete</code></a></li>
<li><a href="#sec-1-7-5-5">1.7.5.5 Function: <code>bsp-father</code></a></li>
<li><a href="#sec-1-7-5-6">1.7.5.6 Function: <code>bsp-find-node</code></a></li>
<li><a href="#sec-1-7-5-7">1.7.5.7 Function: <code>bsp-is-leaf?</code></a></li>
<li><a href="#sec-1-7-5-8">1.7.5.8 Function: <code>bsp-left</code></a></li>
<li><a href="#sec-1-7-5-9">1.7.5.9 Function: <code>bsp-new-with-size</code></a></li>
<li><a href="#sec-1-7-5-10">1.7.5.10 Function: <code>bsp-remove-sons</code></a></li>
<li><a href="#sec-1-7-5-11">1.7.5.11 Function: <code>bsp-resize</code></a></li>
<li><a href="#sec-1-7-5-12">1.7.5.12 Function: <code>bsp-right</code></a></li>
<li><a href="#sec-1-7-5-13">1.7.5.13 Function: <code>bsp-split-once</code></a></li>
<li><a href="#sec-1-7-5-14">1.7.5.14 Function: <code>bsp-split-recursive</code></a></li>
<li><a href="#sec-1-7-5-15">1.7.5.15 Function: <code>bsp-traverse-in-order</code></a></li>
<li><a href="#sec-1-7-5-16">1.7.5.16 Function: <code>bsp-traverse-inverted-level-order</code></a></li>
<li><a href="#sec-1-7-5-17">1.7.5.17 Function: <code>bsp-traverse-level-order</code></a></li>
<li><a href="#sec-1-7-5-18">1.7.5.18 Function: <code>bsp-traverse-post-order</code></a></li>
<li><a href="#sec-1-7-5-19">1.7.5.19 Function: <code>bsp-traverse-pre-order</code></a></li>
<li><a href="#sec-1-7-5-20">1.7.5.20 Function: <code>colctrl->char</code></a></li>
<li><a href="#sec-1-7-5-21">1.7.5.21 Function: <code>color</code></a></li>
<li><a href="#sec-1-7-5-22">1.7.5.22 Function: <code>color->grayscale</code></a></li>
<li><a href="#sec-1-7-5-23">1.7.5.23 Function: <code>color-add</code></a></li>
<li><a href="#sec-1-7-5-24">1.7.5.24 Function: <code>color-equals?</code></a></li>
<li><a href="#sec-1-7-5-25">1.7.5.25 Function: <code>color-get-hsv</code></a></li>
<li><a href="#sec-1-7-5-26">1.7.5.26 Function: <code>color-get-hue</code></a></li>
<li><a href="#sec-1-7-5-27">1.7.5.27 Function: <code>color-get-saturation</code></a></li>
<li><a href="#sec-1-7-5-28">1.7.5.28 Function: <code>color-get-value</code></a></li>
<li><a href="#sec-1-7-5-29">1.7.5.29 Function: <code>color-hsv</code></a></li>
<li><a href="#sec-1-7-5-30">1.7.5.30 Function: <code>color-lerp</code></a></li>
<li><a href="#sec-1-7-5-31">1.7.5.31 Function: <code>color-multiply</code></a></li>
<li><a href="#sec-1-7-5-32">1.7.5.32 Function: <code>color-multiply-scalar</code></a></li>
<li><a href="#sec-1-7-5-33">1.7.5.33 Function: <code>color-rgb</code></a></li>
<li><a href="#sec-1-7-5-34">1.7.5.34 Function: <code>color-set-hsv</code></a></li>
<li><a href="#sec-1-7-5-35">1.7.5.35 Function: <code>color-set-hue</code></a></li>
<li><a href="#sec-1-7-5-36">1.7.5.36 Function: <code>color-set-saturation</code></a></li>
<li><a href="#sec-1-7-5-37">1.7.5.37 Function: <code>color-set-value</code></a></li>
<li><a href="#sec-1-7-5-38">1.7.5.38 Function: <code>color-shift-hue</code></a></li>
<li><a href="#sec-1-7-5-39">1.7.5.39 Function: <code>color-subtract</code></a></li>
<li><a href="#sec-1-7-5-40">1.7.5.40 Function: <code>colour</code></a></li>
<li><a href="#sec-1-7-5-41">1.7.5.41 Function: <code>colour->grayscale</code></a></li>
<li><a href="#sec-1-7-5-42">1.7.5.42 Function: <code>colour-add</code></a></li>
<li><a href="#sec-1-7-5-43">1.7.5.43 Function: <code>colour-equals?</code></a></li>
<li><a href="#sec-1-7-5-44">1.7.5.44 Function: <code>colour-get-hsv</code></a></li>
<li><a href="#sec-1-7-5-45">1.7.5.45 Function: <code>colour-get-hue</code></a></li>
<li><a href="#sec-1-7-5-46">1.7.5.46 Function: <code>colour-get-saturation</code></a></li>
<li><a href="#sec-1-7-5-47">1.7.5.47 Function: <code>colour-get-value</code></a></li>
<li><a href="#sec-1-7-5-48">1.7.5.48 Function: <code>colour-hsv</code></a></li>
<li><a href="#sec-1-7-5-49">1.7.5.49 Function: <code>colour-lerp</code></a></li>
<li><a href="#sec-1-7-5-50">1.7.5.50 Function: <code>colour-multiply</code></a></li>
<li><a href="#sec-1-7-5-51">1.7.5.51 Function: <code>colour-multiply-scalar</code></a></li>
<li><a href="#sec-1-7-5-52">1.7.5.52 Function: <code>colour-rgb</code></a></li>
<li><a href="#sec-1-7-5-53">1.7.5.53 Function: <code>colour-set-hsv</code></a></li>
<li><a href="#sec-1-7-5-54">1.7.5.54 Function: <code>colour-set-hue</code></a></li>
<li><a href="#sec-1-7-5-55">1.7.5.55 Function: <code>colour-set-saturation</code></a></li>
<li><a href="#sec-1-7-5-56">1.7.5.56 Function: <code>colour-set-value</code></a></li>
<li><a href="#sec-1-7-5-57">1.7.5.57 Function: <code>colour-shift-hue</code></a></li>
<li><a href="#sec-1-7-5-58">1.7.5.58 Function: <code>colour-subtract</code></a></li>
<li><a href="#sec-1-7-5-59">1.7.5.59 Function: <code>compose-color</code></a></li>
<li><a href="#sec-1-7-5-60">1.7.5.60 Function: <code>compose-colour</code></a></li>
<li><a href="#sec-1-7-5-61">1.7.5.61 Function: <code>console-blit</code></a></li>
<li><a href="#sec-1-7-5-62">1.7.5.62 Function: <code>console-check-for-keypress</code></a></li>
<li><a href="#sec-1-7-5-63">1.7.5.63 Function: <code>console-clear</code></a></li>
<li><a href="#sec-1-7-5-64">1.7.5.64 Function: <code>console-credits</code></a></li>
<li><a href="#sec-1-7-5-65">1.7.5.65 Function: <code>console-credits-reset</code></a></li>
<li><a href="#sec-1-7-5-66">1.7.5.66 Function: <code>console-delete</code></a></li>
<li><a href="#sec-1-7-5-67">1.7.5.67 Function: <code>console-disable-keyboard-repeat</code></a></li>
<li><a href="#sec-1-7-5-68">1.7.5.68 Function: <code>console-fill-char</code></a></li>
<li><a href="#sec-1-7-5-69">1.7.5.69 Function: <code>console-flush</code></a></li>
<li><a href="#sec-1-7-5-70">1.7.5.70 Function: <code>console-get-alignment</code></a></li>
<li><a href="#sec-1-7-5-71">1.7.5.71 Function: <code>console-get-background-flag</code></a></li>
<li><a href="#sec-1-7-5-72">1.7.5.72 Function: <code>console-get-char</code></a></li>
<li><a href="#sec-1-7-5-73">1.7.5.73 Function: <code>console-get-char-background</code></a></li>
<li><a href="#sec-1-7-5-74">1.7.5.74 Function: <code>console-get-char-foreground</code></a></li>
<li><a href="#sec-1-7-5-75">1.7.5.75 Function: <code>console-get-default-background</code></a></li>
<li><a href="#sec-1-7-5-76">1.7.5.76 Function: <code>console-get-default-foreground</code></a></li>
<li><a href="#sec-1-7-5-77">1.7.5.77 Function: <code>console-get-fade</code></a></li>
<li><a href="#sec-1-7-5-78">1.7.5.78 Function: <code>console-get-fading-color</code></a></li>
<li><a href="#sec-1-7-5-79">1.7.5.79 Function: <code>console-get-fading-colour</code></a></li>
<li><a href="#sec-1-7-5-80">1.7.5.80 Function: <code>console-get-height</code></a></li>
<li><a href="#sec-1-7-5-81">1.7.5.81 Function: <code>console-get-height-rect</code></a></li>
<li><a href="#sec-1-7-5-82">1.7.5.82 Function: <code>console-get-width</code></a></li>
<li><a href="#sec-1-7-5-83">1.7.5.83 Function: <code>console-hline</code></a></li>
<li><a href="#sec-1-7-5-84">1.7.5.84 Function: <code>console-init-root</code></a></li>
<li><a href="#sec-1-7-5-85">1.7.5.85 Function: <code>console-is-fullscreen?</code></a></li>
<li><a href="#sec-1-7-5-86">1.7.5.86 Function: <code>console-is-window-closed?</code></a></li>
<li><a href="#sec-1-7-5-87">1.7.5.87 Function: <code>console-map-ascii-code-to-font</code></a></li>
<li><a href="#sec-1-7-5-88">1.7.5.88 Function: <code>console-map-ascii-codes-to-font</code></a></li>
<li><a href="#sec-1-7-5-89">1.7.5.89 Function: <code>console-map-string-to-font</code></a></li>
<li><a href="#sec-1-7-5-90">1.7.5.90 Function: <code>console-map-string-to-font-utf</code></a></li>
<li><a href="#sec-1-7-5-91">1.7.5.91 Function: <code>console-new</code></a></li>
<li><a href="#sec-1-7-5-92">1.7.5.92 Function: <code>console-print</code></a></li>
<li><a href="#sec-1-7-5-93">1.7.5.93 Function: <code>console-print-double-frame</code></a></li>
<li><a href="#sec-1-7-5-94">1.7.5.94 Function: <code>console-print-ex</code></a></li>
<li><a href="#sec-1-7-5-95">1.7.5.95 Function: <code>console-print-ex-utf</code></a></li>
<li><a href="#sec-1-7-5-96">1.7.5.96 Function: <code>console-print-frame</code></a></li>
<li><a href="#sec-1-7-5-97">1.7.5.97 Function: <code>console-print-rect</code></a></li>
<li><a href="#sec-1-7-5-98">1.7.5.98 Function: <code>console-print-rect-ex</code></a></li>
<li><a href="#sec-1-7-5-99">1.7.5.99 Function: <code>console-print-rect-ex-utf</code></a></li>
<li><a href="#sec-1-7-5-100">1.7.5.100 Function: <code>console-print-rect-utf</code></a></li>
<li><a href="#sec-1-7-5-101">1.7.5.101 Function: <code>console-print-utf</code></a></li>
<li><a href="#sec-1-7-5-102">1.7.5.102 Function: <code>console-put-char</code></a></li>
<li><a href="#sec-1-7-5-103">1.7.5.103 Function: <code>console-put-char-ex</code></a></li>
<li><a href="#sec-1-7-5-104">1.7.5.104 Function: <code>console-rect</code></a></li>
<li><a href="#sec-1-7-5-105">1.7.5.105 Function: <code>console-set-alignment</code></a></li>
<li><a href="#sec-1-7-5-106">1.7.5.106 Function: <code>console-set-background-flag</code></a></li>
<li><a href="#sec-1-7-5-107">1.7.5.107 Function: <code>console-set-char</code></a></li>
<li><a href="#sec-1-7-5-108">1.7.5.108 Function: <code>console-set-char-background</code></a></li>
<li><a href="#sec-1-7-5-109">1.7.5.109 Function: <code>console-set-char-foreground</code></a></li>
<li><a href="#sec-1-7-5-110">1.7.5.110 Function: <code>console-set-color-control</code></a></li>
<li><a href="#sec-1-7-5-111">1.7.5.111 Function: <code>console-set-colour-control</code></a></li>
<li><a href="#sec-1-7-5-112">1.7.5.112 Function: <code>console-set-custom-font</code></a></li>
<li><a href="#sec-1-7-5-113">1.7.5.113 Function: <code>console-set-default-background</code></a></li>
<li><a href="#sec-1-7-5-114">1.7.5.114 Function: <code>console-set-default-foreground</code></a></li>
<li><a href="#sec-1-7-5-115">1.7.5.115 Function: <code>console-set-dirty</code></a></li>
<li><a href="#sec-1-7-5-116">1.7.5.116 Function: <code>console-set-fade</code></a></li>
<li><a href="#sec-1-7-5-117">1.7.5.117 Function: <code>console-set-fullscreen</code></a></li>
<li><a href="#sec-1-7-5-118">1.7.5.118 Function: <code>console-set-keyboard-repeat</code></a></li>
<li><a href="#sec-1-7-5-119">1.7.5.119 Function: <code>console-set-window-title</code></a></li>
<li><a href="#sec-1-7-5-120">1.7.5.120 Function: <code>console-vline</code></a></li>
<li><a href="#sec-1-7-5-121">1.7.5.121 Function: <code>console-wait-for-keypress</code></a></li>
<li><a href="#sec-1-7-5-122">1.7.5.122 Function: <code>decompose-color</code></a></li>
<li><a href="#sec-1-7-5-123">1.7.5.123 Function: <code>decompose-colour</code></a></li>
<li><a href="#sec-1-7-5-124">1.7.5.124 Function: <code>dijkstra-compute</code></a></li>
<li><a href="#sec-1-7-5-125">1.7.5.125 Function: <code>dijkstra-delete</code></a></li>
<li><a href="#sec-1-7-5-126">1.7.5.126 Function: <code>dijkstra-get</code></a></li>
<li><a href="#sec-1-7-5-127">1.7.5.127 Function: <code>dijkstra-get-distance</code></a></li>
<li><a href="#sec-1-7-5-128">1.7.5.128 Function: <code>dijkstra-is-empty?</code></a></li>
<li><a href="#sec-1-7-5-129">1.7.5.129 Function: <code>dijkstra-new</code></a></li>
<li><a href="#sec-1-7-5-130">1.7.5.130 Function: <code>dijkstra-new-using-function</code></a></li>
<li><a href="#sec-1-7-5-131">1.7.5.131 Function: <code>dijkstra-path-set</code></a></li>
<li><a href="#sec-1-7-5-132">1.7.5.132 Function: <code>dijkstra-path-walk</code></a></li>
<li><a href="#sec-1-7-5-133">1.7.5.133 Function: <code>dijkstra-reverse</code></a></li>
<li><a href="#sec-1-7-5-134">1.7.5.134 Function: <code>dijkstra-size</code></a></li>
<li><a href="#sec-1-7-5-135">1.7.5.135 Function: <code>heightmap-add</code></a></li>
<li><a href="#sec-1-7-5-136">1.7.5.136 Function: <code>heightmap-add-fbm</code></a></li>
<li><a href="#sec-1-7-5-137">1.7.5.137 Function: <code>heightmap-add-hill</code></a></li>
<li><a href="#sec-1-7-5-138">1.7.5.138 Function: <code>heightmap-add-hm</code></a></li>
<li><a href="#sec-1-7-5-139">1.7.5.139 Function: <code>heightmap-add-voronoi</code></a></li>
<li><a href="#sec-1-7-5-140">1.7.5.140 Function: <code>heightmap-clamp</code></a></li>
<li><a href="#sec-1-7-5-141">1.7.5.141 Function: <code>heightmap-clear</code></a></li>
<li><a href="#sec-1-7-5-142">1.7.5.142 Function: <code>heightmap-copy</code></a></li>
<li><a href="#sec-1-7-5-143">1.7.5.143 Function: <code>heightmap-count-cells</code></a></li>
<li><a href="#sec-1-7-5-144">1.7.5.144 Function: <code>heightmap-delete</code></a></li>
<li><a href="#sec-1-7-5-145">1.7.5.145 Function: <code>heightmap-dig-bezier</code></a></li>
<li><a href="#sec-1-7-5-146">1.7.5.146 Function: <code>heightmap-dig-hill</code></a></li>
<li><a href="#sec-1-7-5-147">1.7.5.147 Function: <code>heightmap-dig-line</code></a></li>
<li><a href="#sec-1-7-5-148">1.7.5.148 Function: <code>heightmap-get-interpolated-value</code></a></li>
<li><a href="#sec-1-7-5-149">1.7.5.149 Function: <code>heightmap-get-max</code></a></li>
<li><a href="#sec-1-7-5-150">1.7.5.150 Function: <code>heightmap-get-min</code></a></li>
<li><a href="#sec-1-7-5-151">1.7.5.151 Function: <code>heightmap-get-normal</code></a></li>
<li><a href="#sec-1-7-5-152">1.7.5.152 Function: <code>heightmap-get-slope</code></a></li>
<li><a href="#sec-1-7-5-153">1.7.5.153 Function: <code>heightmap-get-value</code></a></li>
<li><a href="#sec-1-7-5-154">1.7.5.154 Function: <code>heightmap-has-land-on-border?</code></a></li>
<li><a href="#sec-1-7-5-155">1.7.5.155 Function: <code>heightmap-islandify</code></a></li>
<li><a href="#sec-1-7-5-156">1.7.5.156 Function: <code>heightmap-kernel-transform</code></a></li>
<li><a href="#sec-1-7-5-157">1.7.5.157 Function: <code>heightmap-lerp-hm</code></a></li>
<li><a href="#sec-1-7-5-158">1.7.5.158 Function: <code>heightmap-multiply-hm</code></a></li>
<li><a href="#sec-1-7-5-159">1.7.5.159 Function: <code>heightmap-new</code></a></li>
<li><a href="#sec-1-7-5-160">1.7.5.160 Function: <code>heightmap-normalise</code></a></li>
<li><a href="#sec-1-7-5-161">1.7.5.161 Function: <code>heightmap-normalize</code></a></li>
<li><a href="#sec-1-7-5-162">1.7.5.162 Function: <code>heightmap-rain-erosion</code></a></li>
<li><a href="#sec-1-7-5-163">1.7.5.163 Function: <code>heightmap-scale</code></a></li>
<li><a href="#sec-1-7-5-164">1.7.5.164 Function: <code>heightmap-scale-fbm</code></a></li>
<li><a href="#sec-1-7-5-165">1.7.5.165 Function: <code>heightmap-set-value</code></a></li>
<li><a href="#sec-1-7-5-166">1.7.5.166 Function: <code>image-blit</code></a></li>
<li><a href="#sec-1-7-5-167">1.7.5.167 Function: <code>image-blit-2x</code></a></li>
<li><a href="#sec-1-7-5-168">1.7.5.168 Function: <code>image-blit-rect</code></a></li>
<li><a href="#sec-1-7-5-169">1.7.5.169 Function: <code>image-clear</code></a></li>
<li><a href="#sec-1-7-5-170">1.7.5.170 Function: <code>image-delete</code></a></li>
<li><a href="#sec-1-7-5-171">1.7.5.171 Function: <code>image-from-console</code></a></li>
<li><a href="#sec-1-7-5-172">1.7.5.172 Function: <code>image-get-alpha</code></a></li>
<li><a href="#sec-1-7-5-173">1.7.5.173 Function: <code>image-get-height</code></a></li>
<li><a href="#sec-1-7-5-174">1.7.5.174 Function: <code>image-get-mipmap-pixel</code></a></li>
<li><a href="#sec-1-7-5-175">1.7.5.175 Function: <code>image-get-pixel</code></a></li>
<li><a href="#sec-1-7-5-176">1.7.5.176 Function: <code>image-get-width</code></a></li>
<li><a href="#sec-1-7-5-177">1.7.5.177 Function: <code>image-hflip</code></a></li>
<li><a href="#sec-1-7-5-178">1.7.5.178 Function: <code>image-invert</code></a></li>
<li><a href="#sec-1-7-5-179">1.7.5.179 Function: <code>image-is-pixel-transparent?</code></a></li>
<li><a href="#sec-1-7-5-180">1.7.5.180 Function: <code>image-load</code></a></li>
<li><a href="#sec-1-7-5-181">1.7.5.181 Function: <code>image-new</code></a></li>
<li><a href="#sec-1-7-5-182">1.7.5.182 Function: <code>image-put-pixel</code></a></li>
<li><a href="#sec-1-7-5-183">1.7.5.183 Function: <code>image-refresh-console</code></a></li>
<li><a href="#sec-1-7-5-184">1.7.5.184 Function: <code>image-rotate90</code></a></li>
<li><a href="#sec-1-7-5-185">1.7.5.185 Function: <code>image-save</code></a></li>
<li><a href="#sec-1-7-5-186">1.7.5.186 Function: <code>image-scale</code></a></li>
<li><a href="#sec-1-7-5-187">1.7.5.187 Function: <code>image-set-key-color</code></a></li>
<li><a href="#sec-1-7-5-188">1.7.5.188 Function: <code>image-set-key-colour</code></a></li>
<li><a href="#sec-1-7-5-189">1.7.5.189 Function: <code>image-vflip</code></a></li>
<li><a href="#sec-1-7-5-190">1.7.5.190 Function: <code>invert-color</code></a></li>
<li><a href="#sec-1-7-5-191">1.7.5.191 Function: <code>invert-colour</code></a></li>
<li><a href="#sec-1-7-5-192">1.7.5.192 Function: <code>is-key-pressed?</code></a></li>
<li><a href="#sec-1-7-5-193">1.7.5.193 Function: <code>key-c</code></a></li>
<li><a href="#sec-1-7-5-194">1.7.5.194 Function: <code>key-lalt</code></a></li>
<li><a href="#sec-1-7-5-195">1.7.5.195 Function: <code>key-lctrl</code></a></li>
<li><a href="#sec-1-7-5-196">1.7.5.196 Function: <code>key-p</code></a></li>
<li><a href="#sec-1-7-5-197">1.7.5.197 Function: <code>key-pressed</code></a></li>
<li><a href="#sec-1-7-5-198">1.7.5.198 Function: <code>key-ralt</code></a></li>
<li><a href="#sec-1-7-5-199">1.7.5.199 Function: <code>key-rctrl</code></a></li>
<li><a href="#sec-1-7-5-200">1.7.5.200 Function: <code>key-shift</code></a></li>
<li><a href="#sec-1-7-5-201">1.7.5.201 Function: <code>key-vk</code></a></li>
<li><a href="#sec-1-7-5-202">1.7.5.202 Function: <code>line-init</code></a></li>
<li><a href="#sec-1-7-5-203">1.7.5.203 Function: <code>line-line</code></a></li>
<li><a href="#sec-1-7-5-204">1.7.5.204 Function: <code>line-step</code></a></li>
<li><a href="#sec-1-7-5-205">1.7.5.205 Function: <code>make-color</code></a></li>
<li><a href="#sec-1-7-5-206">1.7.5.206 Function: <code>make-colour</code></a></li>
<li><a href="#sec-1-7-5-207">1.7.5.207 Function: <code>make-key</code></a></li>
<li><a href="#sec-1-7-5-208">1.7.5.208 Function: <code>make-mouse</code></a></li>
<li><a href="#sec-1-7-5-209">1.7.5.209 Function: <code>make-simple-key</code></a></li>
<li><a href="#sec-1-7-5-210">1.7.5.210 Function: <code>map-clear</code></a></li>
<li><a href="#sec-1-7-5-211">1.7.5.211 Function: <code>map-compute-fov</code></a></li>
<li><a href="#sec-1-7-5-212">1.7.5.212 Function: <code>map-copy</code></a></li>
<li><a href="#sec-1-7-5-213">1.7.5.213 Function: <code>map-delete</code></a></li>
<li><a href="#sec-1-7-5-214">1.7.5.214 Function: <code>map-get-height</code></a></li>
<li><a href="#sec-1-7-5-215">1.7.5.215 Function: <code>map-get-nb-cells</code></a></li>
<li><a href="#sec-1-7-5-216">1.7.5.216 Function: <code>map-get-width</code></a></li>
<li><a href="#sec-1-7-5-217">1.7.5.217 Function: <code>map-is-in-fov?</code></a></li>
<li><a href="#sec-1-7-5-218">1.7.5.218 Function: <code>map-is-transparent?</code></a></li>
<li><a href="#sec-1-7-5-219">1.7.5.219 Function: <code>map-is-walkable?</code></a></li>
<li><a href="#sec-1-7-5-220">1.7.5.220 Function: <code>map-new</code></a></li>
<li><a href="#sec-1-7-5-221">1.7.5.221 Function: <code>map-set-in-fov</code></a></li>
<li><a href="#sec-1-7-5-222">1.7.5.222 Function: <code>map-set-properties</code></a></li>
<li><a href="#sec-1-7-5-223">1.7.5.223 Function: <code>mouse-cx</code></a></li>
<li><a href="#sec-1-7-5-224">1.7.5.224 Function: <code>mouse-cy</code></a></li>
<li><a href="#sec-1-7-5-225">1.7.5.225 Function: <code>mouse-dx</code></a></li>
<li><a href="#sec-1-7-5-226">1.7.5.226 Function: <code>mouse-dy</code></a></li>
<li><a href="#sec-1-7-5-227">1.7.5.227 Function: <code>mouse-get-cx</code></a></li>
<li><a href="#sec-1-7-5-228">1.7.5.228 Function: <code>mouse-get-cy</code></a></li>
<li><a href="#sec-1-7-5-229">1.7.5.229 Function: <code>mouse-get-dcx</code></a></li>
<li><a href="#sec-1-7-5-230">1.7.5.230 Function: <code>mouse-get-dcy</code></a></li>
<li><a href="#sec-1-7-5-231">1.7.5.231 Function: <code>mouse-get-dx</code></a></li>
<li><a href="#sec-1-7-5-232">1.7.5.232 Function: <code>mouse-get-dy</code></a></li>
<li><a href="#sec-1-7-5-233">1.7.5.233 Function: <code>mouse-get-lbutton</code></a></li>
<li><a href="#sec-1-7-5-234">1.7.5.234 Function: <code>mouse-get-lbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-235">1.7.5.235 Function: <code>mouse-get-mbutton</code></a></li>
<li><a href="#sec-1-7-5-236">1.7.5.236 Function: <code>mouse-get-mbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-237">1.7.5.237 Function: <code>mouse-get-rbutton</code></a></li>
<li><a href="#sec-1-7-5-238">1.7.5.238 Function: <code>mouse-get-rbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-239">1.7.5.239 Function: <code>mouse-get-status</code></a></li>
<li><a href="#sec-1-7-5-240">1.7.5.240 Function: <code>mouse-get-x</code></a></li>
<li><a href="#sec-1-7-5-241">1.7.5.241 Function: <code>mouse-get-y</code></a></li>
<li><a href="#sec-1-7-5-242">1.7.5.242 Function: <code>mouse-is-cursor-visible?</code></a></li>
<li><a href="#sec-1-7-5-243">1.7.5.243 Function: <code>mouse-lbutton</code></a></li>
<li><a href="#sec-1-7-5-244">1.7.5.244 Function: <code>mouse-lbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-245">1.7.5.245 Function: <code>mouse-mbutton</code></a></li>
<li><a href="#sec-1-7-5-246">1.7.5.246 Function: <code>mouse-mbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-247">1.7.5.247 Function: <code>mouse-move</code></a></li>
<li><a href="#sec-1-7-5-248">1.7.5.248 Function: <code>mouse-rbutton</code></a></li>
<li><a href="#sec-1-7-5-249">1.7.5.249 Function: <code>mouse-rbutton-pressed</code></a></li>
<li><a href="#sec-1-7-5-250">1.7.5.250 Function: <code>mouse-show-cursor</code></a></li>
<li><a href="#sec-1-7-5-251">1.7.5.251 Function: <code>mouse-wheel-down</code></a></li>
<li><a href="#sec-1-7-5-252">1.7.5.252 Function: <code>mouse-wheel-up</code></a></li>
<li><a href="#sec-1-7-5-253">1.7.5.253 Function: <code>mouse-x</code></a></li>
<li><a href="#sec-1-7-5-254">1.7.5.254 Function: <code>mouse-y</code></a></li>
<li><a href="#sec-1-7-5-255">1.7.5.255 Function: <code>namegen-destroy</code></a></li>
<li><a href="#sec-1-7-5-256">1.7.5.256 Function: <code>namegen-generate</code></a></li>
<li><a href="#sec-1-7-5-257">1.7.5.257 Function: <code>namegen-generate-custom</code></a></li>
<li><a href="#sec-1-7-5-258">1.7.5.258 Function: <code>namegen-parse</code></a></li>
<li><a href="#sec-1-7-5-259">1.7.5.259 Function: <code>noise-delete</code></a></li>
<li><a href="#sec-1-7-5-260">1.7.5.260 Function: <code>noise-get</code></a></li>
<li><a href="#sec-1-7-5-261">1.7.5.261 Function: <code>noise-get-ex</code></a></li>
<li><a href="#sec-1-7-5-262">1.7.5.262 Function: <code>noise-get-fbm</code></a></li>
<li><a href="#sec-1-7-5-263">1.7.5.263 Function: <code>noise-get-fbm-ex</code></a></li>
<li><a href="#sec-1-7-5-264">1.7.5.264 Function: <code>noise-get-turbulence</code></a></li>
<li><a href="#sec-1-7-5-265">1.7.5.265 Function: <code>noise-get-turbulence-ex</code></a></li>
<li><a href="#sec-1-7-5-266">1.7.5.266 Function: <code>noise-new</code></a></li>
<li><a href="#sec-1-7-5-267">1.7.5.267 Function: <code>noise-set-type</code></a></li>
<li><a href="#sec-1-7-5-268">1.7.5.268 Function: <code>path-compute</code></a></li>
<li><a href="#sec-1-7-5-269">1.7.5.269 Function: <code>path-delete</code></a></li>
<li><a href="#sec-1-7-5-270">1.7.5.270 Function: <code>path-get</code></a></li>
<li><a href="#sec-1-7-5-271">1.7.5.271 Function: <code>path-get-destination</code></a></li>
<li><a href="#sec-1-7-5-272">1.7.5.272 Function: <code>path-get-origin</code></a></li>
<li><a href="#sec-1-7-5-273">1.7.5.273 Function: <code>path-is-empty?</code></a></li>
<li><a href="#sec-1-7-5-274">1.7.5.274 Function: <code>path-new-using-function</code></a></li>
<li><a href="#sec-1-7-5-275">1.7.5.275 Function: <code>path-new-using-map</code></a></li>
<li><a href="#sec-1-7-5-276">1.7.5.276 Function: <code>path-reverse</code></a></li>
<li><a href="#sec-1-7-5-277">1.7.5.277 Function: <code>path-size</code></a></li>
<li><a href="#sec-1-7-5-278">1.7.5.278 Function: <code>path-walk</code></a></li>
<li><a href="#sec-1-7-5-279">1.7.5.279 Function: <code>random-delete</code></a></li>
<li><a href="#sec-1-7-5-280">1.7.5.280 Function: <code>random-get-double</code></a></li>
<li><a href="#sec-1-7-5-281">1.7.5.281 Function: <code>random-get-double-mean</code></a></li>
<li><a href="#sec-1-7-5-282">1.7.5.282 Function: <code>random-get-float</code></a></li>
<li><a href="#sec-1-7-5-283">1.7.5.283 Function: <code>random-get-float-mean</code></a></li>
<li><a href="#sec-1-7-5-284">1.7.5.284 Function: <code>random-get-instance</code></a></li>
<li><a href="#sec-1-7-5-285">1.7.5.285 Function: <code>random-get-int</code></a></li>
<li><a href="#sec-1-7-5-286">1.7.5.286 Function: <code>random-get-int-mean</code></a></li>
<li><a href="#sec-1-7-5-287">1.7.5.287 Function: <code>random-new</code></a></li>
<li><a href="#sec-1-7-5-288">1.7.5.288 Function: <code>random-new-from-seed</code></a></li>
<li><a href="#sec-1-7-5-289">1.7.5.289 Function: <code>random-restore</code></a></li>
<li><a href="#sec-1-7-5-290">1.7.5.290 Function: <code>random-save</code></a></li>
<li><a href="#sec-1-7-5-291">1.7.5.291 Function: <code>random-set-distribution</code></a></li>
<li><a href="#sec-1-7-5-292">1.7.5.292 Function: <code>same-keys?</code></a></li>
<li><a href="#sec-1-7-5-293">1.7.5.293 Function: <code>start-colors</code></a></li>
<li><a href="#sec-1-7-5-294">1.7.5.294 Function: <code>start-colours</code></a></li>
<li><a href="#sec-1-7-5-295">1.7.5.295 Function: <code>sys-check-for-event</code></a></li>
<li><a href="#sec-1-7-5-296">1.7.5.296 Function: <code>sys-clipboard-get</code></a></li>
<li><a href="#sec-1-7-5-297">1.7.5.297 Function: <code>sys-clipboard-set</code></a></li>
<li><a href="#sec-1-7-5-298">1.7.5.298 Function: <code>sys-create-directory</code></a></li>
<li><a href="#sec-1-7-5-299">1.7.5.299 Function: <code>sys-delete-directory</code></a></li>
<li><a href="#sec-1-7-5-300">1.7.5.300 Function: <code>sys-elapsed-milli</code></a></li>
<li><a href="#sec-1-7-5-301">1.7.5.301 Function: <code>sys-elapsed-seconds</code></a></li>
<li><a href="#sec-1-7-5-302">1.7.5.302 Function: <code>sys-force-fullscreen-resolution</code></a></li>
<li><a href="#sec-1-7-5-303">1.7.5.303 Function: <code>sys-get-char-size</code></a></li>
<li><a href="#sec-1-7-5-304">1.7.5.304 Function: <code>sys-get-current-resolution</code></a></li>
<li><a href="#sec-1-7-5-305">1.7.5.305 Function: <code>sys-get-events</code></a></li>
<li><a href="#sec-1-7-5-306">1.7.5.306 Function: <code>sys-get-fps</code></a></li>
<li><a href="#sec-1-7-5-307">1.7.5.307 Function: <code>sys-get-fullscreen-offsets</code></a></li>
<li><a href="#sec-1-7-5-308">1.7.5.308 Function: <code>sys-get-last-frame-length</code></a></li>
<li><a href="#sec-1-7-5-309">1.7.5.309 Function: <code>sys-get-renderer</code></a></li>
<li><a href="#sec-1-7-5-310">1.7.5.310 Function: <code>sys-register-sdl-renderer</code></a></li>
<li><a href="#sec-1-7-5-311">1.7.5.311 Function: <code>sys-save-screenshot</code></a></li>
<li><a href="#sec-1-7-5-312">1.7.5.312 Function: <code>sys-set-fps</code></a></li>
<li><a href="#sec-1-7-5-313">1.7.5.313 Function: <code>sys-set-renderer</code></a></li>
<li><a href="#sec-1-7-5-314">1.7.5.314 Function: <code>sys-sleep-milli</code></a></li>
<li><a href="#sec-1-7-5-315">1.7.5.315 Function: <code>sys-update-char</code></a></li>
<li><a href="#sec-1-7-5-316">1.7.5.316 Function: <code>sys-wait-for-event</code></a></li>
<li><a href="#sec-1-7-5-317">1.7.5.317 Function: <code>zip-delete</code></a></li>
<li><a href="#sec-1-7-5-318">1.7.5.318 Function: <code>zip-get-char</code></a></li>
<li><a href="#sec-1-7-5-319">1.7.5.319 Function: <code>zip-get-color</code></a></li>
<li><a href="#sec-1-7-5-320">1.7.5.320 Function: <code>zip-get-colour</code></a></li>
<li><a href="#sec-1-7-5-321">1.7.5.321 Function: <code>zip-get-console</code></a></li>
<li><a href="#sec-1-7-5-322">1.7.5.322 Function: <code>zip-get-current-bytes</code></a></li>
<li><a href="#sec-1-7-5-323">1.7.5.323 Function: <code>zip-get-data</code></a></li>
<li><a href="#sec-1-7-5-324">1.7.5.324 Function: <code>zip-get-float</code></a></li>
<li><a href="#sec-1-7-5-325">1.7.5.325 Function: <code>zip-get-image</code></a></li>
<li><a href="#sec-1-7-5-326">1.7.5.326 Function: <code>zip-get-int</code></a></li>
<li><a href="#sec-1-7-5-327">1.7.5.327 Function: <code>zip-get-remaining-bytes</code></a></li>
<li><a href="#sec-1-7-5-328">1.7.5.328 Function: <code>zip-get-string</code></a></li>
<li><a href="#sec-1-7-5-329">1.7.5.329 Function: <code>zip-load-from-file</code></a></li>
<li><a href="#sec-1-7-5-330">1.7.5.330 Function: <code>zip-new</code></a></li>
<li><a href="#sec-1-7-5-331">1.7.5.331 Function: <code>zip-put</code></a></li>
<li><a href="#sec-1-7-5-332">1.7.5.332 Function: <code>zip-put-char</code></a></li>
<li><a href="#sec-1-7-5-333">1.7.5.333 Function: <code>zip-put-color</code></a></li>
<li><a href="#sec-1-7-5-334">1.7.5.334 Function: <code>zip-put-colour</code></a></li>
<li><a href="#sec-1-7-5-335">1.7.5.335 Function: <code>zip-put-console</code></a></li>
<li><a href="#sec-1-7-5-336">1.7.5.336 Function: <code>zip-put-data</code></a></li>
<li><a href="#sec-1-7-5-337">1.7.5.337 Function: <code>zip-put-float</code></a></li>
<li><a href="#sec-1-7-5-338">1.7.5.338 Function: <code>zip-put-image</code></a></li>
<li><a href="#sec-1-7-5-339">1.7.5.339 Function: <code>zip-put-int</code></a></li>
<li><a href="#sec-1-7-5-340">1.7.5.340 Function: <code>zip-put-string</code></a></li>
<li><a href="#sec-1-7-5-341">1.7.5.341 Function: <code>zip-save-to-file</code></a></li>
<li><a href="#sec-1-7-5-342">1.7.5.342 Function: <code>zip-skip-bytes</code></a></li>
</ul></li>
</ul>
</li>
<li><a href="#sec-1-8">1.8 Index</a>
<ul>
<li><a href="#sec-1-8-1">1.8.1 Nonalphabetic</a></li>
<li><a href="#sec-1-8-2">1.8.2 A</a></li>
<li><a href="#sec-1-8-3">1.8.3 B</a></li>
<li><a href="#sec-1-8-4">1.8.4 C</a></li>
<li><a href="#sec-1-8-5">1.8.5 D</a></li>
<li><a href="#sec-1-8-6">1.8.6 F</a></li>
<li><a href="#sec-1-8-7">1.8.7 H</a></li>
<li><a href="#sec-1-8-8">1.8.8 I</a></li>
<li><a href="#sec-1-8-9">1.8.9 K</a></li>
<li><a href="#sec-1-8-10">1.8.10 L</a></li>
<li><a href="#sec-1-8-11">1.8.11 M</a></li>
<li><a href="#sec-1-8-12">1.8.12 N</a></li>
<li><a href="#sec-1-8-13">1.8.13 P</a></li>
<li><a href="#sec-1-8-14">1.8.14 R</a></li>
<li><a href="#sec-1-8-15">1.8.15 S</a></li>
<li><a href="#sec-1-8-16">1.8.16 Z</a></li>
</ul></li>
</ul>
</li>
<li><a href="#sec-2">2 Colophon</a></li>
</ul>
</div>
</div>
<div id="outline-container-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Internal Package: <code>tcod</code></h2>
<div class="outline-text-2" id="text-1">
<ul>
<li>Uses:
<a href="#package-common-lisp">common-lisp</a>, <a href="#package-cffi">cffi</a>, <a href="#package-defstar">defstar</a>
</li>
<li>Used by:
<a href="#package-tcod.gui-demo">tcod.gui-demo</a>, <a href="#package-dormouse">dormouse</a>
</li>
</ul>
</div>
<div id="outline-container-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Introduction</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Welcome to CL-TCOD, an interface between Common Lisp and the Doryen Library,
AKA `libtcod', a portable truecolour console library intended for use with
roguelike games.
</p>
<p>
CL-TCOD consists of the following files:
</p><ol>
<li><code>tcod.lisp</code>, a lisp file which creates lisp bindings for C functions in the
compiled libtcod library, using the <code>CFFI</code> lisp foreign function interface.
</li>
<li><code>tcod.asd</code>, which allows TCOD to be easily loaded and used as a library by
other common lisp programs, via the <code>ASDF</code> library-loading facility.
</li>
<li><code>tcod-colours.lisp</code>, a lisp file containing definitions for all the colours
named in /etc/X11/rgb.txt; autogenerated using 'parse-rgb' (see below)
</li>
<li><code>parse-rgb.lisp</code>, a lisp file containing code for parsing <code>/etc/X11/rgb.txt</code>
and generating tcod-colours.lisp
</li>
<li><code>parse-rgb.asd</code>, ASDF system definition file for <code>parse-rgb.lisp</code>
</li>
</ol>
<p>
CL-TCOD has been tested with SBCL 1.0.36 on Linux and Windows, Clozure 1.5
on Linux and Windows, and CLISP on Windows.
</p>
<p>
**Note** that it has not been used on a Mac; if you do this you may need to
tell CFFI the name of the compiled libtcod library under MacOS. To do this,
open <code>tcod.lisp</code> in an editor, find the ='(define-foreign-library…'= clause,
uncomment the ='(:macintosh…)'= line and change the string on that line to
the name of the libtcod library file.
</p>
</div>
</div>
<div id="outline-container-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> License</h3>
<div class="outline-text-3" id="text-1-2">
<p>
The CL-TCOD package is placed in the Public Domain by its author.
</p>
</div>
</div>
<div id="outline-container-1-3" class="outline-3">
<h3 id="sec-1-3"><span class="section-number-3">1.3</span> Dependencies</h3>
<div class="outline-text-3" id="text-1-3">
<p>
<code>CL-TCOD</code> depends on the following libraries:
</p><ol>
<li>ASDF: <a href="http://common-lisp.net/project/asdf/">http://common-lisp.net/project/asdf/</a>
</li>
<li>DEFSTAR: <a href="http://bitbucket.org/eeeickythump/defstar/">http://bitbucket.org/eeeickythump/defstar/</a>
</li>
<li>CFFI: <a href="http://common-lisp.net/project/cffi/">http://common-lisp.net/project/cffi/</a>
</li>
</ol>
</div>
</div>
<div id="outline-container-1-4" class="outline-3">
<h3 id="sec-1-4"><span class="section-number-3">1.4</span> Hints on installation</h3>
<div class="outline-text-3" id="text-1-4">
<p>
You need to know your way around your chosen common lisp and how to install and
load lisp libraries before proceeding. You also need to have a version of
libtcod newer than 1.4.1rc2, which is the first version that includes the
='wrappers.c'= and ='wrappers.h'= source files that allow CL-TCOD to interface
with libtcod.
</p>
<ol>
<li>Ensure you have a working common lisp installation.
</li>
<li>Ensure either <a href="http://www.quicklisp.org/">Quicklisp</a> or the ASDF lisp
library is installed.
</li>
<li>If CFFI or DEFSTAR are not installed, download and install them somewhere
ASDF can find them. CFFI requires several third-party lisp libraries – see
the CFFI documentation for more details. Note that if you have
Quicklisp installed, you can install CFFI and its dependencies
easily using the command <code>(ql:quickload "cffi")</code> at the Lisp prompt.
</li>
<li>Put the CL-TCOD files in a directory where ASDF can find them.
</li>
<li>Make sure libtcod is installed and compiled. Make sure the libtcod
dynamically linked library (<code>.DLL</code> or <code>.SO</code> file) is somewhere your lisp
system can find it. It probably is, but if CFFI complains about being unable
to find the library, you can either copy it to an appropriate directory or
add its directory to the list variable <code>cffi:*foreign-library-directories*</code>
e.g. by typing the following in the lisp interpreter:
</li>
</ol>
<pre class="example">(push #P"/my/libtcod/directory/" cffi:*foreign-library-directories*)
</pre>
<p>
<b>On windows</b>, DLL files should be put in one of the directories listed in the
<code>PATH</code> environment variable. You will need to put <code>SDL.dll</code> in the same place
if you don't already have SDL installed.
</p>
<p>
<b>On Linux</b>, you can usually put .SO files in <code>/usr/local/lib/</code>.
Use your package installer to install <code>libSDL</code>.
Try running the libtcod demo programs to check everything works.
</p>
<ol>
<li>Start lisp, then load CL-TCOD. Using Quicklisp:
</li>
</ol>
<pre class="example">(ql:quickload :tcod)
</pre>
<p>
Using ASDF:
</p>
<pre class="example">(load "/path/to/asdf/asdf.lisp")
(asdf:oos 'asdf:load-op :tcod)
</pre>
<ol>
<li>Type something like the following commands at the lisp prompt to start using
TCOD from within Lisp. Alternatively you can type <code>(tcod:hello-world)</code>, which
is a function containing the code below.
</li>
</ol>
<pre class="example">(tcod:console-set-custom-font "terminal.png" '(:font-layout-ascii-in-row) 16 16)
(tcod:console-init-root 80 25 "Test" nil :renderer-sdl)
(tcod:console-clear tcod:*root*)
(tcod:console-print tcod:*root* 1 1 "Hello, world!~%")
(tcod:console-wait-for-keypress t)
</pre>
</div>
</div>
<div id="outline-container-1-5" class="outline-3">
<h3 id="sec-1-5"><span class="section-number-3">1.5</span> Differences between CL-TCOD and libtcod</h3>
<div class="outline-text-3" id="text-1-5">
</div>
<div id="outline-container-1-5-1" class="outline-4">
<h4 id="sec-1-5-1"><span class="section-number-4">1.5.1</span> Naming conventions</h4>
<div class="outline-text-4" id="text-1-5-1">
<p>
The C function <code>TCOD_foobar</code> corresponds to the lisp function <code>foobar</code>, which
is in the <code>tcod</code> package (and so requires a prefix of <code>tcod:</code> to access in most
situations). Underscores become hyphens. So:
</p>
<pre class="example">
TCOD_foobar_function(a, b) <===> (tcod:foobar-function a b)
</pre>
<p>
`Predicate functions' are functions whose main job is to return a boolean
value, true (non <code>NIL</code>) or false (<code>NIL</code>), that answers a question. These have a
terminal '?' added to their name:
</p>
<pre class="example">
TCOD_console_is_fullscreen() <===> (tcod:console-is-fullscreen?)
</pre>
<p>
C enums have generally more succinct names. As they are lisp keywords, their
names all begin with =':'=. THey are named according to the following pattern:
</p>
<pre class="example">
TCODK_BACKSPACE (etc) <===> :backspace
TCOD_CHAR_HLINE (etc) <===> :char-hline
TCOD_COLCTRL_1 (etc) <===> :colctrl-1
TCOD_BKGND_SET (etc) <===> :set
TCOD_FONT_LAYOUT_ASCII_INCOL <===> :font-layout-ascii-in-col
FOV_SHADOW <===> :fov-shadow
TCOD_KEY_PRESSED <===> :key-pressed
CENTER <===> :center
</pre>
<p>
In general, most functions exist in both U.S. and non-U.S. spellings, This is
mainly relevant to those functions with colour/color or centre/center in their
names.
</p>
</div>
</div>
<div id="outline-container-1-5-2" class="outline-4">
<h4 id="sec-1-5-2"><span class="section-number-4">1.5.2</span> Colournums</h4>
<div class="outline-text-4" id="text-1-5-2">
<p>
In libtcod, colours are represented as structures containing three integer
values: <b>red</b>, <b>green</b> and <b>blue</b> (each 0-255). The name of the structure type is
<code>TCOD_color_t</code>.
</p>
<p>
In CL-TCOD, these colour structs are converted into 3-byte integers using the C
functions <code>int_to_color(int)</code> and <code>color_to_int(TCOD_color_t)</code>, both defined in
<code>wrappers.c</code>. The 3 bytes are red, green and blue in order (blue is 1's). ie:
</p>
<pre class="example">
/* C */ ;; lisp ;;
struct TCOD_color_t {r, g, b} <==> #x00RRGGBB
</pre>
<p>
So, for example, one way to use the function <code>TCOD_color_multiply_scalar</code> from
lisp is:
</p>
<pre class="example">(tcod:color-multiply-scalar (tcod:compose-colour 218 165 32) 0.5)
</pre>
<p>
All C functions that take or return <code>TCOD_color_t</code> structs, are wrapped by lisp
functions that take or return integers as described above.
</p>
</div>
</div>
<div id="outline-container-1-5-3" class="outline-4">
<h4 id="sec-1-5-3"><span class="section-number-4">1.5.3</span> Colours by keyword</h4>
<div class="outline-text-4" id="text-1-5-3">
<p>
A lisp keyword is any symbol beginning with ':'. In lisp, keywords (like all
symbols) are first-class values and can be passed around just like any other
value. CL-TCOD uses keywords to refer to particular colours, for example the
keyword <code>:cyan</code> refers to the colour #x0056A3CD (or 5678029 in decimal notation).
</p>
<p>
You can use keywords instead of colournums as arguments to lisp functions, by
using the function <code>colour</code> to return the colournum associated with a keyword:
</p>
<pre class="example">(tcod:colour :cyan) ; returns 5678029
</pre>
<p>
You can also define your own colour names, like so:
</p>
<pre class="example">(tcod:make-colour :my-goldenrod 218 165 32)
(tcod:color-multiply-scalar (tcod:colour :my-goldenrod) 0.5)
</pre>
<p>
CL-TCOD knows all the colour names defined in the 'rgb.txt' file under
Xwindows, eg <code>:navajo-white, :honeydew, :mint-cream</code>, and so on. There is
nothing special about the fact that rgb.txt comes from Xwindows – the colours
are just named R,G,B values and can be used anywhere that CL-TCOD can be
used. Look in the source file ='tcod-colours.lisp'= to see the available colour
names. If you are using <a href="http://www.gnu.org/software/emacs/">GNU Emacs</a>, the
king of lisp IDEs, do <code>M-x list-colors-display</code> to see a list of all colours.
</p>
</div>
</div>
<div id="outline-container-1-5-4" class="outline-4">
<h4 id="sec-1-5-4"><span class="section-number-4">1.5.4</span> Lisp <code>format</code> versus C <code>printf</code></h4>
<div class="outline-text-4" id="text-1-5-4">
<p>
The TCOD functions that accept <code>printf</code>-like string-formatting arguments,
have been modified to instead accept arguments to Common Lisp's <code>format</code>
function.' For example:
</p>
<pre class="example">TCOD_console_print (con, x, y, "Printing at %d, %dn", x, y);
</pre>
<p>
becomes:
</p>
<pre class="example">(tcod:console-print con x y "Printing at ~D, ~D~%" x y)
</pre>
</div>
</div>
<div id="outline-container-1-5-5" class="outline-4">
<h4 id="sec-1-5-5"><span class="section-number-4">1.5.5</span> Miscellaneous extra functions</h4>
<div class="outline-text-4" id="text-1-5-5">
<ul>
<li><a href="#console-print-double-frame">console-print-double-frame</a> is like <a href="#console-print-frame">console-print-frame</a>, but
but draws using `double-line' characters:
</li>
</ul>
<pre class="example">(tcod:console-print-double-frame CONSOLE X Y W H EMPTY? STRING...)
</pre>
</div>
</div>
<div id="outline-container-1-5-6" class="outline-4">
<h4 id="sec-1-5-6"><span class="section-number-4">1.5.6</span> Coverage</h4>
<div class="outline-text-4" id="text-1-5-6">
<p>
Does not provide wrappers for:
</p><ul>
<li>File parser. Using this from lisp would be a very cumbersome way to read
values from a file, as the resulting values are not lisp objects. You would
be better to either consider using the lisp
`read' function, or looking into lisp libraries for parser generation.
</li>
<li><code>namegen-get-sets</code> – I haven't yet implemented this as it will have to
involve converting from libtcod's bespoke 'linked list' to a lisp list.
You may be better to write your random name generator in lisp (fairly trivial).
</li>
<li><code>sys-get-directory-content</code>, <code>sys-file-exists</code>, <code>sys-is-directory</code>,
<code>sys-delete-file</code>: Common Lisp already has functions that do the same thing.
</li>
</ul>
</div>
</div>
</div>
<div id="outline-container-1-6" class="outline-3">
<h3 id="sec-1-6"><span class="section-number-3">1.6</span> Resources</h3>
<div class="outline-text-3" id="text-1-6">
</div>
<div id="outline-container-1-6-1" class="outline-4">
<h4 id="sec-1-6-1"><span class="section-number-4">1.6.1</span> Specific to CL-TCOD and libtcod</h4>
<div class="outline-text-4" id="text-1-6-1">
<p>
The latest version of CL-TCOD is available at:
</p>
<p>
<a href="http://bitbucket.org/eeeickythump/cl-tcod/">http://bitbucket.org/eeeickythump/cl-tcod/</a>
</p>
<p>
Forum for discussion of CL-TCOD and use of lisp in roguelike games:
</p>
<p>
<a href="http://doryen.eptalys.net/forum/index.php?board=33.0">Roguecentral Lisp forum</a>
</p>
<p>
The latest version of libtcod is available at: