MineClone2/mods/ENTITIES/mcl_boats/init.lua

450 lines
13 KiB
Lua
Raw Normal View History

local S = minetest.get_translator("mcl_boats")
2015-06-29 19:55:56 +02:00
--
-- Helper functions
--
2017-06-12 23:21:41 +02:00
local function is_water(pos)
local nn = minetest.get_node(pos).name
return minetest.get_item_group(nn, "water") ~= 0
end
local function get_sign(i)
if i == 0 then
return 0
else
return i / math.abs(i)
end
end
local function get_velocity(v, yaw, y)
local x = -math.sin(yaw) * v
local z = math.cos(yaw) * v
return {x = x, y = y, z = z}
end
local function get_v(v)
return math.sqrt(v.x ^ 2 + v.z ^ 2)
end
2017-06-20 15:21:44 +02:00
local boat_visual_size = {x = 3, y = 3}
-- Note: This mod assumes the default player visual_size is {x=1, y=1}
local driver_visual_size = { x = 1/boat_visual_size.x, y = 1/boat_visual_size.y }
2017-07-08 17:55:46 +02:00
local paddling_speed = 22
local boat_y_offset = 0.35
local boat_y_offset_ground = boat_y_offset + 0.6
2019-09-11 12:23:56 +02:00
local boat_side_offset = 1.001
2021-02-18 14:47:35 +01:00
local boat_max_hp = 4
2017-06-20 15:21:44 +02:00
2017-06-12 23:21:41 +02:00
--
-- Boat entity
--
local boat = {
physical = true,
-- Warning: Do not change the position of the collisionbox top surface,
-- lowering it causes the boat to fall through the world if underwater
collisionbox = {-0.5, -0.35, -0.5, 0.5, 0.3, 0.5},
visual = "mesh",
2017-06-13 01:39:21 +02:00
mesh = "mcl_boats_boat.b3d",
2017-06-12 23:50:42 +02:00
textures = {"mcl_boats_texture_oak_boat.png"},
2017-06-20 15:21:44 +02:00
visual_size = boat_visual_size,
2021-02-18 14:47:35 +01:00
hp_max = boat_max_hp,
damage_texture_modifier = "^[colorize:white:0",
2017-06-12 23:50:42 +02:00
2017-06-13 00:26:17 +02:00
_driver = nil, -- Attached driver (player) or nil if none
2021-01-31 12:54:40 +01:00
_passenger = nil,
2017-06-13 00:26:17 +02:00
_v = 0, -- Speed
_last_v = 0, -- Temporary speed variable
_removed = false, -- If true, boat entity is considered removed (e.g. after punch) and should be ignored
_itemstring = "mcl_boats:boat", -- Itemstring of the boat item (implies boat type)
2017-07-08 17:26:07 +02:00
_animation = 0, -- 0: not animated; 1: paddling forwards; -1: paddling forwards
_regen_timer = 0,
_damage_anim = 0,
2017-06-12 23:21:41 +02:00
}
2021-01-31 12:54:40 +01:00
local function detach_player(player, change_pos)
2021-01-04 14:21:28 +01:00
player:set_detach()
player:set_properties({visual_size = {x=1, y=1}})
mcl_player.player_attached[player:get_player_name()] = false
mcl_player.player_set_animation(player, "stand" , 30)
2021-01-31 12:54:40 +01:00
if change_pos then
player:set_pos(vector.add(player:get_pos(), vector.new(0, 0.2, 0)))
end
end
local function check_object(obj)
return obj and (obj:is_player() or obj:get_luaentity()) and obj
end
local function set_attach(boat)
boat._driver:set_attach(boat.object, "",
{x = 0, y = 0.42, z = -1}, {x = 0, y = 0, z = 0})
end
local function set_double_attach(boat)
boat._driver:set_attach(boat.object, "",
{x = 0, y = 0.42, z = 0.8}, {x = 0, y = 0, z = 0})
boat._passenger:set_attach(boat.object, "",
{x = 0, y = 0.42, z = -2.2}, {x = 0, y = 0, z = 0})
2021-01-04 14:21:28 +01:00
end
minetest.register_on_respawnplayer(detach_player)
2017-06-12 23:21:41 +02:00
function boat.on_rightclick(self, clicker)
2021-01-31 12:54:40 +01:00
if self._passenger or not clicker or clicker:get_attach() then
2017-06-12 23:21:41 +02:00
return
end
local name = clicker:get_player_name()
2021-01-28 17:44:55 +01:00
--[[if attach and attach:get_luaentity() then
local luaentity = attach:get_luaentity()
if luaentity._driver then
luaentity._driver = nil
2017-06-12 23:21:41 +02:00
end
2021-01-28 17:44:55 +01:00
clicker:set_detach()
clicker:set_properties({visual_size = {x=1, y=1}})
end--]]
2021-01-31 12:54:40 +01:00
if self._driver then
if self._driver:is_player() then
self._passenger = clicker
else
-- for later use: transport mobs in boats
self._passenger = self._driver
self._driver = clicker
end
set_double_attach(self)
else
self._driver = clicker
set_attach(self)
end
2021-01-28 17:44:55 +01:00
clicker:set_properties({ visual_size = driver_visual_size })
mcl_player.player_attached[name] = true
minetest.after(0.2, function(name)
local player = minetest.get_player_by_name(name)
if player then
mcl_player.player_set_animation(player, "sit" , 30)
end
end, name)
clicker:set_look_horizontal(self.object:get_yaw())
mcl_tmp_message.message(clicker, S("Sneak to dismount"))
2017-06-12 23:21:41 +02:00
end
function boat.on_activate(self, staticdata, dtime_s)
self.object:set_armor_groups({fleshy = 100})
2017-06-13 00:14:17 +02:00
local data = minetest.deserialize(staticdata)
if type(data) == "table" then
2017-06-13 00:26:17 +02:00
self._v = data.v
self._last_v = self._v
2017-06-13 00:14:17 +02:00
self._itemstring = data.itemstring
self.object:set_properties({textures = data.textures})
2017-06-12 23:21:41 +02:00
end
end
function boat.get_staticdata(self)
2017-06-13 00:14:17 +02:00
return minetest.serialize({
2017-06-13 00:26:17 +02:00
v = self._v,
2017-06-13 00:14:17 +02:00
itemstring = self._itemstring,
textures = self.object:get_properties().textures
})
2017-06-12 23:21:41 +02:00
end
2021-01-24 16:27:04 +01:00
function boat.on_death(self, killer)
if killer and killer:is_player() and minetest.is_creative_enabled(killer:get_player_name()) then
local inv = killer:get_inventory()
if not inv:contains_item("main", self._itemstring) then
inv:add_item("main", self._itemstring)
2017-06-12 23:21:41 +02:00
end
2021-01-24 16:27:04 +01:00
else
minetest.add_item(self.object:get_pos(), self._itemstring)
end
if self._driver then
detach_player(self._driver)
2017-06-12 23:21:41 +02:00
end
2021-01-31 12:54:40 +01:00
if self._passenger then
detach_player(self._passenger)
end
2021-01-24 16:27:04 +01:00
self._driver = nil
2021-01-31 12:54:40 +01:00
self._passenger = nil
2017-06-12 23:21:41 +02:00
end
function boat.on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
if damage > 0 then
self._regen_timer = 0
end
end
2021-01-28 19:02:44 +01:00
function boat.on_step(self, dtime, moveresult)
2019-03-06 04:38:57 +01:00
self._v = get_v(self.object:get_velocity()) * get_sign(self._v)
2019-09-11 12:11:04 +02:00
local on_water = true
local in_water = false
local v_factor = 1
local v_slowdown = 0.02
local p = self.object:get_pos()
2019-09-11 12:11:04 +02:00
if (not is_water({x=p.x, y=p.y-boat_y_offset, z=p.z})) then
on_water = false
v_factor = 0.5
v_slowdown = 0.04
2019-09-11 12:11:04 +02:00
elseif (is_water({x=p.x, y=p.y-boat_y_offset+1, z=p.z})) then
on_water = false
in_water = true
v_factor = 0.75
v_slowdown = 0.05
end
2019-09-11 12:11:04 +02:00
local hp = self.object:get_hp()
local regen_timer = self._regen_timer + dtime
if hp >= boat_max_hp then
regen_timer = 0
elseif regen_timer >= 0.5 then
hp = hp + 1
self.object:set_hp(hp)
regen_timer = 0
end
self._regen_timer = regen_timer
2021-02-18 14:47:35 +01:00
2021-01-28 19:02:44 +01:00
if moveresult and moveresult.collides then
for _, collision in ipairs(moveresult.collisions) do
local pos = collision.node_pos
if collision.type == "node" and minetest.get_item_group(minetest.get_node(pos).name, "dig_by_boat") > 0 then
2021-01-28 19:02:44 +01:00
minetest.dig_node(pos)
end
end
end
2021-01-31 12:54:40 +01:00
local had_passenger = self._passenger
self._driver = check_object(self._driver)
self._passenger = check_object(self._passenger)
if self._passenger then
if not self._driver then
self._driver = self._passenger
self._passenger = nil
else
local ctrl = self._passenger:get_player_control()
if ctrl and ctrl.sneak then
detach_player(self._passenger, true)
self._passenger = nil
end
end
end
2017-06-13 00:26:17 +02:00
if self._driver then
2021-01-31 12:54:40 +01:00
if had_passenger and not self._passenger then
set_attach(self)
end
2017-06-13 00:26:17 +02:00
local ctrl = self._driver:get_player_control()
2021-01-31 12:54:40 +01:00
if ctrl and ctrl.sneak then
detach_player(self._driver, true)
2021-01-28 17:44:55 +01:00
self._driver = nil
return
end
2019-03-06 04:38:57 +01:00
local yaw = self.object:get_yaw()
2017-06-12 23:21:41 +02:00
if ctrl.up then
2017-07-08 17:26:07 +02:00
-- Forwards
self._v = self._v + 0.1 * v_factor
2017-07-08 17:26:07 +02:00
-- Paddling animation
if self._animation ~= 1 then
self.object:set_animation({x=0, y=40}, paddling_speed, 0, true)
self._animation = 1
end
2017-06-12 23:21:41 +02:00
elseif ctrl.down then
2017-07-08 17:26:07 +02:00
-- Backwards
self._v = self._v - 0.1 * v_factor
2017-07-08 17:26:07 +02:00
-- Paddling animation, reversed
if self._animation ~= -1 then
self.object:set_animation({x=0, y=40}, -paddling_speed, 0, true)
self._animation = -1
end
else
-- Stop paddling animation if no control pressed
if self._animation ~= 0 then
self.object:set_animation({x=0, y=40}, 0, 0, true)
self._animation = 0
end
2017-06-12 23:21:41 +02:00
end
2021-01-31 12:54:40 +01:00
if ctrl and ctrl.left then
2017-06-13 00:26:17 +02:00
if self._v < 0 then
self.object:set_yaw(yaw - (1 + dtime) * 0.03 * v_factor)
2017-06-12 23:21:41 +02:00
else
self.object:set_yaw(yaw + (1 + dtime) * 0.03 * v_factor)
2017-06-12 23:21:41 +02:00
end
2021-01-31 12:54:40 +01:00
elseif ctrl and ctrl.right then
2017-06-13 00:26:17 +02:00
if self._v < 0 then
self.object:set_yaw(yaw + (1 + dtime) * 0.03 * v_factor)
2017-06-12 23:21:41 +02:00
else
self.object:set_yaw(yaw - (1 + dtime) * 0.03 * v_factor)
2017-06-12 23:21:41 +02:00
end
end
2017-07-08 17:26:07 +02:00
else
-- Stop paddling without driver
if self._animation ~= 0 then
self.object:set_animation({x=0, y=40}, 0, 0, true)
self._animation = 0
end
2017-06-12 23:21:41 +02:00
end
2017-06-13 00:26:17 +02:00
local s = get_sign(self._v)
2019-10-02 20:53:47 +02:00
if not on_water and not in_water and math.abs(self._v) > 1.0 then
v_slowdown = math.min(math.abs(self._v) - 1.0, v_slowdown * 5)
elseif in_water and math.abs(self._v) > 1.5 then
v_slowdown = math.min(math.abs(self._v) - 1.5, v_slowdown * 5)
end
self._v = self._v - v_slowdown * s
2017-06-13 00:26:17 +02:00
if s ~= get_sign(self._v) then
self._v = 0
2017-06-12 23:21:41 +02:00
end
2017-07-08 17:55:46 +02:00
p.y = p.y - boat_y_offset
2017-06-12 23:21:41 +02:00
local new_velo
local new_acce = {x = 0, y = 0, z = 0}
if not is_water(p) then
2019-09-11 12:11:04 +02:00
-- Not on water or inside water: Free fall
2017-06-12 23:21:41 +02:00
local nodedef = minetest.registered_nodes[minetest.get_node(p).name]
new_acce = {x = 0, y = -9.8, z = 0}
2019-03-06 04:38:57 +01:00
new_velo = get_velocity(self._v, self.object:get_yaw(),
self.object:get_velocity().y)
2017-06-12 23:21:41 +02:00
else
p.y = p.y + 1
if is_water(p) then
2019-09-11 12:11:04 +02:00
-- Inside water: Slowly sink
2019-03-06 04:38:57 +01:00
local y = self.object:get_velocity().y
2019-09-11 12:11:04 +02:00
y = y - 0.01
if y < -0.2 then
y = -0.2
2017-06-12 23:21:41 +02:00
end
2019-09-11 12:11:04 +02:00
new_acce = {x = 0, y = 0, z = 0}
2019-03-06 04:38:57 +01:00
new_velo = get_velocity(self._v, self.object:get_yaw(), y)
2017-06-12 23:21:41 +02:00
else
2019-09-11 12:11:04 +02:00
-- On top of water
2017-06-12 23:21:41 +02:00
new_acce = {x = 0, y = 0, z = 0}
if math.abs(self.object:get_velocity().y) < 0 then
2019-03-06 04:38:57 +01:00
new_velo = get_velocity(self._v, self.object:get_yaw(), 0)
2017-06-12 23:21:41 +02:00
else
2019-03-06 04:38:57 +01:00
new_velo = get_velocity(self._v, self.object:get_yaw(),
self.object:get_velocity().y)
2017-06-12 23:21:41 +02:00
end
end
end
2019-09-11 13:28:14 +02:00
-- Terminal velocity: 8 m/s per axis of travel
for _,axis in pairs({"z","y","x"}) do
if math.abs(new_velo[axis]) > 8 then
new_velo[axis] = 8 * get_sign(new_velo[axis])
end
end
local yaw = self.object:get_yaw()
local anim = (boat_max_hp - hp - regen_timer * 2) / boat_max_hp * math.pi / 4
self.object:set_rotation(vector.new(anim, yaw, anim))
2019-03-06 04:38:57 +01:00
self.object:set_velocity(new_velo)
self.object:set_acceleration(new_acce)
2017-06-12 23:21:41 +02:00
end
2017-06-13 00:21:43 +02:00
-- Register one entity for all boat types
minetest.register_entity("mcl_boats:boat", boat)
2017-06-12 23:21:41 +02:00
local boat_ids = { "boat", "boat_spruce", "boat_birch", "boat_jungle", "boat_acacia", "boat_dark_oak" }
local names = { S("Oak Boat"), S("Spruce Boat"), S("Birch Boat"), S("Jungle Boat"), S("Acacia Boat"), S("Dark Oak Boat") }
2017-07-26 19:12:53 +02:00
local craftstuffs = {}
if minetest.get_modpath("mcl_core") then
craftstuffs = { "mcl_core:wood", "mcl_core:sprucewood", "mcl_core:birchwood", "mcl_core:junglewood", "mcl_core:acaciawood", "mcl_core:darkwood" }
end
2017-06-12 23:21:41 +02:00
local images = { "oak", "spruce", "birch", "jungle", "acacia", "dark_oak" }
2015-06-29 19:55:56 +02:00
2017-06-12 23:21:41 +02:00
for b=1, #boat_ids do
local itemstring = "mcl_boats:"..boat_ids[b]
2015-06-29 19:55:56 +02:00
2020-02-19 04:54:17 +01:00
local longdesc, usagehelp, tt_help, help, helpname
2017-06-13 00:33:31 +02:00
help = false
-- Only create one help entry for all boats
if b == 1 then
help = true
longdesc = S("Boats are used to travel on the surface of water.")
usagehelp = S("Rightclick on a water source to place the boat. Rightclick the boat to enter it. Use [Left] and [Right] to steer, [Forwards] to speed up and [Backwards] to slow down or move backwards. Rightclick the boat again to leave it, punch the boat to make it drop as an item.")
helpname = S("Boat")
2017-06-13 00:33:31 +02:00
end
2020-02-19 04:54:17 +01:00
tt_help = S("Water vehicle")
2017-06-13 00:33:31 +02:00
2017-06-12 23:21:41 +02:00
minetest.register_craftitem(itemstring, {
description = names[b],
2020-02-19 04:54:17 +01:00
_tt_help = tt_help,
2017-06-13 00:33:31 +02:00
_doc_items_create_entry = help,
_doc_items_entry_name = helpname,
_doc_items_longdesc = longdesc,
_doc_items_usagehelp = usagehelp,
2017-06-12 23:21:41 +02:00
inventory_image = "mcl_boats_"..images[b].."_boat.png",
2017-01-16 19:10:18 +01:00
liquids_pointable = true,
groups = { boat = 1, transport = 1},
2017-01-16 23:34:40 +01:00
stack_max = 1,
2017-01-16 19:10:18 +01:00
on_place = function(itemstack, placer, pointed_thing)
if pointed_thing.type ~= "node" then
2019-09-11 12:23:56 +02:00
return itemstack
2017-01-16 19:10:18 +01:00
end
-- Call on_rightclick if the pointed node defines it
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
2019-09-11 12:23:56 +02:00
local pos = table.copy(pointed_thing.under)
local dir = vector.subtract(pointed_thing.above, pointed_thing.under)
if math.abs(dir.x) > 0.9 or math.abs(dir.z) > 0.9 then
pos = vector.add(pos, vector.multiply(dir, boat_side_offset))
elseif is_water(pos) then
pos = vector.add(pos, vector.multiply(dir, boat_y_offset))
else
2019-09-11 12:23:56 +02:00
pos = vector.add(pos, vector.multiply(dir, boat_y_offset_ground))
2017-01-16 19:10:18 +01:00
end
2019-09-11 12:23:56 +02:00
local boat = minetest.add_entity(pos, "mcl_boats:boat")
2017-06-12 23:50:42 +02:00
boat:get_luaentity()._itemstring = itemstring
boat:set_properties({textures = { "mcl_boats_texture_"..images[b].."_boat.png" }})
2018-05-09 18:43:07 +02:00
boat:set_yaw(placer:get_look_horizontal())
2020-07-10 16:08:40 +02:00
if not minetest.is_creative_enabled(placer:get_player_name()) then
2017-01-16 19:10:18 +01:00
itemstack:take_item()
end
return itemstack
end,
_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
local below = {x=droppos.x, y=droppos.y-1, z=droppos.z}
local belownode = minetest.get_node(below)
-- Place boat as entity on or in water
if minetest.get_item_group(dropnode.name, "water") ~= 0 or (dropnode.name == "air" and minetest.get_item_group(belownode.name, "water") ~= 0) then
minetest.add_entity(droppos, "mcl_boats:boat")
else
minetest.add_item(droppos, stack)
end
end,
2017-01-16 19:10:18 +01:00
})
2017-06-12 23:21:41 +02:00
local c = craftstuffs[b]
2017-01-16 19:10:18 +01:00
minetest.register_craft({
2017-06-12 23:21:41 +02:00
output = itemstring,
2017-01-16 19:10:18 +01:00
recipe = {
{c, "", c},
{c, c, c},
},
})
end
2015-06-29 19:55:56 +02:00
2017-01-10 06:43:07 +01:00
minetest.register_craft({
type = "fuel",
recipe = "group:boat",
burntime = 20,
})
2017-06-13 00:18:51 +02:00
if minetest.get_modpath("doc_identifier") ~= nil then
doc.sub.identifier.register_object("mcl_boats:boat", "craftitems", "mcl_boats:boat")
end