Treat compass/clock groups as items in craftguide

This commit is contained in:
Wuzzy 2017-02-20 01:26:15 +01:00
parent 22c5f0f41e
commit 9c23247c4c
2 changed files with 31 additions and 6 deletions

11
API.md
View file

@ -68,8 +68,6 @@ These groups are used mostly for informational purposes
* `flower_pot`: Flower pot * `flower_pot`: Flower pot
* `flower_pot=1`: Empty flower pot * `flower_pot=1`: Empty flower pot
* `flower_pot=2`: Flower pot with a plant or flower * `flower_pot=2`: Flower pot with a plant or flower
* `clock=1`: Clock
* `compass`: Compass (rating doesn't matter)
* `book=1`: Book * `book=1`: Book
* `pane=1`: Node is a “pane”-like node glass pane or iron bars * `pane=1`: Node is a “pane”-like node glass pane or iron bars
* `bed=1`: Bed * `bed=1`: Bed
@ -103,3 +101,12 @@ These groups are used mostly for informational purposes
* `building_block=1`: Block is a building block * `building_block=1`: Block is a building block
* `deco_block=1`: Block is a decorational block * `deco_block=1`: Block is a decorational block
## Fake item groups
These groups put similar items together which should all be treated by the gameplay or the GUI as a single item.
You should not add custom items to these groups for no good reason, this is likely to cause a ton of conflicts.
* `clock=1`: Clock
* `compass`: Compass (rating doesn't matter)
This has the following implication: If you want to use a compass or clock in a crafting recipe, you *must*
use `group:compass` or `group:clock`, respectively.

View file

@ -67,7 +67,7 @@ local group_names = {
wood_stairs = "Any wooden stairs", wood_stairs = "Any wooden stairs",
coal = "Any coal", coal = "Any coal",
quartz_block = "Any kind of quartz block", quartz_block = "Any kind of quartz block",
stonebrick = "Any stone bricks" stonebrick = "Any stone bricks",
} }
function craftguide:group_to_item(item) function craftguide:group_to_item(item)
@ -130,10 +130,20 @@ function craftguide:get_tooltip_raw(item, recipe_type, cooktime, groups)
local gcol = "#FFAAFF" local gcol = "#FFAAFF"
local groupstr local groupstr
if #groups == 1 then if #groups == 1 then
if group_names[groups[1]] then local g = group_names[groups[1]]
-- Treat the groups “compass” and “clock” as fake groups
-- and just print the normal group name without special formatting
if groups[1] == "compass" or groups[1] == "clock" then
gcol = ""
groupstr = reg_items[item].description
elseif group_names[groups[1]] then
-- Use the special group name string
groupstr = group_names[groups[1]] groupstr = group_names[groups[1]]
else else
groupstr = "Any item belonging to the " .. groups[1] .. " group" --[[ Fallback: Generic group explanation: This always
works, but the internally used group name (which
looks ugly) is exposed to the user. ]]
groupstr = "Any item belonging to the " .. g .. " group"
end end
else else
groupstr = "Any item belonging to the following groups: " groupstr = "Any item belonging to the following groups: "
@ -216,7 +226,15 @@ function craftguide:get_recipe(iY, xoffset, tooltip_raw, item, recipe_num, recip
end end
local groups = extract_groups(v) local groups = extract_groups(v)
local label = groups and "\nG" or "" local label = ""
-- Add the “G” symbols for group item slots
if groups then
--[[ Exception: Groups “compass” and “clock” since the items in these groups should
be treated as a single item from the user perspective. ]]
if not (#groups == 1 and (groups[1] == "compass" or groups[1] == "clock")) then
label = "\nG" or ""
end
end
local item_r = self:group_to_item(v) local item_r = self:group_to_item(v)
local tltip = self:get_tooltip( local tltip = self:get_tooltip(
item_r, recipe_type, cooking_time, groups) item_r, recipe_type, cooking_time, groups)