Wuzzy/minetest_doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Allow cross-category aliases, change API

Browse Source
This commit is contained in:
Wuzzy 2016-12-28 17:34:47 +01:00
parent 0f15cf4e07
commit 3e7adfa793
2 changed files with 58 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
API.md
View File

@ -104,7 +104,6 @@ These functions are available:
#### Aliases #### Aliases
* `doc.add_entry_alias`: Add an alternative name which can be used to access an entry * `doc.add_entry_alias`: Add an alternative name which can be used to access an entry
* `doc.add_entry_aliases`: Add multiple alternative names which can be used to access an entry
#### Special widgets #### Special widgets
This API provides functions to add unique “widgets” for functionality This API provides functions to add unique “widgets” for functionality
@ -363,29 +362,27 @@ rest of the game.
#### Parameters #### Parameters
* `playername`: Name of the player for whom to reveal the entries * `playername`: Name of the player for whom to reveal the entries
### `doc.add_entry_alias(category_id, entry_id, alias)` ### `doc.add_entry_alias(category_id_orig, entry_id_orig, category_id_alias, entry_id_orig)`
Adds a single alias for an entry. If an entry has an alias, supplying the Adds a single alias for an entry. If an entry has an alias, supplying the
alias to a function which demands an `entry_id` will work as if the original alias to a function which demand `category_id` and `entry_id` will work as expected.
`entry_id` has been supplied. The scope of an alias is the category in which
it has been created.
When using this function, you must make sure the category already exists. When using this function, you must make sure the category already exists.
#### Parameters This function could be useful for legacy support after changing an entry ID or
* `category_id`: Category identifier of the category of the entry in question moving an entry to a different category.
* `entry_id`: The original (!) entry identifier of the entry to create an alias
for
* `alias`: Alias (string) for `entry_id`
### `doc.add_entry_aliases(category_id, entry_id, aliases)`
Adds an arbitrary amount of aliases for an entry at once. Apart from that, this
function has the same effect as `doc.add_entry_alias`.
When using this function, you must make sure the category already exists.
#### Parameters #### Parameters
* `category_id`: Category identifier of the category of the entry in question * `category_id_orig`: Category identifier of the category of the entry in question
* `entry_id`: The original (!) entry identifier of the entry to create aliases * `entry_id_orig`: The original (!) entry identifier of the entry to create an alias
for for
* `aliases`: Table/list of aliases (strings) for `entry_id` * `category_id_alias`: The category ID of the alias
* `entry_id_alias`: The entry ID of the alias
#### Example
doc.add_entry_alias("nodes", "test", "craftitems", "test2")
When calling a function with category ID “craftitems” and entry ID “test2”, it will
act as if you supplied “nodes” as category ID and “test” as entry ID.
### `doc.get_category_count()` ### `doc.get_category_count()`
Returns the number of registered categories. Returns the number of registered categories.

78
init.lua
View File

