1.6 KiB
Tooltip API
This API explains how to handle the extended item tooltips (description field).
Fields
Add these to the item definition.
_tt_ignore: Iftrue, thedescriptionof this item won't be altered at all_tt_help: Custom help text
Once this mod had overwritten the description field of an item was overwritten, it will save the original (unaltered) description in the _tt_original_description field.
tt.register_snippet(func)
Register a custom snippet function.
func is a function of the form func(itemstring, tool_capabilities, itemstack).
It will be called for (nearly) every itemstring at startup and when tt.reload_itemstack_description is called for an itemstack.
The itemstack parameter is only present when the snippet is called via tt.reload_itemstack_description and contains the itemstack.
Returns: Two values, the first one is required.
1st return value: A string you want to append to this item or nil if nothing shall be appended.
2nd return value: If nil, tt will take of the text color. If a ColorString in "#RRGGBB" format, entire text is colorized in this color. Return false to force tt to not apply text any colorization (useful if you want to call minetest.colorize yourself.
Example:
tt.register_snippet(function(itemstring)
if minetest.get_item_group(itemstring, "magic") == 1 then
return "This item is magic"
end
end)
tt.reload_itemstack_description(itemstack)
This function will dynamically reload the itemstack description,
it becomes handy when ìtemstack:get_meta():set_tool_capabilities(...) was used
or if some snippets are based on metadata.