Mineclonia/mods/ITEMS/mcl_stairs/api.lua

416 lines
13 KiB
Lua

local S = minetest.get_translator("mcl_stairs")
-- Core mcl_stairs API
-- Wrapper around mintest.pointed_thing_to_face_pos.
local function get_fpos(placer, pointed_thing)
local finepos = minetest.pointed_thing_to_face_pos(placer, pointed_thing)
return finepos.y % 1
end
local function place_slab_normal(itemstack, placer, pointed_thing)
-- Use pointed node's on_rightclick function first, if present
local node = minetest.get_node(pointed_thing.under)
if placer and not placer:get_player_control().sneak then
if minetest.registered_nodes[node.name] and minetest.registered_nodes[node.name].on_rightclick then
return minetest.registered_nodes[node.name].on_rightclick(pointed_thing.under, node, placer, itemstack) or itemstack
end
end
local p0 = pointed_thing.under
local p1 = pointed_thing.above
local placer_pos = placer:get_pos()
local fpos = get_fpos(placer, pointed_thing)
local place = ItemStack(itemstack)
local origname = itemstack:get_name()
if p0.y - 1 == p1.y or (fpos > 0 and fpos < 0.5)
or (fpos < -0.5 and fpos > -0.999999999) then
place:set_name(origname .. "_top")
end
local ret = minetest.item_place(place, placer, pointed_thing, 0)
ret:set_name(origname)
return ret
end
local function place_stair(itemstack, placer, pointed_thing)
-- Use pointed node's on_rightclick function first, if present
local node = minetest.get_node(pointed_thing.under)
if placer and not placer:get_player_control().sneak then
if minetest.registered_nodes[node.name] and minetest.registered_nodes[node.name].on_rightclick then
return minetest.registered_nodes[node.name].on_rightclick(pointed_thing.under, node, placer, itemstack) or itemstack
end
end
local p0 = pointed_thing.under
local p1 = pointed_thing.above
local param2 = 0
local placer_pos = placer:get_pos()
if placer_pos then
param2 = minetest.dir_to_facedir(vector.subtract(p1, placer_pos))
end
local fpos = get_fpos(placer, pointed_thing)
if p0.y - 1 == p1.y or (fpos > 0 and fpos < 0.5)
or (fpos < -0.5 and fpos > -0.999999999) then
param2 = param2 + 20
if param2 == 21 then
param2 = 23
elseif param2 == 23 then
param2 = 21
end
end
return minetest.item_place(itemstack, placer, pointed_thing, param2)
end
local function get_modname_and_subname(name)
local modname, subname
if nil == string.find(name, ":") then
modname, subname = "mcl_stairs", name
else
modname, subname = string.gmatch(name, "(.*):(.*)")()
end
return modname, subname
end
local modname, subname = get_modname_and_subname("air")
assert( "mcl_stairs" == modname )
assert( "air" == subname )
local modname, subname = get_modname_and_subname("default:stone")
assert( "default" == modname )
assert( "stone" == subname )
-- Register aliases for backwards compatiblity with unprefixed API usage
local function register_mcl_stairs_alias(name)
local modname, subname = string.gmatch(name, "(.*):(.*)")()
assert( nil ~= modname )
assert( nil ~= subname )
if "mcl_stairs" ~= modname then
local old_name = "mcl_stairs:" .. subname
minetest.register_alias(old_name, name)
end
end
-- Register stairs.
-- Node will be called mcl_stairs:stair_<name> or <modname>:stair_<subname>
function mcl_stairs.register_stair(name, recipeitem, groups, images, description, sounds, blast_resistance, hardness, corner_stair_texture_override)
groups.stair = 1
groups.building_block = 1
if recipeitem then
if not images then
images = minetest.registered_items[recipeitem].tiles
end
if not groups then
groups = minetest.registered_items[recipeitem].groups
end
if not sounds then
sounds = minetest.registered_items[recipeitem].sounds
end
if not hardness then
hardness = minetest.registered_items[recipeitem]._mcl_hardness
end
if not blast_resistance then
blast_resistance = minetest.registered_items[recipeitem]._mcl_blast_resistance
end
end
local modname, subname = get_modname_and_subname(name)
local stair = modname .. ":stair_" .. subname
minetest.register_node(":" .. stair, {
description = description,
_doc_items_longdesc = S("Stairs are useful to reach higher places by walking over them; jumping is not required. Placing stairs in a corner pattern will create corner stairs. Stairs placed on the ceiling or at the upper half of the side of a block will be placed upside down."),
drawtype = "mesh",
mesh = "stairs_stair.obj",
tiles = images,
paramtype = "light",
paramtype2 = "facedir",
is_ground_content = false,
groups = groups,
sounds = sounds,
selection_box = {
type = "fixed",
fixed = {
{-0.5, -0.5, -0.5, 0.5, 0, 0.5},
{-0.5, 0, 0, 0.5, 0.5, 0.5},
},
},
collision_box = {
type = "fixed",
fixed = {
{-0.5, -0.5, -0.5, 0.5, 0, 0.5},
{-0.5, 0, 0, 0.5, 0.5, 0.5},
},
},
on_place = function(itemstack, placer, pointed_thing)
if pointed_thing.type ~= "node" then
return itemstack
end
return place_stair(itemstack, placer, pointed_thing)
end,
on_rotate = function(pos, node, user, mode, param2)
-- Flip stairs vertically
if mode == screwdriver.ROTATE_AXIS then
local minor = node.param2
if node.param2 >= 20 then
minor = node.param2 - 20
if minor == 3 then
minor = 1
elseif minor == 1 then
minor = 3
end
node.param2 = minor
else
if minor == 3 then
minor = 1
elseif minor == 1 then
minor = 3
end
node.param2 = minor
node.param2 = node.param2 + 20
end
minetest.set_node(pos, node)
return true
end
end,
_mcl_blast_resistance = blast_resistance,
_mcl_hardness = hardness,
})
register_mcl_stairs_alias(stair)
if recipeitem then
minetest.register_craft({
output = modname .. ':stair_' .. subname .. ' 4',
recipe = {
{recipeitem, "", ""},
{recipeitem, recipeitem, ""},
{recipeitem, recipeitem, recipeitem},
},
})
-- Flipped recipe
minetest.register_craft({
output = modname .. ':stair_' .. subname .. ' 4',
recipe = {
{"", "", recipeitem},
{"", recipeitem, recipeitem},
{recipeitem, recipeitem, recipeitem},
},
})
end
mcl_stairs.cornerstair.add(modname .. ":stair_" .. subname, corner_stair_texture_override)
end
-- Slab facedir to placement 6d matching table
local slab_trans_dir = {[0] = 8, 0, 2, 1, 3, 4}
-- Register slabs.
-- Node will be called mcl_stairs:slab_<name> or <modname>:slab_<subname>
-- double_description: NEW argument, not supported in Minetest Game
-- double_description: Description of double slab
function mcl_stairs.register_slab(name, recipeitem, groups, images, description, sounds, blast_resistance, hardness, double_description)
local modname, subname = get_modname_and_subname(name)
local lower_slab = modname .. ":slab_" .. subname
local upper_slab = lower_slab.."_top"
local double_slab = lower_slab.."_double"
if recipeitem then
if not images then
images = minetest.registered_items[recipeitem].tiles
end
if not groups then
groups = minetest.registered_items[recipeitem].groups
end
if not sounds then
sounds = minetest.registered_items[recipeitem].sounds
end
if not hardness then
hardness = minetest.registered_items[recipeitem]._mcl_hardness
end
if not blast_resistance then
blast_resistance = minetest.registered_items[recipeitem]._mcl_blast_resistance
end
end
-- Automatically generate double slab description
if not double_description then
double_description = S("Double @1", description)
minetest.log("warning", "[stairs] No explicit description for double slab '"..double_slab.."' added. Using auto-generated description.")
end
groups.slab = 1
groups.building_block = 1
local longdesc = S("Slabs are half as high as their full block counterparts and occupy either the lower or upper part of a block, depending on how it was placed. Slabs can be easily stepped on without needing to jump. When a slab is placed on another slab of the same type, a double slab is created.")
local slabdef = {
description = description,
_doc_items_longdesc = longdesc,
drawtype = "nodebox",
tiles = images,
paramtype = "light",
-- Facedir intentionally left out (see below)
is_ground_content = false,
groups = groups,
sounds = sounds,
node_box = {
type = "fixed",
fixed = {-0.5, -0.5, -0.5, 0.5, 0, 0.5},
},
on_place = function(itemstack, placer, pointed_thing)
local under = minetest.get_node(pointed_thing.under)
local wield_item = itemstack:get_name()
local creative_enabled = minetest.is_creative_enabled(placer:get_player_name())
-- place slab using under node orientation
local dir = vector.subtract(pointed_thing.above, pointed_thing.under)
local p2 = under.param2
-- combine two slabs if possible
-- Requirements: Same slab material, must be placed on top of lower slab, or on bottom of upper slab
if (wield_item == under.name or (minetest.registered_nodes[under.name] and wield_item == minetest.registered_nodes[under.name]._mcl_other_slab_half)) and
not ((dir.y >= 0 and minetest.get_item_group(under.name, "slab_top") == 1) or
(dir.y <= 0 and minetest.get_item_group(under.name, "slab_top") == 0)) then
local player_name = placer:get_player_name()
if minetest.is_protected(pointed_thing.under, player_name) and not
minetest.check_player_privs(placer, "protection_bypass") then
minetest.record_protection_violation(pointed_thing.under,
player_name)
return
end
local newnode = double_slab
minetest.set_node(pointed_thing.under, {name = newnode, param2 = p2})
if not creative_enabled then
itemstack:take_item()
end
return itemstack
-- No combination possible: Place slab normally
else
return place_slab_normal(itemstack, placer, pointed_thing)
end
end,
_mcl_hardness = hardness,
_mcl_other_slab_half = upper_slab,
on_rotate = function(pos, node, user, mode, param2)
-- Flip slab
if mode == screwdriver.ROTATE_AXIS then
node.name = upper_slab
minetest.set_node(pos, node)
return true
end
return false
end,
}
minetest.register_node(":"..lower_slab, slabdef)
register_mcl_stairs_alias(lower_slab)
-- Register the upper slab.
-- Using facedir is not an option, as this would rotate the textures as well and would make
-- e.g. upper sandstone slabs look completely wrong.
local topdef = table.copy(slabdef)
topdef.groups.slab = 1
topdef.groups.slab_top = 1
topdef.groups.not_in_creative_inventory = 1
topdef.groups.not_in_craft_guide = 1
topdef.description = S("Upper @1", description)
topdef._doc_items_create_entry = false
topdef._doc_items_longdesc = nil
topdef._doc_items_usagehelp = nil
topdef.drop = lower_slab
topdef._mcl_other_slab_half = lower_slab
topdef.on_rotate = function(pos, node, user, mode, param2)
-- Flip slab
if mode == screwdriver.ROTATE_AXIS then
node.name = lower_slab
minetest.set_node(pos, node)
return true
end
return false
end
topdef.node_box = {
type = "fixed",
fixed = {-0.5, 0, -0.5, 0.5, 0.5, 0.5},
}
topdef.selection_box = {
type = "fixed",
fixed = {-0.5, 0, -0.5, 0.5, 0.5, 0.5},
}
minetest.register_node(":"..upper_slab, topdef)
register_mcl_stairs_alias(upper_slab)
-- Double slab node
local dgroups = table.copy(groups)
dgroups.not_in_creative_inventory = 1
dgroups.not_in_craft_guide = 1
dgroups.slab = nil
dgroups.double_slab = 1
minetest.register_node(":"..double_slab, {
description = double_description,
_doc_items_longdesc = S("Double slabs are full blocks which are created by placing two slabs of the same kind on each other."),
tiles = images,
is_ground_content = false,
groups = dgroups,
sounds = sounds,
drop = lower_slab .. " 2",
_mcl_hardness = hardness,
})
register_mcl_stairs_alias(double_slab)
if recipeitem then
minetest.register_craft({
output = lower_slab .. " 6",
recipe = {
{recipeitem, recipeitem, recipeitem},
},
})
end
-- Help alias for the upper slab
if minetest.get_modpath("doc") then
doc.add_entry_alias("nodes", lower_slab, "nodes", upper_slab)
end
end
-- Stair/slab registration function.
-- Nodes will be called mcl_stairs:{stair,slab}_<name> or <modname>:{stair,slab}_<subname>
function mcl_stairs.register_stair_and_slab(name, recipeitem,
groups, images, desc_stair, desc_slab, sounds, blast_resistance, hardness,
double_description, corner_stair_texture_override)
mcl_stairs.register_stair(name, recipeitem, groups, images, desc_stair, sounds, blast_resistance, hardness, corner_stair_texture_override)
mcl_stairs.register_slab(name, recipeitem, groups, images, desc_slab, sounds, blast_resistance, hardness, double_description)
end
-- Very simple registration function
-- Makes stair and slab out of a source node
function mcl_stairs.register_stair_and_slab_simple(name, sourcenode, desc_stair, desc_slab, desc_double_slab, corner_stair_texture_override)
local def = minetest.registered_nodes[sourcenode]
local groups = {}
-- Only allow a strict set of groups to be added to stairs and slabs for more predictable results
local allowed_groups = { "dig_immediate", "handy", "pickaxey", "axey", "shovely", "shearsy", "shearsy_wool", "swordy", "swordy_wool" }
for a=1, #allowed_groups do
if def.groups[allowed_groups[a]] then
groups[allowed_groups[a]] = def.groups[allowed_groups[a]]
end
end
mcl_stairs.register_stair_and_slab(name, sourcenode, groups, def.tiles, desc_stair, desc_slab, def.sounds, def._mcl_blast_resistance, def._mcl_hardness, desc_double_slab, corner_stair_texture_override)
end