@ -62,6 +62,7 @@ local TEXT_LINELENGTH = 80
doc.data = {} doc.data = {}
doc.data.categories = {} doc.data.categories = {}
doc.data.aliases = {}
-- Default order (includes categories of other mods from the Docuentation System modpack) -- Default order (includes categories of other mods from the Docuentation System modpack)
doc.data.category_order = {"basics", "nodes", "tools", "craftitems", "advanced"} doc.data.category_order = {"basics", "nodes", "tools", "craftitems", "advanced"}
doc.data.category_count = 0 doc.data.category_count = 0
@ -83,7 +84,6 @@ function doc.add_category(id, def)
doc.data.categories[id].entry_count = 0 doc.data.categories[id].entry_count = 0
doc.data.categories[id].hidden_count = 0 doc.data.categories[id].hidden_count = 0
doc.data.categories[id].def = def doc.data.categories[id].def = def
doc.data.categories[id].entry_aliases = {}
-- Determine order position -- Determine order position
local order_id = nil local order_id = nil
for i=1,#doc.data.category_order do for i=1,#doc.data.category_order do
@ -128,7 +128,10 @@ end
-- Marks a particular entry as viewed by a certain player, which also -- Marks a particular entry as viewed by a certain player, which also
-- automatically reveals it -- automatically reveals it
function doc.mark_entry_as_viewed(playername, category_id, entry_id) function doc.mark_entry_as_viewed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id) local entry, category_id, entry_id = doc.get_entry(category_id, entry_id)
if not entry then
return
end
if doc.data.players[playername].stored_data.viewed[category_id] == nil then 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[category_id] = {}
doc.data.players[playername].stored_data.viewed_count[category_id] = 0 doc.data.players[playername].stored_data.viewed_count[category_id] = 0
@ -144,7 +147,10 @@ end
-- Marks a particular entry as revealed/unhidden by a certain player -- Marks a particular entry as revealed/unhidden by a certain player
function doc.mark_entry_as_revealed(playername, category_id, entry_id) function doc.mark_entry_as_revealed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id) local entry, category_id, entry_id = doc.get_entry(category_id, entry_id)
if not entry then
return
end
if doc.data.players[playername].stored_data.revealed[category_id] == nil then 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[category_id] = {}
doc.data.players[playername].stored_data.revealed_count[category_id] = doc.get_entry_count(category_id) - doc.data.categories[category_id].hidden_count doc.data.players[playername].stored_data.revealed_count[category_id] = doc.get_entry_count(category_id) - doc.data.categories[category_id].hidden_count
@ -209,7 +215,7 @@ end
-- Returns true if the specified entry has been viewed by the player -- Returns true if the specified entry has been viewed by the player
function doc.entry_viewed(playername, category_id, entry_id) function doc.entry_viewed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id) local entry, category_id, entry_id = doc.get_entry(category_id, entry_id)
if doc.data.players[playername].stored_data.viewed[category_id] == nil then if doc.data.players[playername].stored_data.viewed[category_id] == nil then
return false return false
else else
@ -219,7 +225,7 @@ end
-- Returns true if the specified entry is hidden from the player -- Returns true if the specified entry is hidden from the player
function doc.entry_revealed(playername, category_id, entry_id) function doc.entry_revealed(playername, category_id, entry_id)
local entry, entry_id = doc.get_entry(category_id, entry_id) local entry, category_id, entry_id = doc.get_entry(category_id, entry_id)
local hidden = doc.data.categories[category_id].entries[entry_id].hidden local hidden = doc.data.categories[category_id].entries[entry_id].hidden
if doc.data.players[playername].stored_data.revealed[category_id] == nil then if doc.data.players[playername].stored_data.revealed[category_id] == nil then
return not hidden return not hidden
@ -245,7 +251,7 @@ function doc.get_entry_definition(category_id, entry_id)
if not doc.entry_exists(category_id, entry_id) then if not doc.entry_exists(category_id, entry_id) then
return nil return nil
end end
local entry, _ = doc.get_entry(category_id, entry_id) local entry, _, _ = doc.get_entry(category_id, entry_id)
return entry return entry
end end
@ -278,7 +284,7 @@ function doc.show_entry(playername, category_id, entry_id, ignore_hidden)
minetest.show_formspec(playername, "doc:error_no_categories", doc.formspec_error_no_categories()) minetest.show_formspec(playername, "doc:error_no_categories", doc.formspec_error_no_categories())
return return
end end
local entry, entry_id = doc.get_entry(category_id, entry_id) local entry, category_id, entry_id = doc.get_entry(category_id, entry_id)
if ignore_hidden or doc.entry_revealed(playername, category_id, entry_id) then if ignore_hidden or doc.entry_revealed(playername, category_id, entry_id) then
local playerdata = doc.data.players[playername] local playerdata = doc.data.players[playername]
playerdata.category = category_id playerdata.category = category_id
@ -301,18 +307,9 @@ end
-- Returns true if and only if: -- Returns true if and only if:
-- * The specified category exists -- * The specified category exists
-- * This category contains the specified entry -- * This category contains the specified entry
-- Aliases are taken into account
function doc.entry_exists(category_id, entry_id) function doc.entry_exists(category_id, entry_id)
if doc.data.categories[category_id] ~= nil then return doc.get_entry(category_id, entry_id) ~= nil
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 alias for it
return doc.data.categories[category_id].entry_aliases[entry_id] ~= nil
end
else
return false
end
end end
-- Sets the order of categories in the category list -- Sets the order of categories in the category list
@ -341,18 +338,13 @@ function doc.set_category_order(categories)
set_category_order_was_called = true set_category_order_was_called = true
end end
-- Adds aliases for an entry. Attempting to open an entry by an alias name -- Adds an alias for an entry. Attempting to open an entry by an alias name
-- results in opening the entry of the original name. -- results in opening the entry of the original name.
-- Aliases are true within one category only. function doc.add_entry_alias(category_id_orig, entry_id_orig, category_id_alias, entry_id_alias)
function doc.add_entry_aliases(category_id, entry_id, aliases) if not doc.data.aliases[category_id_alias] then
for a=1,#aliases do doc.data.aliases[category_id_alias] = {}
doc.data.categories[category_id].entry_aliases[aliases[a]] = entry_id
end end
end doc.data.aliases[category_id_alias][entry_id_alias] = { category_id = category_id_orig, entry_id = entry_id_orig }
-- 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 end
-- Returns number of categories -- Returns number of categories
@ -786,15 +778,31 @@ end
-- Returns the entry definition and true entry ID of an entry, taking aliases into account -- Returns the entry definition and true entry ID of an entry, taking aliases into account
function doc.get_entry(category_id, entry_id) function doc.get_entry(category_id, entry_id)
local category = doc.data.categories[category_id] local category = doc.data.categories[category_id]
local entry = category.entries[entry_id] local entry
local resolved_entry_id = entry_id if category ~= nil then
if entry == nil then entry = category.entries[entry_id]
resolved_entry_id = doc.data.categories[category_id].entry_aliases[entry_id] end
if resolved_entry_id ~= nil then if category == nil or entry == nil then
entry = category.entries[resolved_entry_id] local c_alias = doc.data.aliases[category_id]
if c_alias then
local alias = c_alias[entry_id]
if alias then
category_id = alias.category_id
entry_id = alias.entry_id
category = doc.data.categories[category_id]
if category then
entry = category.entries[entry_id]
else
return nil
end
else
return nil
end
else
return nil
end end
end end
return entry, resolved_entry_id return entry, category_id, entry_id
end end
function doc.generate_entry_list(cid, playername) function doc.generate_entry_list(cid, playername)