Minetest/VoxeLibre
2
0
Fork 0
mirror of https://git.minetest.land/VoxeLibre/VoxeLibre.git synced 2024-11-25 20:11:06 +01:00
Code Issues Projects Releases Packages Wiki Activity

more mt like API (improved readability)

Browse source
This commit is contained in:
AFCMS 2021-07-14 11:52:27 +02:00
parent cd08df175c
commit 88e59d3592
3 changed files with 14 additions and 159 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
mods/ITEMS/mcl_buckets/API.md
View file

@ -1,15 +1,18 @@
# mcl_buckets
Add an API to register buckets to mcl
## mcl_buckets.register_liquid(def)
## mcl_buckets.register_liquid(itemname, def)
Register a new bucket of liquid.
`itemname` is the itemstring of the new bucket item
`def` is a table containing the folowing fields:
Register a new liquid
Accept folowing params:
* source_place: a string or function.
* string: name of the node to place
* function(pos): will returns name of the node to place with pos being the placement position
* source_take: table of liquid source node names to take
* itemname: itemstring of the new bucket item (or nil if liquid is not takeable)
* inventory_image: texture of the new bucket item (ignored if itemname == nil)
* name: user-visible bucket description
* longdesc: long explanatory description (for help)
@ -21,8 +24,7 @@ Accept folowing params:
**Usage exemple:**
```lua
mcl_buckets.register_liquid({
itemname = "dummy:bucket_dummy",
mcl_buckets.register_liquid("dummy:bucket_dummy", {
--source_place = "dummy:dummy_source",
source_place = function(pos)
if condition then

150
mods/ITEMS/mcl_buckets/init.lua
View file

@ -147,13 +147,13 @@ local function get_bucket_drop(itemstack, user, take_bucket)
end
end
function mcl_buckets.register_liquid(def)
function mcl_buckets.register_liquid(itemname, def)
for _,source in ipairs(def.source_take) do
mcl_buckets.liquids[source] = {
source_place = def.source_place,
source_take = source,
on_take = def.on_take,
itemname = def.itemname,
itemname = itemname,
}
pointable_sources[source] = true
if type(def.source_place) == "string" then
@ -161,11 +161,7 @@ function mcl_buckets.register_liquid(def)
end
end
if def.itemname == nil or def.itemname == "" then
error(string.format("[mcl_bucket] Invalid itemname then registering [%s]!", def.name))
end
minetest.register_craftitem(def.itemname, {
minetest.register_craftitem(itemname, {
description = def.name,
_doc_items_longdesc = def.longdesc,
_doc_items_usagehelp = def.usagehelp,
@ -236,72 +232,6 @@ function mcl_buckets.register_liquid(def)
else
return itemstack
end
-- Check if pointing to a buildable node
--local item = itemstack:get_name()
--[[
if buildable_to_1 then
if can_place(pos) then
Place
end
else if buildable_to_2 then
if can_place2() then
Place
end
end
]]
--[[
if result then -- Fail placement of liquid if result is false
local pns = user:get_player_name()
if minetest.is_protected(place_pos, pns) then
minetest.record_protection_violation(place_pos, pns)
return itemstack
end
place_liquid(place_pos, node_place)
if mod_doc and doc.entry_exists("nodes", node_place) then
doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
end
else
-- not buildable to; place the liquid above
-- check if the node above can be replaced
local abovenode = minetest.get_node(pointed_thing.above)
if minetest.registered_nodes[abovenode.name] and minetest.registered_nodes[abovenode.name].buildable_to then
local pn = user:get_player_name()
if minetest.is_protected(pointed_thing.above, pn) then
minetest.record_protection_violation(pointed_thing.above, pn)
return itemstack
end
place_liquid(pointed_thing.above, node_place)
if mod_doc and doc.entry_exists("nodes", node_place) then
doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
end
else
-- do not remove the bucket with the liquid
return
end
end
-- Handle bucket item and inventory stuff
if not minetest.is_creative_enabled(user:get_player_name()) then
-- Add empty bucket and put it into inventory, if possible.
-- Drop empty bucket otherwise.
local new_bucket = ItemStack("mcl_buckets:bucket_empty")
if itemstack:get_count() == 1 then
return new_bucket
else
local inv = user:get_inventory()
if inv:room_for_item("main", new_bucket) then
inv:add_item("main", new_bucket)
else
minetest.add_item(user:get_pos(), new_bucket)
end
itemstack:take_item()
return itemstack
end
else
return
end]]
end,
_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
local iname = stack:get_name()
@ -328,80 +258,6 @@ minetest.register_craftitem("mcl_buckets:bucket_empty", {
inventory_image = "bucket.png",
stack_max = 16,
on_place = function(itemstack, user, pointed_thing)
--[[-- Must be pointing to node
if pointed_thing.type ~= "node" then
return itemstack
end
-- Call on_rightclick if the pointed node defines it
local pointed_liquid = bucket_raycast(user)
-- Can't steal liquids
if minetest.is_protected(pointed_liquid.above, user:get_player_name()) then
minetest.record_protection_violation(pointed_liquid.under, user:get_player_name())
return itemstack
end
if minetest.is_protected(pointed_thing.above, user:get_player_name()) then
minetest.record_protection_violation(pointed_thing.under, user:get_player_name())
return itemstack
end
-- Check if pointing to a liquid source
local liquiddef = mcl_buckets.liquids[nn]
local new_bucket
if liquiddef and liquiddef.itemname and (nn == liquiddef.source_take) then
-- Fill bucket, but not in Creative Mode
if not minetest.is_creative_enabled(user:get_player_name()) then
new_bucket = ItemStack({name = liquiddef.itemname})
if liquiddef.on_take then
liquiddef.on_take(user)
end
end
minetest.add_node(pointed_thing.under, {name="air"})
sound_take(nn, pointed_thing.under)
if mod_doc and doc.entry_exists("nodes", nn) then
doc.mark_entry_as_revealed(user:get_player_name(), "nodes", nn)
end
elseif nn == "mcl_cauldrons:cauldron_3" then
-- Take water out of full cauldron
minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
if not minetest.is_creative_enabled(user:get_player_name()) then
new_bucket = ItemStack("mcl_buckets:bucket_water")
end
sound_take("mcl_core:water_source", pointed_thing.under)
elseif nn == "mcl_cauldrons:cauldron_3r" then
-- Take river water out of full cauldron
minetest.set_node(pointed_thing.under, {name="mcl_cauldrons:cauldron"})
if not minetest.is_creative_enabled(user:get_player_name()) then
new_bucket = ItemStack("mcl_buckets:bucket_river_water")
end
sound_take("mclx_core:river_water_source", pointed_thing.under)
end
-- Add liquid bucket and put it into inventory, if possible.
-- Drop new bucket otherwise.
if new_bucket then
if itemstack:get_count() == 1 then
return new_bucket
else
local inv = user:get_inventory()
if inv:room_for_item("main", new_bucket) then
inv:add_item("main", new_bucket)
else
minetest.add_item(user:get_pos(), new_bucket)
end
if not minetest.is_creative_enabled(user:get_player_name()) then
itemstack:take_item()
end
return itemstack
end
end]]
-- Must be pointing to node
if pointed_thing.type ~= "node" then
return itemstack

9
mods/ITEMS/mcl_buckets/register.lua
View file

@ -19,7 +19,7 @@ end]]
if mod_mcl_core then
-- Lava bucket
mcl_buckets.register_liquid({
mcl_buckets.register_liquid("mcl_buckets:bucket_lava", {
source_place = function(pos)
local dim = mcl_worlds.pos_to_dimension(pos)
if dim == "nether" then
@ -34,7 +34,6 @@ if mod_mcl_core then
awards.unlock(user:get_player_name(), "mcl:hotStuff")
end
end,
itemname = "mcl_buckets:bucket_lava",
inventory_image = "bucket_lava.png",
name = S("Lava Bucket"),
longdesc = S("A bucket can be used to collect and release liquids. This one is filled with hot lava, safely contained inside. Use with caution."),
@ -43,10 +42,9 @@ if mod_mcl_core then
})
-- Water bucket
mcl_buckets.register_liquid({
mcl_buckets.register_liquid("mcl_buckets:bucket_water", {
source_place = "mcl_core:water_source",
source_take = {"mcl_core:water_source"},
itemname = "mcl_buckets:bucket_water",
inventory_image = "bucket_water.png",
name = S("Water Bucket"),
longdesc = S("A bucket can be used to collect and release liquids. This one is filled with water."),
@ -77,10 +75,9 @@ end
if mod_mclx_core then
-- River water bucket
mcl_buckets.register_liquid({
mcl_buckets.register_liquid("mcl_buckets:bucket_river_water", {
source_place = "mclx_core:river_water_source",
source_take = {"mclx_core:river_water_source"},
itemname = "mcl_buckets:bucket_river_water",
inventory_image = "bucket_river_water.png",
name = S("River Water Bucket"),
longdesc = S("A bucket can be used to collect and release liquids. This one is filled with river water."),