builtin/game/falling.lua

   1 -- Minetest: builtin/item.lua
   2
   3 local builtin_shared = ...
   4
   5 --
   6 -- Falling stuff
   7 --
   8
   9 core.register_entity(":__builtin:falling_node", {
  10         initial_properties = {
  11                 visual = "wielditem",
  12                 visual_size = {x = 0.667, y = 0.667},
  13                 textures = {},
  14                 physical = true,
  15                 is_visible = false,
  16                 collide_with_objects = false,
  17                 collisionbox = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
  18         },
  19
  20         node = {},
  21         meta = {},
  22
  23         set_node = function(self, node, meta)
  24                 self.node = node
  25                 self.meta = meta or {}
  26                 self.object:set_properties({
  27                         is_visible = true,
  28                         textures = {node.name},
  29                 })
  30         end,
  31
  32         get_staticdata = function(self)
  33                 local ds = {
  34                         node = self.node,
  35                         meta = self.meta,
  36                 }
  37                 return core.serialize(ds)
  38         end,
  39
  40         on_activate = function(self, staticdata)
  41                 self.object:set_armor_groups({immortal = 1})
  42
  43                 local ds = core.deserialize(staticdata)
  44                 if ds and ds.node then
  45                         self:set_node(ds.node, ds.meta)
  46                 elseif ds then
  47                         self:set_node(ds)
  48                 elseif staticdata ~= "" then
  49                         self:set_node({name = staticdata})
  50                 end
  51         end,
  52
  53         on_step = function(self, dtime)
  54                 -- Set gravity
  55                 local acceleration = self.object:getacceleration()
  56                 if not vector.equals(acceleration, {x = 0, y = -10, z = 0}) then
  57                         self.object:setacceleration({x = 0, y = -10, z = 0})
  58                 end
  59                 -- Turn to actual node when colliding with ground, or continue to move
  60                 local pos = self.object:getpos()
  61                 -- Position of bottom center point
  62                 local bcp = {x = pos.x, y = pos.y - 0.7, z = pos.z}
  63                 -- 'bcn' is nil for unloaded nodes
  64                 local bcn = core.get_node_or_nil(bcp)
  65                 -- Delete on contact with ignore at world edges
  66                 if bcn and bcn.name == "ignore" then
  67                         self.object:remove()
  68                         return
  69                 end
  70                 local bcd = bcn and core.registered_nodes[bcn.name]
  71                 if bcn and
  72                                 (not bcd or bcd.walkable or
  73                                 (core.get_item_group(self.node.name, "float") ~= 0 and
  74                                 bcd.liquidtype ~= "none")) then
  75                         if bcd and bcd.leveled and
  76                                         bcn.name == self.node.name then
  77                                 local addlevel = self.node.level
  78                                 if not addlevel or addlevel <= 0 then
  79                                         addlevel = bcd.leveled
  80                                 end
  81                                 if core.add_node_level(bcp, addlevel) == 0 then
  82                                         self.object:remove()
  83                                         return
  84                                 end
  85                         elseif bcd and bcd.buildable_to and
  86                                         (core.get_item_group(self.node.name, "float") == 0 or
  87                                         bcd.liquidtype == "none") then
  88                                 core.remove_node(bcp)
  89                                 return
  90                         end
  91                         local np = {x = bcp.x, y = bcp.y + 1, z = bcp.z}
  92                         -- Check what's here
  93                         local n2 = core.get_node(np)
  94                         local nd = core.registered_nodes[n2.name]
  95                         -- If it's not air or liquid, remove node and replace it with
  96                         -- it's drops
  97                         if n2.name ~= "air" and (not nd or nd.liquidtype == "none") then
  98                                 core.remove_node(np)
  99                                 if nd and nd.buildable_to == false then
 100                                         -- Add dropped items
 101                                         local drops = core.get_node_drops(n2, "")
 102                                         for _, dropped_item in pairs(drops) do
 103                                                 core.add_item(np, dropped_item)
 104                                         end
 105                                 end
 106                                 -- Run script hook
 107                                 for _, callback in pairs(core.registered_on_dignodes) do
 108                                         callback(np, n2)
 109                                 end
 110                         end
 111                         -- Create node and remove entity
 112                         if core.registered_nodes[self.node.name] then
 113                                 core.add_node(np, self.node)
 114                                 if self.meta then
 115                                         local meta = core.get_meta(np)
 116                                         meta:from_table(self.meta)
 117                                 end
 118                         end
 119                         self.object:remove()
 120                         core.check_for_falling(np)
 121                         return
 122                 end
 123                 local vel = self.object:getvelocity()
 124                 if vector.equals(vel, {x = 0, y = 0, z = 0}) then
 125                         local npos = self.object:getpos()
 126                         self.object:setpos(vector.round(npos))
 127                 end
 128         end
 129 })
 130
 131 local function spawn_falling_node(p, node, meta)
 132         local obj = core.add_entity(p, "__builtin:falling_node")
 133         if obj then
 134                 obj:get_luaentity():set_node(node, meta)
 135         end
 136 end
 137
 138 function core.spawn_falling_node(pos)
 139         local node = core.get_node(pos)
 140         if node.name == "air" or node.name == "ignore" then
 141                 return false
 142         end
 143         local obj = core.add_entity(pos, "__builtin:falling_node")
 144         if obj then
 145                 obj:get_luaentity():set_node(node)
 146                 core.remove_node(pos)
 147                 return true
 148         end
 149         return false
 150 end
 151
 152 local function drop_attached_node(p)
 153         local n = core.get_node(p)
 154         core.remove_node(p)
 155         for _, item in pairs(core.get_node_drops(n, "")) do
 156                 local pos = {
 157                         x = p.x + math.random()/2 - 0.25,
 158                         y = p.y + math.random()/2 - 0.25,
 159                         z = p.z + math.random()/2 - 0.25,
 160                 }
 161                 core.add_item(pos, item)
 162         end
 163 end
 164
 165 function builtin_shared.check_attached_node(p, n)
 166         local def = core.registered_nodes[n.name]
 167         local d = {x = 0, y = 0, z = 0}
 168         if def.paramtype2 == "wallmounted" or
 169                         def.paramtype2 == "colorwallmounted" then
 170                 -- The fallback vector here is in case 'wallmounted to dir' is nil due
 171                 -- to voxelmanip placing a wallmounted node without resetting a
 172                 -- pre-existing param2 value that is out-of-range for wallmounted.
 173                 -- The fallback vector corresponds to param2 = 0.
 174                 d = core.wallmounted_to_dir(n.param2) or {x = 0, y = 1, z = 0}
 175         else
 176                 d.y = -1
 177         end
 178         local p2 = vector.add(p, d)
 179         local nn = core.get_node(p2).name
 180         local def2 = core.registered_nodes[nn]
 181         if def2 and not def2.walkable then
 182                 return false
 183         end
 184         return true
 185 end
 186
 187 --
 188 -- Some common functions
 189 --
 190
 191 function core.check_single_for_falling(p)
 192         local n = core.get_node(p)
 193         if core.get_item_group(n.name, "falling_node") ~= 0 then
 194                 local p_bottom = {x = p.x, y = p.y - 1, z = p.z}
 195                 -- Only spawn falling node if node below is loaded
 196                 local n_bottom = core.get_node_or_nil(p_bottom)
 197                 local d_bottom = n_bottom and core.registered_nodes[n_bottom.name]
 198                 if d_bottom and
 199
 200                                 (core.get_item_group(n.name, "float") == 0 or
 201                                 d_bottom.liquidtype == "none") and
 202
 203                                 (n.name ~= n_bottom.name or (d_bottom.leveled and
 204                                 core.get_node_level(p_bottom) <
 205                                 core.get_node_max_level(p_bottom))) and
 206
 207                                 (not d_bottom.walkable or d_bottom.buildable_to) then
 208                         n.level = core.get_node_level(p)
 209                         local meta = core.get_meta(p)
 210                         local metatable = {}
 211                         if meta ~= nil then
 212                                 metatable = meta:to_table()
 213                         end
 214                         core.remove_node(p)
 215                         spawn_falling_node(p, n, metatable)
 216                         return true
 217                 end
 218         end
 219
 220         if core.get_item_group(n.name, "attached_node") ~= 0 then
 221                 if not builtin_shared.check_attached_node(p, n) then
 222                         drop_attached_node(p)
 223                         return true
 224                 end
 225         end
 226
 227         return false
 228 end
 229
 230 -- This table is specifically ordered.
 231 -- We don't walk diagonals, only our direct neighbors, and self.
 232 -- Down first as likely case, but always before self. The same with sides.
 233 -- Up must come last, so that things above self will also fall all at once.
 234 local check_for_falling_neighbors = {
 235         {x = -1, y = -1, z = 0},
 236         {x = 1, y = -1, z = 0},
 237         {x = 0, y = -1, z = -1},
 238         {x = 0, y = -1, z = 1},
 239         {x = 0, y = -1, z = 0},
 240         {x = -1, y = 0, z = 0},
 241         {x = 1, y = 0, z = 0},
 242         {x = 0, y = 0, z = 1},
 243         {x = 0, y = 0, z = -1},
 244         {x = 0, y = 0, z = 0},
 245         {x = 0, y = 1, z = 0},
 246 }
 247
 248 function core.check_for_falling(p)
 249         -- Round p to prevent falling entities to get stuck.
 250         p = vector.round(p)
 251
 252         -- We make a stack, and manually maintain size for performance.
 253         -- Stored in the stack, we will maintain tables with pos, and
 254         -- last neighbor visited. This way, when we get back to each
 255         -- node, we know which directions we have already walked, and
 256         -- which direction is the next to walk.
 257         local s = {}
 258         local n = 0
 259         -- The neighbor order we will visit from our table.
 260         local v = 1
 261
 262         while true do
 263                 -- Push current pos onto the stack.
 264                 n = n + 1
 265                 s[n] = {p = p, v = v}
 266                 -- Select next node from neighbor list.
 267                 p = vector.add(p, check_for_falling_neighbors[v])
 268                 -- Now we check out the node. If it is in need of an update,
 269                 -- it will let us know in the return value (true = updated).
 270                 if not core.check_single_for_falling(p) then
 271                         -- If we don't need to "recurse" (walk) to it then pop
 272                         -- our previous pos off the stack and continue from there,
 273                         -- with the v value we were at when we last were at that
 274                         -- node
 275                         repeat
 276                                 local pop = s[n]
 277                                 p = pop.p
 278                                 v = pop.v
 279                                 s[n] = nil
 280                                 n = n - 1
 281                                 -- If there's nothing left on the stack, and no
 282                                 -- more sides to walk to, we're done and can exit
 283                                 if n == 0 and v == 11 then
 284                                         return
 285                                 end
 286                         until v < 11
 287                         -- The next round walk the next neighbor in list.
 288                         v = v + 1
 289                 else
 290                         -- If we did need to walk the neighbor, then
 291                         -- start walking it from the walk order start (1),
 292                         -- and not the order we just pushed up the stack.
 293                         v = 1
 294                 end
 295         end
 296 end
 297
 298 --
 299 -- Global callbacks
 300 --
 301
 302 local function on_placenode(p, node)
 303         core.check_for_falling(p)
 304 end
 305 core.register_on_placenode(on_placenode)
 306
 307 local function on_dignode(p, node)
 308         core.check_for_falling(p)
 309 end
 310 core.register_on_dignode(on_dignode)
 311
 312 local function on_punchnode(p, node)
 313         core.check_for_falling(p)
 314 end
 315 core.register_on_punchnode(on_punchnode)
 316
 317 --
 318 -- Globally exported functions
 319 --
 320
 321 -- TODO remove this function after the 0.4.15 release
 322 function nodeupdate(p)
 323         core.log("deprecated", "nodeupdate: deprecated, please use core.check_for_falling instead")
 324         core.check_for_falling(p)
 325 end
 326
 327 -- TODO remove this function after the 0.4.15 release
 328 function nodeupdate_single(p)
 329         core.log("deprecated", "nodeupdate_single: deprecated, please use core.check_single_for_falling instead")
 330         core.check_single_for_falling(p)
 331 end