Add item documentation
[minetest_wateringcan.git] / init.lua
blob82ce61313f9572e457a1f6238c5427e794710a89
1 local S
2 if (minetest.get_modpath("intllib")) then
3 dofile(minetest.get_modpath("intllib").."/intllib.lua")
4 S = intllib.Getter(minetest.get_current_modname())
5 else
6 S = function ( s ) return s end
7 end
9 minetest.register_tool("wateringcan:wateringcan_water", {
10 description = S("watering can with water"),
11 inventory_image = "wateringcan_wateringcan_water.png",
12 wield_image = "wateringcan_wateringcan_wield.png",
13 liquids_pointable = true,
14 stack_max = 1,
15 tool_capabilities = {
16 full_punch_interval = 2.0,
18 on_place = function(itemstack, user, pointed_thing)
19 if(pointed_thing.type == "node") then
20 local pos = pointed_thing.under
21 local node = minetest.get_node_or_nil(pos)
22 if node ~= nil then
23 local name, nodedef
24 local watered = true
25 local wear, newtool
26 local underunder
27 if minetest.get_item_group(node.name, "plant") > 0 or minetest.get_item_group(node.name, "flora") > 0 or minetest.get_item_group(node.name, "seed") > 0 then
28 pos = {x=pos.x, y=pos.y-1, z=pos.z}
29 underunder = minetest.get_node_or_nil(pos)
30 if(underunder ~= nil) then
31 name = underunder.name
32 nodedef = minetest.registered_nodes[name]
33 else
34 return itemstack
35 end
36 else
37 name = node.name
38 nodedef = minetest.registered_nodes[name]
39 end
40 if minetest.get_item_group(name, "water") > 0 then
41 newtool = { name = "wateringcan:wateringcan_water" }
42 watered = false
43 elseif name == "farming:soil" and minetest.get_modpath("farming") ~= nil then
44 minetest.set_node(pos, { name = "farming:soil_wet" })
45 elseif name == "farming:desert_sand_soil" and minetest.get_modpath("farming") ~= nil then
46 minetest.set_node(pos, { name = "farming:desert_sand_soil_wet" })
48 elseif minetest.get_item_group(name, "sucky") > 0 and minetest.get_item_group(name, "wet") < 2 and minetest.get_modpath("pedology") ~= nil then
49 pedology.wetten(pos)
50 end
52 if watered then
53 wear = itemstack:get_wear()
54 wear = wear + 2849 -- 24 uses
55 if(wear > 65535) then
56 newtool = { name = "wateringcan:wateringcan_empty" }
57 else
58 newtool = { name = "wateringcan:wateringcan_water", wear = wear }
59 end
60 end
61 return newtool
62 end
63 end
64 end,
65 groups = { not_in_doc = 1 },
69 minetest.register_tool("wateringcan:wateringcan_empty", {
70 description = S("empty watering can"),
71 inventory_image = "wateringcan_wateringcan_empty.png",
72 wield_image = "wateringcan_wateringcan_wield.png",
73 liquids_pointable = true,
74 stack_max = 1,
75 tool_capabilities = {
76 full_punch_interval = 2.0,
78 on_place = function(itemstack, user, pointed_thing)
79 local node = minetest.get_node_or_nil(pointed_thing.under)
80 if node ~= nil then
81 local name = node.name
82 local nodedef = minetest.registered_nodes[name]
83 if minetest.get_item_group(name, "water") > 0 then
84 return { name = "wateringcan:wateringcan_water" }
85 end
86 end
87 end
90 if minetest.get_modpath("doc_items") ~= nil then
91 local d = S("Watering cans are used to collect a small amount of water in order to pour it on dry blocks. One filled watering can can be used 24 times, after which it has to be refilled. Watering cans don't wear out.")
92 local u = S("Rightclick on water (or any other block belonging to the “Water” group) to fill or refill the watering can. Rightclick with the filled can on an appropriate block (or a plant above it) to wetten it. Soil, desert sand soil, and other blocks capable of becoming wet can be wettened. The tool wear indicator of the watering can indicates the amount of water left.")
93 doc.sub.items.add_item_name_overrides({["wateringcan:wateringcan_empty"] = S("Watering can")})
94 doc.add_entry_alias("tools", "wateringcan:wateringcan_empty", "wateringcan:wateringcan_water")
95 doc.sub.items.set_items_longdesc({["wateringcan:wateringcan_empty"] = d, ["wateringcan:wateringcan_water"] = d})
96 doc.sub.items.set_items_usagehelp({["wateringcan:wateringcan_empty"] = u, ["wateringcan:wateringcan_water"] = u})
97 end