mods/carts/cart_entity.lua

   1 -- carts/cart_entity.lua
   2
   3 -- support for MT game translation.
   4 local S = carts.get_translator
   5
   6 local cart_entity = {
   7         initial_properties = {
   8                 physical = false, -- otherwise going uphill breaks
   9                 collisionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
  10                 visual = "mesh",
  11                 mesh = "carts_cart.b3d",
  12                 visual_size = {x=1, y=1},
  13                 textures = {"carts_cart.png"},
  14         },
  15
  16         driver = nil,
  17         punched = false, -- used to re-send velocity and position
  18         velocity = {x=0, y=0, z=0}, -- only used on punch
  19         old_dir = {x=1, y=0, z=0}, -- random value to start the cart on punch
  20         old_pos = nil,
  21         old_switch = 0,
  22         railtype = nil,
  23         attached_items = {}
  24 }
  25
  26 function cart_entity:on_rightclick(clicker)
  27         if not clicker or not clicker:is_player() then
  28                 return
  29         end
  30         local player_name = clicker:get_player_name()
  31         if self.driver and player_name == self.driver then
  32                 self.driver = nil
  33                 carts:manage_attachment(clicker, nil)
  34         elseif not self.driver then
  35                 self.driver = player_name
  36                 carts:manage_attachment(clicker, self.object)
  37
  38                 -- player_api does not update the animation
  39                 -- when the player is attached, reset to default animation
  40                 player_api.set_animation(clicker, "stand")
  41         end
  42 end
  43
  44 function cart_entity:on_activate(staticdata, dtime_s)
  45         self.object:set_armor_groups({immortal=1})
  46         if string.sub(staticdata, 1, string.len("return")) ~= "return" then
  47                 return
  48         end
  49         local data = minetest.deserialize(staticdata)
  50         if type(data) ~= "table" then
  51                 return
  52         end
  53         self.railtype = data.railtype
  54         if data.old_dir then
  55                 self.old_dir = data.old_dir
  56         end
  57 end
  58
  59 function cart_entity:get_staticdata()
  60         return minetest.serialize({
  61                 railtype = self.railtype,
  62                 old_dir = self.old_dir
  63         })
  64 end
  65
  66 -- 0.5.x and later: When the driver leaves
  67 function cart_entity:on_detach_child(child)
  68         if child and child:get_player_name() == self.driver then
  69                 self.driver = nil
  70         end
  71 end
  72
  73 function cart_entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction)
  74         local pos = self.object:get_pos()
  75         local vel = self.object:get_velocity()
  76         if not self.railtype or vector.equals(vel, {x=0, y=0, z=0}) then
  77                 local node = minetest.get_node(pos).name
  78                 self.railtype = minetest.get_item_group(node, "connect_to_raillike")
  79         end
  80         -- Punched by non-player
  81         if not puncher or not puncher:is_player() then
  82                 local cart_dir = carts:get_rail_direction(pos, self.old_dir, nil, nil, self.railtype)
  83                 if vector.equals(cart_dir, {x=0, y=0, z=0}) then
  84                         return
  85                 end
  86                 self.velocity = vector.multiply(cart_dir, 2)
  87                 self.punched = true
  88                 return
  89         end
  90         -- Player digs cart by sneak-punch
  91         if puncher:get_player_control().sneak then
  92                 if self.sound_handle then
  93                         minetest.sound_stop(self.sound_handle)
  94                 end
  95                 -- Detach driver and items
  96                 if self.driver then
  97                         if self.old_pos then
  98                                 self.object:set_pos(self.old_pos)
  99                         end
 100                         local player = minetest.get_player_by_name(self.driver)
 101                         carts:manage_attachment(player, nil)
 102                 end
 103                 for _, obj_ in ipairs(self.attached_items) do
 104                         if obj_ then
 105                                 obj_:set_detach()
 106                         end
 107                 end
 108                 -- Pick up cart
 109                 local inv = puncher:get_inventory()
 110                 if not (creative and creative.is_enabled_for
 111                                 and creative.is_enabled_for(puncher:get_player_name()))
 112                                 or not inv:contains_item("main", "carts:cart") then
 113                         local leftover = inv:add_item("main", "carts:cart")
 114                         -- If no room in inventory add a replacement cart to the world
 115                         if not leftover:is_empty() then
 116                                 minetest.add_item(self.object:get_pos(), leftover)
 117                         end
 118                 end
 119                 self.object:remove()
 120                 return
 121         end
 122         -- Player punches cart to alter velocity
 123         if puncher:get_player_name() == self.driver then
 124                 if math.abs(vel.x + vel.z) > carts.punch_speed_max then
 125                         return
 126                 end
 127         end
 128
 129         local punch_dir = carts:velocity_to_dir(puncher:get_look_dir())
 130         punch_dir.y = 0
 131         local cart_dir = carts:get_rail_direction(pos, punch_dir, nil, nil, self.railtype)
 132         if vector.equals(cart_dir, {x=0, y=0, z=0}) then
 133                 return
 134         end
 135
 136         local punch_interval = 1
 137         if tool_capabilities and tool_capabilities.full_punch_interval then
 138                 punch_interval = tool_capabilities.full_punch_interval
 139         end
 140         time_from_last_punch = math.min(time_from_last_punch or punch_interval, punch_interval)
 141         local f = 2 * (time_from_last_punch / punch_interval)
 142
 143         self.velocity = vector.multiply(cart_dir, f)
 144         self.old_dir = cart_dir
 145         self.punched = true
 146 end
 147
 148 local function rail_on_step_event(handler, obj, dtime)
 149         if handler then
 150                 handler(obj, dtime)
 151         end
 152 end
 153
 154 -- sound refresh interval = 1.0sec
 155 local function rail_sound(self, dtime)
 156         if not self.sound_ttl then
 157                 self.sound_ttl = 1.0
 158                 return
 159         elseif self.sound_ttl > 0 then
 160                 self.sound_ttl = self.sound_ttl - dtime
 161                 return
 162         end
 163         self.sound_ttl = 1.0
 164         if self.sound_handle then
 165                 local handle = self.sound_handle
 166                 self.sound_handle = nil
 167                 minetest.after(0.2, minetest.sound_stop, handle)
 168         end
 169         local vel = self.object:get_velocity()
 170         local speed = vector.length(vel)
 171         if speed > 0 then
 172                 self.sound_handle = minetest.sound_play(
 173                         "carts_cart_moving", {
 174                         object = self.object,
 175                         gain = (speed / carts.speed_max) / 2,
 176                         loop = true,
 177                 })
 178         end
 179 end
 180
 181 local function get_railparams(pos)
 182         local node = minetest.get_node(pos)
 183         return carts.railparams[node.name] or {}
 184 end
 185
 186 local v3_len = vector.length
 187 local function rail_on_step(self, dtime)
 188         local vel = self.object:get_velocity()
 189         if self.punched then
 190                 vel = vector.add(vel, self.velocity)
 191                 self.object:set_velocity(vel)
 192                 self.old_dir.y = 0
 193         elseif vector.equals(vel, {x=0, y=0, z=0}) then
 194                 return
 195         end
 196
 197         local pos = self.object:get_pos()
 198         local cart_dir = carts:velocity_to_dir(vel)
 199         local same_dir = vector.equals(cart_dir, self.old_dir)
 200         local update = {}
 201
 202         if self.old_pos and not self.punched and same_dir then
 203                 local flo_pos = vector.round(pos)
 204                 local flo_old = vector.round(self.old_pos)
 205                 if vector.equals(flo_pos, flo_old) then
 206                         -- Do not check one node multiple times
 207                         return
 208                 end
 209         end
 210
 211         local ctrl, player
 212
 213         -- Get player controls
 214         if self.driver then
 215                 player = minetest.get_player_by_name(self.driver)
 216                 if player then
 217                         ctrl = player:get_player_control()
 218                 end
 219         end
 220
 221         local stop_wiggle = false
 222         if self.old_pos and same_dir then
 223                 -- Detection for "skipping" nodes (perhaps use average dtime?)
 224                 -- It's sophisticated enough to take the acceleration in account
 225                 local acc = self.object:get_acceleration()
 226                 local distance = dtime * (v3_len(vel) + 0.5 * dtime * v3_len(acc))
 227
 228                 local new_pos, new_dir = carts:pathfinder(
 229                         pos, self.old_pos, self.old_dir, distance, ctrl,
 230                         self.old_switch, self.railtype
 231                 )
 232
 233                 if new_pos then
 234                         -- No rail found: set to the expected position
 235                         pos = new_pos
 236                         update.pos = true
 237                         cart_dir = new_dir
 238                 end
 239         elseif self.old_pos and self.old_dir.y ~= 1 and not self.punched then
 240                 -- Stop wiggle
 241                 stop_wiggle = true
 242         end
 243
 244         local railparams
 245
 246         -- dir:         New moving direction of the cart
 247         -- switch_keys: Currently pressed L/R key, used to ignore the key on the next rail node
 248         local dir, switch_keys = carts:get_rail_direction(
 249                 pos, cart_dir, ctrl, self.old_switch, self.railtype
 250         )
 251         local dir_changed = not vector.equals(dir, self.old_dir)
 252
 253         local new_acc = {x=0, y=0, z=0}
 254         if stop_wiggle or vector.equals(dir, {x=0, y=0, z=0}) then
 255                 vel = {x = 0, y = 0, z = 0}
 256                 local pos_r = vector.round(pos)
 257                 if not carts:is_rail(pos_r, self.railtype)
 258                                 and self.old_pos then
 259                         pos = self.old_pos
 260                 elseif not stop_wiggle then
 261                         pos = pos_r
 262                 else
 263                         pos.y = math.floor(pos.y + 0.5)
 264                 end
 265                 update.pos = true
 266                 update.vel = true
 267         else
 268                 -- Direction change detected
 269                 if dir_changed then
 270                         vel = vector.multiply(dir, math.abs(vel.x + vel.z))
 271                         update.vel = true
 272                         if dir.y ~= self.old_dir.y then
 273                                 pos = vector.round(pos)
 274                                 update.pos = true
 275                         end
 276                 end
 277                 -- Center on the rail
 278                 if dir.z ~= 0 and math.floor(pos.x + 0.5) ~= pos.x then
 279                         pos.x = math.floor(pos.x + 0.5)
 280                         update.pos = true
 281                 end
 282                 if dir.x ~= 0 and math.floor(pos.z + 0.5) ~= pos.z then
 283                         pos.z = math.floor(pos.z + 0.5)
 284                         update.pos = true
 285                 end
 286
 287                 -- Slow down or speed up..
 288                 local acc = dir.y * -4.0
 289
 290                 -- Get rail for corrected position
 291                 railparams = get_railparams(pos)
 292
 293                 -- no need to check for railparams == nil since we always make it exist.
 294                 local speed_mod = railparams.acceleration
 295                 if speed_mod and speed_mod ~= 0 then
 296                         -- Try to make it similar to the original carts mod
 297                         acc = acc + speed_mod
 298                 else
 299                         -- Handbrake or coast
 300                         if ctrl and ctrl.down then
 301                                 acc = acc - 3
 302                         else
 303                                 acc = acc - 0.4
 304                         end
 305                 end
 306
 307                 new_acc = vector.multiply(dir, acc)
 308         end
 309
 310         -- Limits
 311         local max_vel = carts.speed_max
 312         for _, v in pairs({"x","y","z"}) do
 313                 if math.abs(vel[v]) > max_vel then
 314                         vel[v] = carts:get_sign(vel[v]) * max_vel
 315                         new_acc[v] = 0
 316                         update.vel = true
 317                 end
 318         end
 319
 320         self.object:set_acceleration(new_acc)
 321         self.old_pos = vector.round(pos)
 322         if not vector.equals(dir, {x=0, y=0, z=0}) and not stop_wiggle then
 323                 self.old_dir = vector.new(dir)
 324         end
 325         self.old_switch = switch_keys
 326
 327         if self.punched then
 328                 -- Collect dropped items
 329                 for _, obj_ in pairs(minetest.get_objects_inside_radius(pos, 1)) do
 330                         if not obj_:is_player() and
 331                                         obj_:get_luaentity() and
 332                                         not obj_:get_luaentity().physical_state and
 333                                         obj_:get_luaentity().name == "__builtin:item" then
 334
 335                                 obj_:set_attach(self.object, "", {x=0, y=0, z=0}, {x=0, y=0, z=0})
 336                                 self.attached_items[#self.attached_items + 1] = obj_
 337                         end
 338                 end
 339                 self.punched = false
 340                 update.vel = true
 341         end
 342
 343         railparams = railparams or get_railparams(pos)
 344
 345         if not (update.vel or update.pos) then
 346                 rail_on_step_event(railparams.on_step, self, dtime)
 347                 return
 348         end
 349
 350         local yaw = 0
 351         if self.old_dir.x < 0 then
 352                 yaw = 0.5
 353         elseif self.old_dir.x > 0 then
 354                 yaw = 1.5
 355         elseif self.old_dir.z < 0 then
 356                 yaw = 1
 357         end
 358         self.object:set_yaw(yaw * math.pi)
 359
 360         local anim = {x=0, y=0}
 361         if dir.y == -1 then
 362                 anim = {x=1, y=1}
 363         elseif dir.y == 1 then
 364                 anim = {x=2, y=2}
 365         end
 366         self.object:set_animation(anim, 1, 0)
 367
 368         if update.vel then
 369                 self.object:set_velocity(vel)
 370         end
 371         if update.pos then
 372                 if dir_changed then
 373                         self.object:set_pos(pos)
 374                 else
 375                         self.object:move_to(pos)
 376                 end
 377         end
 378
 379         -- call event handler
 380         rail_on_step_event(railparams.on_step, self, dtime)
 381 end
 382
 383 function cart_entity:on_step(dtime)
 384         rail_on_step(self, dtime)
 385         rail_sound(self, dtime)
 386 end
 387
 388 minetest.register_entity("carts:cart", cart_entity)
 389
 390 minetest.register_craftitem("carts:cart", {
 391         description = S("Cart") .. "\n" .. S("(Sneak+Click to pick up)"),
 392         inventory_image = minetest.inventorycube("carts_cart_top.png", "carts_cart_front.png", "carts_cart_side.png"),
 393         wield_image = "carts_cart_side.png",
 394         on_place = function(itemstack, placer, pointed_thing)
 395                 local under = pointed_thing.under
 396                 local node = minetest.get_node(under)
 397                 local udef = minetest.registered_nodes[node.name]
 398                 if udef and udef.on_rightclick and
 399                                 not (placer and placer:is_player() and
 400                                 placer:get_player_control().sneak) then
 401                         return udef.on_rightclick(under, node, placer, itemstack,
 402                                 pointed_thing) or itemstack
 403                 end
 404
 405                 if not pointed_thing.type == "node" then
 406                         return
 407                 end
 408                 if carts:is_rail(pointed_thing.under) then
 409                         minetest.add_entity(pointed_thing.under, "carts:cart")
 410                 elseif carts:is_rail(pointed_thing.above) then
 411                         minetest.add_entity(pointed_thing.above, "carts:cart")
 412                 else
 413                         return
 414                 end
 415
 416                 minetest.sound_play({name = "default_place_node_metal", gain = 0.5},
 417                         {pos = pointed_thing.above}, true)
 418
 419                 if not (creative and creative.is_enabled_for
 420                                 and creative.is_enabled_for(placer:get_player_name())) then
 421                         itemstack:take_item()
 422                 end
 423                 return itemstack
 424         end,
 425 })
 426
 427 minetest.register_craft({
 428         output = "carts:cart",
 429         recipe = {
 430                 {"default:steel_ingot", "", "default:steel_ingot"},
 431                 {"default:steel_ingot", "default:steel_ingot", "default:steel_ingot"},
 432         },
 433 })