API.md

   1 # Tooltip API
   2 This API explains how to handle the extended item tooltips (`description` field).
   3
   4 ## Fields
   5
   6 Add these to the item definition.
   7
   8 * `_tt_ignore`: If `true`, the `description` of this item won't be altered at all
   9 * `_tt_help`: Custom help text
  10 * `_tt_food`: If `true`, item is a food item that can be consumed by the player
  11 * `_tt_food_hp`: Health increase (in HP) for player when consuming food item
  12
  13 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.
  14
  15 ## `tt.register_snippet(func)`
  16
  17 Register a custom snippet function.
  18 `func` is a function of the form `func(itemstring)`.
  19 It will be called for (nearly) every itemstring.
  20
  21 Returns: Two values, the first one is required.
  22 1st return value: A string you want to append to this item or `nil` if nothing shall be appended.
  23 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.
  24
  25 Example:
  26
  27 ```
  28 tt.register_snippet(function(itemstring)
  29         if minetest.get_item_group(itemstring, "magic") == 1 then
  30                 return "This item is magic"
  31         end
  32 end)
  33 ```