/
mapper.lua
1505 lines (1175 loc) · 50.4 KB
/
mapper.lua
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
-- mapper.lua
--[[
Author: Nick Gammon
Date: 11th March 2010
Amended: 15th August 2010
Amended: 2nd October 2010
Amended: 18th October 2010 to added find callback
Generic MUD mapper.
Exposed functions:
init (t) -- call once, supply:
t.config -- ie. colours, sizes
t.get_room -- info about room (uid)
t.show_help -- function that displays some help
t.room_click -- function that handles RH click on room (uid, flags)
t.timing -- true to show timing
t.show_completed -- true to show "Speedwalk completed."
t.show_other_areas -- true to show non-current areas
t.show_up_down -- follow up/down exits
t.show_area_exits -- true to draw a circle around rooms leading to other areas
t.speedwalk_prefix -- if not nil, speedwalk by prefixing with this
zoom_in () -- zoom in map view
zoom_out () -- zoom out map view
mapprint (message) -- like print, but uses mapper colour
maperror (message) -- like print, but prints in red
hide () -- hides map window (eg. if plugin disabled)
show () -- show map window (eg. if plugin enabled)
save_state () -- call to save plugin state (ie. in OnPluginSaveState)
draw (uid) -- draw map - starting at room 'uid'
start_speedwalk (path) -- starts speedwalking. path is a table of directions/uids
build_speedwalk (path) -- builds a client speedwalk string from path
cancel_speedwalk () -- cancel current speedwalk, if any
check_we_can_find () -- returns true if doing a find is OK right now
find (f, show_uid, count, walk) -- generic room finder
find_paths (uid, f) -- lower-level room finder (for getting back a path)
Exposed variables:
win -- the window (in case you want to put up menus)
VERSION -- mapper version
last_hyperlink_uid -- room uid of last hyperlink click (destination)
last_speedwalk_uid -- room uid of last speedwalk attempted (destination)
<various functions> -- functions required to be global by the client (eg. for mouseup)
Room info should include:
name (what to show as room name)
exits (table keyed by direction, value is exit uid)
area (area name)
hovermessage (what to show when you mouse-over the room)
bordercolour (colour of room border) - RGB colour
borderpen (pen style of room border) - see WindowCircleOp (values 0 to 6)
borderpenwidth(pen width of room border) - eg. 1 for normal, 2 for current room
fillcolour (colour to fill room) - RGB colour, nil for default
fillbrush (brush to fill room) - see WindowCircleOp (values 0 to 12)
--]]
module (..., package.seeall)
VERSION = 2.2 -- for querying by plugins
require "movewindow"
require "copytable"
require "gauge"
require "pairsbykeys"
require "mw"
local FONT_ID = "fn" -- internal font identifier
local FONT_ID_UL = "fnu" -- internal font identifier - underlined
-- size of room box
local ROOM_SIZE = 10
-- how far away to draw rooms from each other
local DISTANCE_TO_NEXT_ROOM = 15
-- supplied in init
local config -- configuration table
local supplied_get_room
local room_click
local timing -- true to show timing and other info
local show_completed -- true to show "Speedwalk completed."
local show_other_areas -- true to draw other areas
local show_area_exits -- true to show area exits
local show_up_down -- true to show up/down exits
-- current room number
local current_room
-- our copy of rooms info
local rooms = {}
local last_visited = {}
-- other locals
local HALF_ROOM, connectors, half_connectors, arrows
local plan_to_draw, speedwalks, drawn, drawn_coords
local last_drawn, depth, windowinfo, font_height
local walk_to_room_name
local function build_room_info ()
HALF_ROOM = ROOM_SIZE / 2
local THIRD_WAY = DISTANCE_TO_NEXT_ROOM / 3
local DISTANCE_LESS1 = DISTANCE_TO_NEXT_ROOM - 1
-- how to draw a line from this room to the next one (relative to the center of the room)
connectors = {
n = { x1 = 0, y1 = - HALF_ROOM, x2 = 0, y2 = - HALF_ROOM - DISTANCE_LESS1, at = { 0, -1 } },
s = { x1 = 0, y1 = HALF_ROOM, x2 = 0, y2 = HALF_ROOM + DISTANCE_LESS1, at = { 0, 1 } },
e = { x1 = HALF_ROOM, y1 = 0, x2 = HALF_ROOM + DISTANCE_LESS1, y2 = 0, at = { 1, 0 }},
w = { x1 = - HALF_ROOM, y1 = 0, x2 = - HALF_ROOM - DISTANCE_LESS1, y2 = 0, at = { -1, 0 }},
ne = { x1 = HALF_ROOM, y1 = - HALF_ROOM, x2 = HALF_ROOM + DISTANCE_LESS1 , y2 = - HALF_ROOM - DISTANCE_LESS1, at = { 1, -1 } },
se = { x1 = HALF_ROOM, y1 = HALF_ROOM, x2 = HALF_ROOM + DISTANCE_LESS1 , y2 = HALF_ROOM + DISTANCE_LESS1, at = { 1, 1 } },
nw = { x1 = - HALF_ROOM, y1 = - HALF_ROOM, x2 = - HALF_ROOM - DISTANCE_LESS1 , y2 = - HALF_ROOM - DISTANCE_LESS1, at = {-1, -1 } },
sw = { x1 = - HALF_ROOM, y1 = HALF_ROOM, x2 = - HALF_ROOM - DISTANCE_LESS1 , y2 = HALF_ROOM + DISTANCE_LESS1, at = {-1, 1 } },
} -- end connectors
-- how to draw a stub line
half_connectors = {
n = { x1 = 0, y1 = - HALF_ROOM, x2 = 0, y2 = - HALF_ROOM - THIRD_WAY, at = { 0, -1 } },
s = { x1 = 0, y1 = HALF_ROOM, x2 = 0, y2 = HALF_ROOM + THIRD_WAY, at = { 0, 1 } },
e = { x1 = HALF_ROOM, y1 = 0, x2 = HALF_ROOM + THIRD_WAY, y2 = 0, at = { 1, 0 }},
w = { x1 = - HALF_ROOM, y1 = 0, x2 = - HALF_ROOM - THIRD_WAY, y2 = 0, at = { -1, 0 }},
ne = { x1 = HALF_ROOM, y1 = - HALF_ROOM, x2 = HALF_ROOM + THIRD_WAY , y2 = - HALF_ROOM - THIRD_WAY, at = { 1, -1 } },
se = { x1 = HALF_ROOM, y1 = HALF_ROOM, x2 = HALF_ROOM + THIRD_WAY , y2 = HALF_ROOM + THIRD_WAY, at = { 1, 1 } },
nw = { x1 = - HALF_ROOM, y1 = - HALF_ROOM, x2 = - HALF_ROOM - THIRD_WAY , y2 = - HALF_ROOM - THIRD_WAY, at = {-1, -1 } },
sw = { x1 = - HALF_ROOM, y1 = HALF_ROOM, x2 = - HALF_ROOM - THIRD_WAY , y2 = HALF_ROOM + THIRD_WAY, at = {-1, 1 } },
} -- end half_connectors
-- how to draw one-way arrows (relative to the center of the room)
arrows = {
n = { - 2, - HALF_ROOM - 2, 2, - HALF_ROOM - 2, 0, - HALF_ROOM - 6 },
s = { - 2, HALF_ROOM + 2, 2, HALF_ROOM + 2, 0, HALF_ROOM + 6 },
e = { HALF_ROOM + 2, -2, HALF_ROOM + 2, 2, HALF_ROOM + 6, 0 },
w = { - HALF_ROOM - 2, -2, - HALF_ROOM - 2, 2, - HALF_ROOM - 6, 0 },
ne = { HALF_ROOM + 3, - HALF_ROOM, HALF_ROOM + 3, - HALF_ROOM - 3, HALF_ROOM, - HALF_ROOM - 3 },
se = { HALF_ROOM + 3, HALF_ROOM, HALF_ROOM + 3, HALF_ROOM + 3, HALF_ROOM, HALF_ROOM + 3 },
nw = { - HALF_ROOM - 3, - HALF_ROOM, - HALF_ROOM - 3, - HALF_ROOM - 3, - HALF_ROOM, - HALF_ROOM - 3 },
sw = { - HALF_ROOM - 3, HALF_ROOM, - HALF_ROOM - 3, HALF_ROOM + 3, - HALF_ROOM, HALF_ROOM + 3},
} -- end of arrows
end -- build_room_info
local default_config = {
-- assorted colours
BACKGROUND_COLOUR = { name = "Background", colour = ColourNameToRGB "lightseagreen", },
ROOM_COLOUR = { name = "Room", colour = ColourNameToRGB "cyan", },
EXIT_COLOUR = { name = "Exit", colour = ColourNameToRGB "darkgreen", },
EXIT_COLOUR_UP_DOWN = { name = "Exit up/down", colour = ColourNameToRGB "darkmagenta", },
EXIT_COLOUR_IN_OUT = { name = "Exit in/out", colour = ColourNameToRGB "#3775E8", },
UNKNOWN_ROOM_COLOUR = { name = "Unknown room", colour = ColourNameToRGB "#00CACA", },
MAPPER_NOTE_COLOUR = { name = "Messages", colour = ColourNameToRGB "lightgreen" },
ROOM_NAME_TEXT = { name = "Room name text", colour = ColourNameToRGB "#BEF3F1", },
ROOM_NAME_FILL = { name = "Room name fill", colour = ColourNameToRGB "#105653", },
ROOM_NAME_BORDER = { name = "Room name box", colour = ColourNameToRGB "black", },
AREA_NAME_TEXT = { name = "Area name text", colour = ColourNameToRGB "#BEF3F1",},
AREA_NAME_FILL = { name = "Area name fill", colour = ColourNameToRGB "#105653", },
AREA_NAME_BORDER = { name = "Area name box", colour = ColourNameToRGB "black", },
FONT = { name = get_preferred_font {"Dina", "Lucida Console", "Fixedsys", "Courier", "Sylfaen",} ,
size = 8
} ,
-- size of map window
WINDOW = { width = 400, height = 400 },
-- how far from where we are standing to draw (rooms)
SCAN = { depth = 30 },
-- speedwalk delay
DELAY = { time = 0.3 },
-- how many seconds to show "recent visit" lines (default 3 minutes)
LAST_VISIT_TIME = { time = 60 * 3 },
}
local expand_direction = {
n = "north",
s = "south",
e = "east",
w = "west",
u = "up",
d = "down",
ne = "northeast",
sw = "southwest",
nw = "northwest",
se = "southeast",
['in'] = "in",
out = "out",
} -- end of expand_direction
local function get_room (uid)
local room = supplied_get_room (uid)
room = room or { unknown = true }
-- defaults in case they didn't supply them ...
room.name = room.name or string.format ("Room %s", uid)
room.name = mw.strip_colours (room.name) -- no colour codes for now
room.exits = room.exits or {}
room.area = room.area or "<No area>"
room.hovermessage = room.hovermessage or "<Unexplored room>"
room.bordercolour = room.bordercolour or config.ROOM_COLOUR.colour
room.borderpen = room.borderpen or 0 -- solid
room.borderpenwidth = room.borderpenwidth or 1
room.fillcolour = room.fillcolour or 0x000000
room.fillbrush = room.fillbrush or 1 -- no fill
return room
end -- get_room
local function check_connected ()
if not IsConnected() then
mapprint ("You are not connected to", WorldName())
return false
end -- if not connected
return true
end -- check_connected
local function make_number_checker (title, min, max, decimals)
return function (s)
local n = tonumber (s)
if not n then
utils.msgbox (title .. " must be a number", "Incorrect input", "ok", "!", 1)
return false -- bad input
end -- if
if n < min or n > max then
utils.msgbox (title .. " must be in range " .. min .. " to " .. max, "Incorrect input", "ok", "!", 1)
return false -- bad input
end -- if
if not decimals then
if string.match (s, "%.") then
utils.msgbox (title .. " cannot have decimal places", "Incorrect input", "ok", "!", 1)
return false -- bad input
end -- if
end -- no decimals
return true -- good input
end -- generated function
end -- make_number_checker
local function get_number_from_user (msg, title, current, min, max, decimals)
local max_length = math.ceil (math.log10 (max) + 1)
-- if decimals allowed, allow room for them
if decimals then
max_length = max_length + 2 -- allow for 0.x
end -- if
-- if can be negative, allow for minus sign
if min < 0 then
max_length = max_length + 1
end -- if can be negative
return tonumber (utils.inputbox (msg, title, current, nil, nil,
{ validate = make_number_checker (title, min, max, decimals),
prompt_height = 14,
box_height = 130,
box_width = 300,
reply_width = 150,
max_length = max_length,
} -- end extra stuff
))
end -- get_number_from_user
local function draw_configuration ()
local width = max_text_width (win, FONT_ID, {"Configuration", "Font", "Width", "Height", "Depth"}, true)
local lines = 6 -- "Configuration", font, width, height, depth, delay
local GAP = 5
local suppress_colours = false
for k, v in pairs (config) do
if v.colour then
width = math.max (width, WindowTextWidth (win, FONT_ID, v.name, true))
lines = lines + 1
end -- a colour item
end -- for each config item
if (config.WINDOW.height - 13 - font_height * lines) < 10 then
suppress_colours = true
lines = 6 -- forget all the colours
end -- if
local x = 3
local y = config.WINDOW.height - 13 - font_height * lines
local box_size = font_height - 2
local rh_size = math.max (box_size, max_text_width (win, FONT_ID,
{config.FONT.name .. " " .. config.FONT.size,
tostring (config.WINDOW.width),
tostring (config.WINDOW.height),
tostring (config.SCAN.depth)},
true))
local frame_width = GAP + width + GAP + rh_size + GAP -- gap / text / gap / box / gap
-- fill entire box with grey
WindowRectOp (win, 2, x, y, x + frame_width, y + font_height * lines + 10, 0xDCDCDC)
-- frame it
draw_3d_box (win, x, y, frame_width, font_height * lines + 10)
y = y + GAP
x = x + GAP
-- title
WindowText (win, FONT_ID, "Configuration", x, y, 0, 0, 0x808080, true)
-- close box
WindowRectOp (win, 1, x + frame_width - box_size - GAP * 2, y + 1,
x + frame_width - GAP * 2, y + 1 + box_size, 0x808080)
WindowLine (win, x + frame_width - box_size - GAP * 2 + 3, y + 4,
x + frame_width - GAP * 2 - 3, y - 2 + box_size, 0x808080, 0, 1)
WindowLine (win, x - 4 + frame_width - GAP * 2, y + 4,
x - 1 + frame_width - box_size - GAP * 2 + 3, y - 2 + box_size, 0x808080, 0, 1)
-- close configuration hotspot
WindowAddHotspot(win, "$<close_configure>",
x + frame_width - box_size - GAP * 2, y + 1, x + frame_width - GAP * 2, y + 1 + box_size, -- rectangle
"", "", "", "", "mapper.mouseup_close_configure", -- mouseup
"Click to close",
1, 0) -- hand cursor
y = y + font_height
if not suppress_colours then
for k, v in pairsByKeys (config) do
if v.colour then
WindowText (win, FONT_ID, v.name, x, y, 0, 0, 0x000000, true)
WindowRectOp (win, 2, x + width + rh_size / 2, y + 1, x + width + rh_size / 2 + box_size, y + 1 + box_size, v.colour)
WindowRectOp (win, 1, x + width + rh_size / 2, y + 1, x + width + rh_size / 2 + box_size, y + 1 + box_size, 0x000000)
-- colour change hotspot
WindowAddHotspot(win, "$colour:" .. k,
x + GAP, y + 1, x + width + rh_size / 2 + box_size, y + 1 + box_size, -- rectangle
"", "", "", "", "mapper.mouseup_change_colour", -- mouseup
"Click to change colour",
1, 0) -- hand cursor
y = y + font_height
end -- a colour item
end -- for each config item
end -- if
-- depth
WindowText (win, FONT_ID, "Depth", x, y, 0, 0, 0x000000, true)
WindowText (win, FONT_ID_UL, tostring (config.SCAN.depth), x + width + GAP, y, 0, 0, 0x808080, true)
-- depth hotspot
WindowAddHotspot(win, "$<depth>",
x + GAP, y, x + frame_width, y + font_height, -- rectangle
"", "", "", "", "mapper.mouseup_change_depth", -- mouseup
"Click to change scan depth",
1, 0) -- hand cursor
y = y + font_height
-- font
WindowText (win, FONT_ID, "Font", x, y, 0, 0, 0x000000, true)
WindowText (win, FONT_ID_UL, config.FONT.name .. " " .. config.FONT.size, x + width + GAP, y, 0, 0, 0x808080, true)
-- colour font hotspot
WindowAddHotspot(win, "$<font>",
x + GAP, y, x + frame_width, y + font_height, -- rectangle
"", "", "", "", "mapper.mouseup_change_font", -- mouseup
"Click to change font",
1, 0) -- hand cursor
y = y + font_height
-- width
WindowText (win, FONT_ID, "Width", x, y, 0, 0, 0x000000, true)
WindowText (win, FONT_ID_UL, tostring (config.WINDOW.width), x + width + GAP, y, 0, 0, 0x808080, true)
-- width hotspot
WindowAddHotspot(win, "$<width>",
x + GAP, y, x + frame_width, y + font_height, -- rectangle
"", "", "", "", "mapper.mouseup_change_width", -- mouseup
"Click to change window width",
1, 0) -- hand cursor
y = y + font_height
-- height
WindowText (win, FONT_ID, "Height", x, y, 0, 0, 0x000000, true)
WindowText (win, FONT_ID_UL, tostring (config.WINDOW.height), x + width + GAP, y, 0, 0, 0x808080, true)
-- height hotspot
WindowAddHotspot(win, "$<height>",
x + GAP, y, x + frame_width, y + font_height, -- rectangle
"", "", "", "", "mapper.mouseup_change_height", -- mouseup
"Click to change window height",
1, 0) -- hand cursor
y = y + font_height
-- delay
WindowText (win, FONT_ID, "Walk delay", x, y, 0, 0, 0x000000, true)
WindowText (win, FONT_ID_UL, tostring (config.DELAY.time), x + width + GAP, y, 0, 0, 0x808080, true)
-- height hotspot
WindowAddHotspot(win, "$<delay>",
x + GAP, y, x + frame_width, y + font_height, -- rectangle
"", "", "", "", "mapper.mouseup_change_delay", -- mouseup
"Click to change speedwalk delay",
1, 0) -- hand cursor
y = y + font_height
end -- draw_configuration
-- for calculating one-way paths
local inverse_direction = {
n = "s",
s = "n",
e = "w",
w = "e",
u = "d",
d = "u",
ne = "sw",
sw = "ne",
nw = "se",
se = "nw",
['in'] = "out",
out = "in",
} -- end of inverse_direction
local function add_another_room (uid, path, x, y)
local path = path or {}
return {uid=uid, path=path, x = x, y = y}
end -- add_another_room
local function draw_room (uid, path, x, y)
local coords = string.format ("%i,%i", math.floor (x), math.floor (y))
-- need this for the *current* room !!!
drawn_coords [coords] = uid
-- print ("drawing", uid, "at", coords)
if drawn [uid] then
return
end -- done this one
-- don't draw the same room more than once
drawn [uid] = { coords = coords, path = path }
local room = rooms [uid]
-- not cached - get from caller
if not room then
room = get_room (uid)
rooms [uid] = room
end -- not in cache
local left, top, right, bottom = x - HALF_ROOM, y - HALF_ROOM, x + HALF_ROOM, y + HALF_ROOM
-- forget it if off screen
if x < HALF_ROOM or y < HALF_ROOM or
x > config.WINDOW.width - HALF_ROOM or y > config.WINDOW.height - HALF_ROOM then
return
end -- if
-- exits
local texits = {}
for dir, exit_uid in pairs (room.exits) do
table.insert (texits, dir)
local exit_info = connectors [dir]
local stub_exit_info = half_connectors [dir]
local exit_line_colour = config.EXIT_COLOUR.colour
local arrow = arrows [dir]
-- draw up in the ne/nw position if not already an exit there at this level
if dir == "u" then
if not room.exits.nw then
exit_info = connectors.nw
stub_exit_info = half_connectors.nw
arrow = arrows.nw
exit_line_colour = config.EXIT_COLOUR_UP_DOWN.colour
end -- if available
elseif dir == "in" then
if not room.exits.ne then
exit_info = connectors.ne
stub_exit_info = half_connectors.ne
arrow = arrows.ne
exit_line_colour = config.EXIT_COLOUR_IN_OUT.colour
end -- if
elseif dir == "d" then
if not room.exits.se then
exit_info = connectors.se
stub_exit_info = half_connectors.se
arrow = arrows.se
exit_line_colour = config.EXIT_COLOUR_UP_DOWN.colour
end -- if available
elseif dir == "out" then
if not room.exits.sw then
exit_info = connectors.sw
stub_exit_info = half_connectors.sw
arrow = arrows.sw
exit_line_colour = config.EXIT_COLOUR_IN_OUT.colour
end -- if
end -- if down
if exit_info then
local linetype = 0 -- unbroken
local linewidth = 1 -- not recent
-- try to cache room
if not rooms [exit_uid] then
rooms [exit_uid] = get_room (exit_uid)
end -- if
if rooms [exit_uid].unknown then
linetype = 2 -- dots
end -- if
local next_x = x + exit_info.at [1] * (ROOM_SIZE + DISTANCE_TO_NEXT_ROOM)
local next_y = y + exit_info.at [2] * (ROOM_SIZE + DISTANCE_TO_NEXT_ROOM)
local next_coords = string.format ("%i,%i", math.floor (next_x), math.floor (next_y))
-- remember if a zone exit (first one only)
if show_area_exits and room.area ~= rooms [exit_uid].area then
area_exits [ rooms [exit_uid].area ] = area_exits [ rooms [exit_uid].area ] or {x = x, y = y}
end -- if
-- if another room (not where this one leads to) is already there, only draw "stub" lines
if drawn_coords [next_coords] and drawn_coords [next_coords] ~= exit_uid then
exit_info = stub_exit_info
elseif exit_uid == uid then
-- here if room leads back to itself
exit_info = stub_exit_info
linetype = 1 -- dash
else
if (not show_other_areas and rooms [exit_uid].area ~= current_area) or
(not show_up_down and (dir == "u" or dir == "d")) then
exit_info = stub_exit_info -- don't show other areas
else
-- if we are scheduled to draw the room already, only draw a stub this time
if plan_to_draw [exit_uid] and plan_to_draw [exit_uid] ~= next_coords then
-- here if room already going to be drawn
exit_info = stub_exit_info
linetype = 1 -- dash
else
-- remember to draw room next iteration
local new_path = copytable.deep (path)
table.insert (new_path, { dir = dir, uid = exit_uid })
table.insert (rooms_to_be_drawn, add_another_room (exit_uid, new_path, next_x, next_y))
drawn_coords [next_coords] = exit_uid
plan_to_draw [exit_uid] = next_coords
-- if exit room known
if not rooms [exit_uid].unknown then
local exit_time = last_visited [exit_uid] or 0
local this_time = last_visited [uid] or 0
local now = os.time ()
if exit_time > (now - config.LAST_VISIT_TIME.time) and
this_time > (now - config.LAST_VISIT_TIME.time) then
linewidth = 2
end -- if
end -- if
end -- if
end -- f
end -- if drawn on this spot
WindowLine (win, x + exit_info.x1, y + exit_info.y1, x + exit_info.x2, y + exit_info.y2, exit_line_colour, linetype, linewidth)
-- one-way exit?
if not rooms [exit_uid].unknown then
local dest = rooms [exit_uid]
-- if inverse direction doesn't point back to us, this is one-way
if dest.exits [inverse_direction [dir]] ~= uid then
-- turn points into string, relative to where the room is
local points = string.format ("%i,%i,%i,%i,%i,%i",
x + arrow [1],
y + arrow [2],
x + arrow [3],
y + arrow [4],
x + arrow [5],
y + arrow [6])
-- draw arrow
WindowPolygon(win, points, exit_line_colour, 0, 1, exit_line_colour, 0, true, true)
end -- one way
end -- if we know of the room where it does
end -- if we know what to do with this direction
end -- for each exit
if room.unknown then
WindowCircleOp (win, 2, left, top, right, bottom,
config.UNKNOWN_ROOM_COLOUR.colour, 2, 1, -- dotted single pixel pen
-1, 1) -- no brush
else
WindowCircleOp (win, 2, left, top, right, bottom,
0, 5, 0, -- no pen
room.fillcolour, room.fillbrush) -- brush
WindowCircleOp (win, 2, left, top, right, bottom,
room.bordercolour, room.borderpen, room.borderpenwidth, -- pen
-1, 1) -- no brush
end -- if
-- show up and down in case we can't get a line in
if room.exits.u then -- line at top
WindowLine (win, left, top, left + ROOM_SIZE, top, config.EXIT_COLOUR_UP_DOWN.colour, 0, 1)
end -- if
if room.exits.d then -- line at bottom
WindowLine (win, left, bottom, left + ROOM_SIZE, bottom, config.EXIT_COLOUR_UP_DOWN.colour, 0, 1)
end -- if
if room.exits ['in'] then -- line at right
WindowLine (win, left + ROOM_SIZE, top, left + ROOM_SIZE, bottom, config.EXIT_COLOUR_IN_OUT.colour, 0, 1)
end -- if
if room.exits.out then -- line at left
WindowLine (win, left, top, left, bottom, config.EXIT_COLOUR_IN_OUT.colour, 0, 1)
end -- if
speedwalks [uid] = path -- so we know how to get here
WindowAddHotspot(win, uid,
left, top, right, bottom, -- rectangle
"", -- mouseover
"", -- cancelmouseover
"", -- mousedown
"", -- cancelmousedown
"mapper.mouseup_room", -- mouseup
room.hovermessage,
1, 0) -- hand cursor
end -- draw_room
local function changed_room (uid)
hyperlink_paths = nil -- those hyperlinks are meaningless now
speedwalks = {} -- old speedwalks are irrelevant
if current_speedwalk then
if uid ~= expected_room then
local exp = rooms [expected_room]
if not exp then
exp = get_room (expected_room) or { name = expected_room }
end -- if
local here = rooms [uid]
if not here then
here = get_room (uid) or { name = uid }
end -- if
exp = expected_room
here = uid
maperror (string.format ("Speedwalk failed! Expected to be in '%s' but ended up in '%s'.", exp, here))
cancel_speedwalk ()
else
if #current_speedwalk > 0 then
local dir = table.remove (current_speedwalk, 1)
SetStatus ("Walking " .. (expand_direction [dir.dir] or dir.dir) ..
" to " .. walk_to_room_name ..
". Speedwalks to go: " .. #current_speedwalk + 1)
expected_room = dir.uid
if config.DELAY.time > 0 then
DoAfter (config.DELAY.time, dir.dir)
else
Send (dir.dir)
end -- if
else
last_hyperlink_uid = nil
last_speedwalk_uid = nil
if show_completed then
mapprint ("Speedwalk completed.")
end -- if wanted
cancel_speedwalk ()
end -- if any left
end -- if expected room or not
end -- if have a current speedwalk
end -- changed_room
local function draw_zone_exit (exit)
local x, y = exit.x, exit.y
local offset = ROOM_SIZE
-- draw circle around us
WindowCircleOp (win, 1,
x - offset, y - offset,
x + offset, y + offset,
ColourNameToRGB "cornflowerblue", -- pen colour
0, -- solid pen
3, -- pen width
0, -- brush colour
1 ) -- null brush
WindowCircleOp (win, 1,
x - offset, y - offset,
x + offset, y + offset,
ColourNameToRGB "cyan", -- pen colour
0, -- solid pen
1, -- pen width
0, -- brush colour
1 ) -- null brush
end -- draw_zone_exit
----------------------------------------------------------------------------------
-- EXPOSED FUNCTIONS
----------------------------------------------------------------------------------
-- can we find another room right now?
function check_we_can_find ()
if not check_connected () then
return
end -- if
if not current_room then
mapprint ("I don't know where you are right now - try: LOOK")
return false
end -- if
if current_speedwalk then
mapprint ("No point doing this while you are speedwalking.")
return false
end -- if
return true
end -- check_we_can_find
-- see: http://www.gammon.com.au/forum/?id=7306&page=2
-- Thanks to Ked.
-- uid is starting room
-- f returns true (or a "reason" string) if we want to store this one, and true,true if
-- we have done searching (ie. all wanted rooms found)
function find_paths (uid, f)
local function make_particle (curr_loc, prev_path)
local prev_path = prev_path or {}
return {current_room=curr_loc, path=prev_path}
end
local depth = 0
local count = 0
local done = false
local found, reason
local explored_rooms, particles = {}, {}
-- this is where we collect found paths
-- the table is keyed by destination, with paths as values
local paths = {}
-- create particle for the initial room
table.insert (particles, make_particle (uid))
while (not done) and #particles > 0 and depth < config.SCAN.depth do
-- create a new generation of particles
new_generation = {}
depth = depth + 1
SetStatus (string.format ("Scanning: %i/%i depth (%i rooms)", depth, config.SCAN.depth, count))
-- process each active particle
for i, part in ipairs (particles) do
count = count + 1
if not rooms [part.current_room] then
rooms [part.current_room] = get_room (part.current_room)
end -- if not in memory yet
-- if room doesn't exist, forget it
if rooms [part.current_room] then
-- get a list of exits from the current room
exits = rooms [part.current_room].exits
-- create one new particle for each exit
for dir, dest in pairs(exits) do
-- if we've been in this room before, drop it
if not explored_rooms[dest] then
explored_rooms[dest] = true
rooms [dest] = supplied_get_room (dest) -- make sure this room in table
if rooms [dest] then
new_path = copytable.deep (part.path)
table.insert(new_path, { dir = dir, uid = dest } )
-- if this room is in the list of destinations then save its path
found, done = f (dest)
if found then
paths[dest] = { path = new_path, reason = found }
end -- found one!
-- make a new particle in the new room
table.insert(new_generation, make_particle(dest, new_path))
end -- if room exists
end -- not explored this room
if done then
break
end
end -- for each exit
end -- if room exists
if done then
break
end
end -- for each particle
particles = new_generation
end -- while more particles
SetStatus "Ready"
return paths, count, depth
end -- function find_paths
-- draw our map starting at room: uid
function draw (uid)
if not uid then
maperror "Cannot draw map right now, I don't know where you are - try: LOOK"
return
end -- if
if current_room and current_room ~= uid then
changed_room (uid)
end -- if
current_room = uid -- remember where we are
-- timing
local start_time = GetInfo (232)
-- start with initial room
rooms = { [uid] = get_room (uid) }
-- lookup current room
local room = rooms [uid]
room = room or { name = "<Unknown room>", area = "<Unknown area>" }
last_visited [uid] = os.time ()
current_area = room.area
WindowCreate (win,
windowinfo.window_left,
windowinfo.window_top,
config.WINDOW.width,
config.WINDOW.height,
windowinfo.window_mode, -- top right
windowinfo.window_flags,
config.BACKGROUND_COLOUR.colour)
-- let them move it around
movewindow.add_drag_handler (win, 0, 0, 0, font_height)
-- set up for initial room, in middle
drawn, drawn_coords, rooms_to_be_drawn, speedwalks, plan_to_draw, area_exits = {}, {}, {}, {}, {}, {}
depth = 0
-- insert initial room
table.insert (rooms_to_be_drawn, add_another_room (uid, {}, config.WINDOW.width / 2, config.WINDOW.height / 2))
while #rooms_to_be_drawn > 0 and depth < config.SCAN.depth do
local old_generation = rooms_to_be_drawn
rooms_to_be_drawn = {} -- new generation
for i, part in ipairs (old_generation) do
draw_room (part.uid, part.path, part.x, part.y)
end -- for each existing room
depth = depth + 1
end -- while all rooms_to_be_drawn
for area, zone_exit in pairs (area_exits) do
draw_zone_exit (zone_exit)
end -- for
local room_name = room.name
local name_width = WindowTextWidth (win, FONT_ID, room_name, true)
local add_dots = false
-- truncate name if too long
while name_width > (config.WINDOW.width - 10) do
-- get rid of last word
local s = string.match (" " .. room_name .. "...", "(%s%S*)$")
if not s or #s == 0 then break end
room_name = room_name:sub (1, - (#s - 2)) -- except the last 3 dots but add the space
name_width = WindowTextWidth (win, FONT_ID, room_name .. " ...", true)
add_dots = true
end -- while
if add_dots then
room_name = room_name .. " ..."
end -- if
-- room name
draw_text_box (win, FONT_ID,
(config.WINDOW.width - WindowTextWidth (win, FONT_ID, room_name, true)) / 2, -- left
3, -- top
room_name, true, -- what to draw, utf8
config.ROOM_NAME_TEXT.colour, -- text colour
config.ROOM_NAME_FILL.colour, -- fill colour
config.ROOM_NAME_BORDER.colour) -- border colour
-- area name
local areaname = room.area
if areaname then
draw_text_box (win, FONT_ID,
(config.WINDOW.width - WindowTextWidth (win, FONT_ID, areaname, true)) / 2, -- left
config.WINDOW.height - 3 - font_height, -- top
areaname, true, -- what to draw, utf8
config.AREA_NAME_TEXT.colour, -- text colour
config.AREA_NAME_FILL.colour, -- fill colour
config.AREA_NAME_BORDER.colour) -- border colour
end -- if area known
-- configure?
if draw_configure_box then
draw_configuration ()
else
local x = 5
local y = config.WINDOW.height - 2 - font_height
local width = draw_text_box (win, FONT_ID,
x, -- left
config.WINDOW.height - 2 - font_height, -- top (ie. at bottom)
"*", true, -- what to draw, utf8
config.AREA_NAME_TEXT.colour, -- text colour
config.AREA_NAME_FILL.colour, -- fill colour
config.AREA_NAME_BORDER.colour) -- border colour
WindowAddHotspot(win, "<configure>",
x, y, x + width, y + font_height, -- rectangle
"", -- mouseover
"", -- cancelmouseover
"", -- mousedown
"", -- cancelmousedown
"mapper.mouseup_configure", -- mouseup
"Click to configure map",
1, 0) -- hand cursor
end -- if
if type (show_help) == "function" then
local x = config.WINDOW.width - WindowTextWidth (win, FONT_ID, "?", true) - 5
local y = config.WINDOW.height - 2 - font_height
local width = draw_text_box (win, FONT_ID,
x, -- left
config.WINDOW.height - 2 - font_height, -- top (ie. at bottom)
"?", true, -- what to draw, utf8
config.AREA_NAME_TEXT.colour, -- text colour
config.AREA_NAME_FILL.colour, -- fill colour
config.AREA_NAME_BORDER.colour) -- border colour
WindowAddHotspot(win, "<help>",
x, y, x + width, y + font_height, -- rectangle
"", -- mouseover
"", -- cancelmouseover
"", -- mousedown
"", -- cancelmousedown
"mapper.show_help", -- mouseup
"Click for help",
1, 0) -- hand cursor
end -- if
-- 3D box around whole thing
draw_3d_box (win, 0, 0, config.WINDOW.width, config.WINDOW.height)