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
|
doc = {}
doc.VERSION = {}
doc.VERSION.MAJOR = 0
doc.VERSION.MINOR = 4
doc.VERSION.PATCH = 0
doc.VERSION.STRING = doc.VERSION.MAJOR.."."..doc.VERSION.MINOR.."."..doc.VERSION.PATCH
doc.data = {}
doc.data.categories = {}
doc.data.category_order = {}
doc.data.players = {}
-- Space for additional APIs
doc.sub = {}
--[[ Core API functions ]]
-- Add a new category
function doc.new_category(id, def)
if doc.data.categories[id] == nil and id ~= nil then
doc.data.categories[id] = {}
doc.data.categories[id].entries = {}
doc.data.categories[id].entry_count = 0
doc.data.categories[id].def = def
doc.data.categories[id].entry_aliases = {}
table.insert(doc.data.category_order, id)
return true
else
return false
end
end
-- Add a new entry
function doc.new_entry(category_id, entry_id, def)
if doc.data.categories[category_id] ~= nil then
doc.data.categories[category_id].entries[entry_id] = def
doc.data.categories[category_id].entry_count = doc.data.categories[category_id].entry_count + 1
return true
else
return false
end
end
-- Marks a particular entry as viewed by a certain player, which also
-- automatically reveals it
function doc.mark_entry_as_viewed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id)
if doc.data.players[playername].stored_data.viewed[category_id] == nil then
doc.data.players[playername].stored_data.viewed[category_id] = {}
doc.data.players[playername].stored_data.viewed_count[category_id] = 0
end
if doc.entry_exists(category_id, entry_id) and doc.data.players[playername].stored_data.viewed[category_id][entry_id] ~= true then
doc.data.players[playername].stored_data.viewed[category_id][entry_id] = true
doc.data.players[playername].stored_data.viewed_count[category_id] = doc.data.players[playername].stored_data.viewed_count[category_id] + 1
-- Needed because viewed entries get a different color
doc.data.players[playername].entry_textlist_needs_updating = true
end
doc.mark_entry_as_revealed(playername, category_id, entry_id)
end
-- Marks a particular entry as revealed/unhidden by a certain player
function doc.mark_entry_as_revealed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id)
if doc.data.players[playername].stored_data.revealed[category_id] == nil then
doc.data.players[playername].stored_data.revealed[category_id] = {}
doc.data.players[playername].stored_data.revealed_count[category_id] = 0
end
if doc.entry_exists(category_id, entry_id) and doc.data.players[playername].stored_data.revealed[category_id][entry_id] ~= true then
doc.data.players[playername].stored_data.revealed[category_id][entry_id] = true
doc.data.players[playername].stored_data.revealed_count[category_id] = doc.data.players[playername].stored_data.revealed_count[category_id] + 1
-- Needed because a new entry is added to the list of visible entries
doc.data.players[playername].entry_textlist_needs_updating = true
end
end
-- Returns true if the specified entry has been viewed by the player
function doc.entry_viewed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id)
if doc.data.players[playername].stored_data.viewed[category_id] == nil then
return false
else
return doc.data.players[playername].stored_data.viewed[category_id][entry_id] == true
end
end
-- Returns true if the specified entry is hidden from the player
function doc.entry_revealed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id)
local hidden = doc.data.categories[category_id].entries[entry_id].hidden
if doc.data.players[playername].stored_data.revealed[category_id] == nil then
return not hidden
else
if hidden then
return doc.data.players[playername].stored_data.revealed[category_id][entry_id] == true
else
return true
end
end
end
-- Returns category definition
function doc.get_category_definition(category_id)
if doc.data.categories[category_id] == nil then
return nil
end
return doc.data.categories[category_id].def
end
-- Returns entry definition
function doc.get_entry_definition(category_id, entry_id)
if not doc.entry_exists(category_id, entry_id) then
return nil
end
local entry, _ = doc.get_entry(category_id, entry_id)
return entry
end
-- Opens the main documentation formspec for the player
function doc.show_doc(playername)
if doc.get_category_count() <= 0 then
minetest.show_formspec(playername, "doc:error_no_categories", doc.formspec_error_no_categories())
return
end
local formspec = doc.formspec_core()..doc.formspec_main()
minetest.show_formspec(playername, "doc:main", formspec)
end
-- Opens the documentation formspec for the player at the specified category
function doc.show_category(playername, category_id)
if doc.get_category_count() <= 0 then
minetest.show_formspec(playername, "doc:error_no_categories", doc.formspec_error_no_categories())
return
end
doc.data.players[playername].catsel = nil
doc.data.players[playername].category = category_id
doc.data.players[playername].entry = nil
local formspec = doc.formspec_core(2)..doc.formspec_category(category_id, playername)
minetest.show_formspec(playername, "doc:category", formspec)
end
-- Opens the documentation formspec for the player showing the specified entry in a category
function doc.show_entry(playername, category_id, entry_id, ignore_hidden)
if doc.get_category_count() <= 0 then
minetest.show_formspec(playername, "doc:error_no_categories", doc.formspec_error_no_categories())
return
end
local entry, entry_id = doc.get_entry(category_id, entry_id)
if ignore_hidden or doc.entry_revealed(playername, category_id, entry_id) then
local playerdata = doc.data.players[playername]
playerdata.category = category_id
playerdata.entry = entry_id
doc.mark_entry_as_viewed(playername, category_id, entry_id)
playerdata.entry_textlist_needs_updating = true
doc.generate_entry_list(category_id, playername)
playerdata.catsel = playerdata.catsel_list[entry_id]
local formspec = doc.formspec_core(3)..doc.formspec_entry(category_id, entry_id)
minetest.show_formspec(playername, "doc:entry", formspec)
else
minetest.show_formspec(playername, "doc:error_hidden", doc.formspec_error_hidden(category_id, entry_id))
end
end
-- Returns true if and only if:
-- * The specified category exists
-- * This category contains the specified entry
function doc.entry_exists(category_id, entry_id)
if doc.data.categories[category_id] ~= nil then
if doc.data.categories[category_id].entries[entry_id] ~= nil then
-- Entry exists
return true
else
-- Entry of this ID does not exist, so we check if there's an alis for it
return doc.data.categories[category_id].entry_aliases[entry_id] ~= nil
end
else
return false
end
end
-- Adds aliases for an entry. Attempting to open an entry by an alias name
-- results in opening the entry of the original name.
-- Aliases are true within one category only.
function doc.add_entry_aliases(category_id, entry_id, aliases)
for a=1,#aliases do
doc.data.categories[category_id].entry_aliases[aliases[a]] = entry_id
end
end
-- Same as above, but only adds one alias
function doc.add_entry_alias(category_id, entry_id, alias)
doc.data.categories[category_id].entry_aliases[alias] = entry_id
end
-- Returns number of categories
function doc.get_category_count()
return #doc.data.category_order
end
-- Returns number of entries in category
function doc.get_entry_count(category_id)
return doc.data.categories[category_id].entry_count
end
-- Returns how many entries have been viewed by the player
function doc.get_viewed_count(playername, category_id)
if doc.data.players[playername] == nil then
return nil
end
local count = doc.data.players[playername].stored_data.viewed_count[category_id]
if count == nil then
return 0
else
return count
end
end
-- Returns how many entries have been revealed by the player
function doc.get_revealed_count(playername, category_id)
if doc.data.players[playername] == nil then
return nil
end
local count = doc.data.players[playername].stored_data.revealed_count[category_id]
if count == nil then
return 0
else
return count
end
end
-- Template function templates, to be used for build_formspec in doc.new_category
doc.entry_builders = {}
-- Freeform text
doc.entry_builders.text = function(data)
return "textarea[0.25,0.5;12,10;;"..minetest.formspec_escape(data)..";]"
end
-- Direct formspec
doc.entry_builders.formspec = function(data)
return data
end
--[[ Internal stuff ]]
-- Loading and saving player data
do
local filepath = minetest.get_worldpath().."/doc.mt"
local file = io.open(filepath, "r")
if file then
minetest.log("action", "[doc] doc.mt opened.")
local string = file:read()
io.close(file)
if(string ~= nil) then
local savetable = minetest.deserialize(string)
for name, players_stored_data in pairs(savetable.players_stored_data) do
doc.data.players[name] = {}
doc.data.players[name].stored_data = players_stored_data
end
minetest.debug("[doc] doc.mt successfully read.")
end
end
end
function doc.save_to_file()
local savetable = {}
savetable.players_stored_data = {}
for name, playerdata in pairs(doc.data.players) do
savetable.players_stored_data[name] = playerdata.stored_data
end
local savestring = minetest.serialize(savetable)
local filepath = minetest.get_worldpath().."/doc.mt"
local file = io.open(filepath, "w")
if file then
file:write(savestring)
io.close(file)
minetest.log("action", "[doc] Wrote player data into "..filepath..".")
else
minetest.log("error", "[doc] Failed to write player data into "..filepath..".")
end
end
minetest.register_on_leaveplayer(function(player)
doc.save_to_file()
end)
minetest.register_on_shutdown(function()
minetest.log("action", "[doc] Server shuts down. Rescuing player data into doc.mt.")
doc.save_to_file()
end)
--[[ Functions for internal use ]]
function doc.formspec_core(tab)
if tab == nil then tab = 1 else tab = tostring(tab) end
return "size[12,9]tabheader[0,0;doc_header;Category list,Entry list,Entry;"..tab..";true;false]"
end
function doc.formspec_main()
local formstring = "label[0,0;This is the Documentation System, Version "..doc.VERSION.STRING..".\n"
if doc.get_category_count() >= 1 then
formstring = formstring .. "Please select a category you wish to learn more about:]"
local y = 1
for c=1,#doc.data.category_order do
local id = doc.data.category_order[c]
local data = doc.data.categories[id]
-- Category buton
local button = "button[0,"..y..";3,1;doc_button_category_"..id..";"..minetest.formspec_escape(data.def.name).."]"
local tooltip = ""
-- Optional description
if data.def.description ~= nil then
tooltip = "tooltip[doc_button_category_"..id..";"..minetest.formspec_escape(data.def.description).."]"
end
formstring = formstring .. button .. tooltip
y = y + 1
end
end
return formstring
end
function doc.formspec_error_no_categories()
local formstring = "size[8,6]textarea[0.25,0;8,6;;"
formstring = formstring .. minetest.formspec_escape(
[=[This is the Documentation System, Version ]=]..doc.VERSION.STRING..[=[.
ERROR: No help available.
No categories have been registered, but the Documentation System is useless without them.
The Documentation System does not come with help contents on its own, it needs additional mods to add help content.
Please make sure such mods are enabled on for this world, and try again.]=])
formstring = formstring .. ";]button_exit[3,5;2,1;okay;OK]"
return formstring
end
function doc.formspec_error_hidden(category_id, entry_id)
local formstring = "size[8,6]textarea[0.25,0;8,6;;"
formstring = formstring .. minetest.formspec_escape(
string.format([=[This is the Documentation System, Version %s.
ERROR: Access denied.
Sorry, access to the requested entry has been denied; this entry is secret. You may unlock access by more playing. Figure out on your own how to unlock this entry.]=],
doc.VERSION.STRING, doc.data.categories[category_id].def.name, doc.data.categories[category_id].entries[entry_id].name))
formstring = formstring .. ";]button_exit[3,5;2,1;okay;OK]"
return formstring
end
-- Returns the entry definition and true entry ID of an entry, taking aliases into account
function doc.get_entry(category_id, entry_id)
local category = doc.data.categories[category_id]
local entry = category.entries[entry_id]
local resolved_entry_id = entry_id
if entry == nil then
resolved_entry_id = doc.data.categories[category_id].entry_aliases[entry_id]
if resolved_entry_id ~= nil then
entry = category.entries[resolved_entry_id]
end
end
return entry, resolved_entry_id
end
function doc.generate_entry_list(cid, playername)
local formstring
if doc.data.players[playername].entry_textlist == nil
or doc.data.players[playername].catsel_list == nil
or doc.data.players[playername].category ~= cid
or doc.data.players[playername].entry_textlist_needs_updating == true then
local entry_textlist = "textlist[0,1;11,7;doc_catlist;"
local counter = 0
doc.data.players[playername].entry_ids = {}
local entries = doc.get_sorted_entry_names(cid)
doc.data.players[playername].catsel_list = {}
for i=1, #entries do
local eid = entries[i]
local edata = doc.data.categories[cid].entries[eid]
if doc.entry_revealed(playername, cid, eid) then
table.insert(doc.data.players[playername].entry_ids, eid)
doc.data.players[playername].catsel_list[eid] = counter + 1
-- Colorize entries based on viewed status
-- Not viewed: Cyan
local viewedprefix = "#00FFFF"
if doc.entry_viewed(playername, cid, eid) then
-- Viewed: White
viewedprefix = "#FFFFFF"
end
entry_textlist = entry_textlist .. viewedprefix .. minetest.formspec_escape(edata.name) .. ","
counter = counter + 1
end
end
if counter >= 1 then
entry_textlist = string.sub(entry_textlist, 1, #entry_textlist-1)
end
local catsel = doc.data.players[playername].catsel
if catsel then
entry_textlist = entry_textlist .. ";"..catsel
end
entry_textlist = entry_textlist .. "]"
doc.data.players[playername].entry_textlist = entry_textlist
formstring = entry_textlist
doc.data.players[playername].entry_textlist_needs_updating = false
else
formstring = doc.data.players[playername].entry_textlist
end
return formstring
end
function doc.get_sorted_entry_names(cid)
local sort_table = {}
local entry_table = {}
local cat = doc.data.categories[cid]
local used_eids = {}
-- Helper function to extract the entry ID out of the output table
local extract = function(entry_table)
local eids = {}
for k,v in pairs(entry_table) do
local eid = v.eid
table.insert(eids, eid)
end
return eids
end
-- Predefined sorting
if cat.def.sorting == "custom" then
for i=1,#cat.def.sorting_data do
local new_entry = table.copy(cat.entries[cat.def.sorting_data[i]])
new_entry.eid = cat.def.sorting_data[i]
table.insert(entry_table, new_entry)
used_eids[cat.def.sorting_data[i]] = true
end
end
for eid,entry in pairs(cat.entries) do
local new_entry = table.copy(entry)
new_entry.eid = eid
if not used_eids[eid] then
table.insert(entry_table, new_entry)
end
table.insert(sort_table, entry.name)
end
if cat.def.sorting == "custom" then
return extract(entry_table)
else
table.sort(sort_table)
end
local reverse_sort_table = table.copy(sort_table)
for i=1, #sort_table do
reverse_sort_table[sort_table[i]] = i
end
local comp
if cat.def.sorting ~= "nosort" then
-- Sorting by user function
if cat.def.sorting == "function" then
comp = cat.def.sorting_data
-- Alphabetic sorting
elseif cat.def.sorting == "abc" or cat.def.sorting == nil then
comp = function(e1, e2)
if reverse_sort_table[e1.name] < reverse_sort_table[e2.name] then return true else return false end
end
end
table.sort(entry_table, comp)
end
return extract(entry_table)
end
function doc.formspec_category(id, playername)
local formstring
if id == nil then
formstring = "label[0,0.5;You haven't chosen a category yet. Please choose one in the category list first.]"
formstring = formstring .. "button[0,1.5;3,1;doc_button_goto_main;Go to category list]"
else
formstring = "label[0,0;Help > "..doc.data.categories[id].def.name.."]"
if doc.get_entry_count(id) >= 1 then
formstring = formstring .. "label[0,0.5;This category has the following entries:]"
formstring = formstring .. doc.generate_entry_list(id, playername)
formstring = formstring .. "button[0,8;3,1;doc_button_goto_entry;Show entry]"
formstring = formstring .. "label[8,8;Number of entries: "..doc.get_entry_count(id).."\n"
formstring = formstring .. "New entries: "..(doc.get_entry_count(id)-doc.get_viewed_count(playername, id)).."]"
else
formstring = formstring .. "label[0,0.5;This category is empty.]"
formstring = formstring .. "button[0,1.5;3,1;doc_button_goto_main;Go to category list]"
end
end
return formstring
end
function doc.formspec_entry_navigation(category_id, entry_id)
if doc.get_entry_count(category_id) < 1 then
return ""
end
local formstring = ""
formstring = formstring .. "button[10,8.5;1,1;doc_button_goto_prev;<]"
formstring = formstring .. "button[11,8.5;1,1;doc_button_goto_next;>]"
formstring = formstring .. "tooltip[doc_button_goto_prev;Show previous entry]"
formstring = formstring .. "tooltip[doc_button_goto_next;Show next entry]"
return formstring
end
function doc.formspec_entry(category_id, entry_id)
local formstring
if category_id == nil then
formstring = "label[0,0;You haven't chosen a category yet. Please choose one in the category list first.]"
formstring = formstring .. "button[0,1;3,1;doc_button_goto_main;Go to category list]"
elseif entry_id == nil then
formstring = "label[0,0;Help > "..doc.data.categories[category_id].def.name.." > (No Entry)]"
if doc.get_entry_count(category_id) >= 1 then
formstring = formstring .. "label[0,0.5;You haven't chosen an entry yet. Please choose one in the entry list first.]"
formstring = formstring .. "button[0,1.5;3,1;doc_button_goto_category;Go to entry list]"
else
formstring = formstring .. "label[0,0.5;This category does not have any entries.]"
formstring = formstring .. "button[0,1.5;3,1;doc_button_goto_main;Go to category list]"
end
else
local category = doc.data.categories[category_id]
local entry = doc.get_entry(category_id, entry_id)
formstring = "label[0,0;Help > "..category.def.name.." > "..entry.name.."]"
formstring = formstring .. category.def.build_formspec(entry.data)
formstring = formstring .. doc.formspec_entry_navigation(category_id, entry_id)
end
return formstring
end
function doc.process_form(player,formname,fields)
local playername = player:get_player_name()
--[[ process clicks on the tab header ]]
if(formname == "doc:main" or formname == "doc:category" or formname == "doc:entry") then
if fields.doc_header ~= nil then
local tab = tonumber(fields.doc_header)
local formspec, subformname, contents
local cid, eid
cid = doc.data.players[playername].category
eid = doc.data.players[playername].entry
if(tab==1) then
contents = doc.formspec_main()
subformname = "main"
elseif(tab==2) then
contents = doc.formspec_category(cid, playername)
subformname = "category"
elseif(tab==3) then
contents = doc.formspec_entry(cid, eid)
if cid ~= nil and eid ~= nil then
doc.mark_entry_as_viewed(playername, cid, eid)
end
subformname = "entry"
end
formspec = doc.formspec_core(tab)..contents
minetest.show_formspec(playername, "doc:" .. subformname, formspec)
return
end
end
if(formname == "doc:main") then
for id,_ in pairs(doc.data.categories) do
if fields["doc_button_category_"..id] then
local formspec = doc.formspec_core(2)..doc.formspec_category(id, playername)
doc.data.players[playername].catsel = nil
doc.data.players[playername].category = id
doc.data.players[playername].entry = nil
minetest.show_formspec(playername, "doc:category", formspec)
break
end
end
elseif(formname == "doc:category") then
if fields["doc_button_goto_entry"] then
local cid = doc.data.players[playername].category
if cid ~= nil then
local eid = nil
local eids, catsel = doc.data.players[playername].entry_ids, doc.data.players[playername].catsel
if eids ~= nil and catsel ~= nil then
eid = eids[catsel]
end
local formspec = doc.formspec_core(3)..doc.formspec_entry(cid, eid)
minetest.show_formspec(playername, "doc:entry", formspec)
doc.mark_entry_as_viewed(playername, cid, eid)
end
end
if fields["doc_button_goto_main"] then
local formspec = doc.formspec_core(1)..doc.formspec_main()
minetest.show_formspec(playername, "doc:main", formspec)
end
if fields["doc_catlist"] then
local event = minetest.explode_textlist_event(fields["doc_catlist"])
if event.type == "CHG" then
doc.data.players[playername].catsel = event.index
doc.data.players[playername].entry = doc.data.players[playername].entry_ids[event.index]
elseif event.type == "DCL" then
local cid = doc.data.players[playername].category
local eid = nil
local eids, catsel = doc.data.players[playername].entry_ids, event.index
if eids ~= nil and catsel ~= nil then
eid = eids[catsel]
end
local formspec = doc.formspec_core(3)..doc.formspec_entry(cid, eid)
minetest.show_formspec(playername, "doc:entry", formspec)
doc.mark_entry_as_viewed(playername, cid, eid)
end
end
elseif(formname == "doc:entry") then
if fields["doc_button_goto_main"] then
local formspec = doc.formspec_core(1)..doc.formspec_main()
minetest.show_formspec(playername, "doc:main", formspec)
elseif fields["doc_button_goto_category"] then
local formspec = doc.formspec_core(2)..doc.formspec_category(doc.data.players[playername].category, playername)
minetest.show_formspec(playername, "doc:category", formspec)
elseif fields["doc_button_goto_next"] then
if doc.data.players[playername].catsel == nil then return end -- emergency exit
local eids = doc.data.players[playername].entry_ids
local cid = doc.data.players[playername].category
local new_catsel= doc.data.players[playername].catsel + 1
local new_eid = eids[new_catsel]
if #eids > 1 and new_catsel <= #eids then
local formspec = doc.formspec_core(3)..doc.formspec_entry(cid, new_eid)
minetest.show_formspec(playername, "doc:entry", formspec)
doc.mark_entry_as_viewed(playername, cid, new_eid)
doc.data.players[playername].catsel = new_catsel
doc.data.players[playername].entry = new_eid
end
elseif fields["doc_button_goto_prev"] then
if doc.data.players[playername].catsel == nil then return end -- emergency exit
local eids = doc.data.players[playername].entry_ids
local cid = doc.data.players[playername].category
local new_catsel= doc.data.players[playername].catsel - 1
local new_eid = eids[new_catsel]
if #eids > 1 and new_catsel >= 1 then
local formspec = doc.formspec_core(3)..doc.formspec_entry(cid, new_eid)
minetest.show_formspec(playername, "doc:entry", formspec)
doc.mark_entry_as_viewed(playername, cid, new_eid)
doc.data.players[playername].catsel = new_catsel
doc.data.players[playername].entry = new_eid
end
end
end
end
minetest.register_on_player_receive_fields(doc.process_form)
minetest.register_chatcommand("doc", {
params = "",
description = "Open documentation system.",
privs = {},
func = function(playername, param)
doc.show_doc(playername)
end,
}
)
minetest.register_on_joinplayer(function(player)
local playername = player:get_player_name()
if doc.data.players[playername] == nil then
-- Initialize player data
doc.data.players[playername] = {}
-- Table for persistant data
doc.data.players[playername].stored_data = {}
-- Contains viewed entries
doc.data.players[playername].stored_data.viewed = {}
-- Count viewed entries
doc.data.players[playername].stored_data.viewed_count = {}
-- Contains revealed/unhidden entries
doc.data.players[playername].stored_data.revealed = {}
-- Count revealed entries
doc.data.players[playername].stored_data.revealed_count = {}
end
end)
minetest.register_on_leaveplayer(function(player)
doc.data.players[player:get_player_name()] = nil
end)
---[[ Add buttons for inventory mods ]]
-- Unified Inventory
if minetest.get_modpath("unified_inventory") ~= nil then
unified_inventory.register_button("doc", {
type = "image",
image = "doc_button_icon_hires.png",
tooltip = "Documentation System",
action = function(player)
doc.show_doc(player:get_player_name())
end,
})
end
|